diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..4f8075ffce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: New feedback experience + url: https://learn.microsoft.com/office/new-feedback + about: We’re transitioning our feedback experience away from GitHub Issues. For more information, select Open. \ No newline at end of file diff --git a/.github/workflows/AutoLabelAssign.yml b/.github/workflows/AutoLabelAssign.yml new file mode 100644 index 0000000000..65e87b3d4b --- /dev/null +++ b/.github/workflows/AutoLabelAssign.yml @@ -0,0 +1,37 @@ +name: Assign and label PR + +permissions: + pull-requests: write + contents: read + actions: read + +on: + workflow_run: + workflows: [Background tasks] + types: + - completed + +jobs: + download-payload: + name: Download and extract payload artifact + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-ExtractPayload.yml@workflows-prod + with: + WorkflowId: ${{ github.event.workflow_run.id }} + OrgRepo: ${{ github.repository }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} + + label-assign: + name: Run assign and label + if: github.repository_owner == 'MicrosoftDocs' + needs: [download-payload] + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-AutoLabelAssign.yml@workflows-prod + with: + PayloadJson: ${{ needs.download-payload.outputs.WorkflowPayload }} + AutoAssignUsers: 1 + AutoLabel: 1 + ExcludedUserList: '["user1", "user2"]' + ExcludedBranchList: '["branch1", "branch2"]' + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/AutoLabelMsftContributor.yml b/.github/workflows/AutoLabelMsftContributor.yml new file mode 100644 index 0000000000..6fcfb6e43e --- /dev/null +++ b/.github/workflows/AutoLabelMsftContributor.yml @@ -0,0 +1,35 @@ +name: Auto label Microsoft contributors + +permissions: + pull-requests: write + contents: read + actions: read + +on: + workflow_run: + workflows: [Background tasks] + types: + - completed + +jobs: + download-payload: + if: github.repository_owner == 'MicrosoftDocs' && github.repository_visibility == 'public' + name: Download and extract payload artifact + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-ExtractPayload.yml@workflows-prod + with: + WorkflowId: ${{ github.event.workflow_run.id }} + OrgRepo: ${{ github.repository }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} + + label-msft: + name: Label Microsoft contributors + if: github.repository_owner == 'MicrosoftDocs' && github.repository_visibility == 'public' + needs: [download-payload] + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-AutoLabelMsftContributor.yml@workflows-prod + with: + PayloadJson: ${{ needs.download-payload.outputs.WorkflowPayload }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} + ClientId: ${{ secrets.M365_APP_CLIENT_ID }} + PrivateKey: ${{ secrets.M365_APP_PRIVATE_KEY }} \ No newline at end of file diff --git a/.github/workflows/AutoPublish.yml b/.github/workflows/AutoPublish.yml new file mode 100644 index 0000000000..c067d8f47b --- /dev/null +++ b/.github/workflows/AutoPublish.yml @@ -0,0 +1,27 @@ +name: (Scheduled) Publish to live + +permissions: + contents: write + pull-requests: write + checks: read + +on: + schedule: + - cron: "25 2,5,8,11,14,17,20,22 * * *" # Times are UTC based on Daylight Saving Time. Need to be adjusted for Standard Time. Scheduling at :25 to account for queuing lag. + + workflow_dispatch: + +jobs: + + auto-publish: + if: github.repository_owner == 'MicrosoftDocs' && contains(github.event.repository.topics, 'build') + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-AutoPublishV2.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + EnableAutoPublish: true + EnableAutoMerge: true + + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} + PrivateKey: ${{ secrets.M365_APP_PRIVATE_KEY }} + ClientId: ${{ secrets.M365_APP_CLIENT_ID }} \ No newline at end of file diff --git a/.github/workflows/BackgroundTasks.yml b/.github/workflows/BackgroundTasks.yml new file mode 100644 index 0000000000..8dc3ceae0a --- /dev/null +++ b/.github/workflows/BackgroundTasks.yml @@ -0,0 +1,27 @@ +name: Background tasks + +permissions: + pull-requests: write + contents: read + +on: + pull_request_target: + +jobs: + upload: + if: github.repository_owner == 'MicrosoftDocs' + runs-on: ubuntu-latest + + steps: + - name: Save payload data + env: + PayloadJson: ${{ toJSON(github) }} + AccessToken: ${{ github.token }} + run: | + mkdir -p ./pr + echo $PayloadJson > ./pr/PayloadJson.json + sed -i -e "s/$AccessToken/XYZ/g" ./pr/PayloadJson.json + - uses: actions/upload-artifact@v4 + with: + name: PayloadJson + path: pr/ \ No newline at end of file diff --git a/.github/workflows/BuildValidation.yml b/.github/workflows/BuildValidation.yml new file mode 100644 index 0000000000..dadccacbef --- /dev/null +++ b/.github/workflows/BuildValidation.yml @@ -0,0 +1,19 @@ +name: PR has no warnings or errors + +permissions: + pull-requests: write + statuses: write + +on: + issue_comment: + types: [created] + +jobs: + + build-status: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-BuildValidation.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/LiveMergeCheck.yml b/.github/workflows/LiveMergeCheck.yml new file mode 100644 index 0000000000..7db35548e9 --- /dev/null +++ b/.github/workflows/LiveMergeCheck.yml @@ -0,0 +1,20 @@ +name: PR can merge into branch + +permissions: + pull-requests: write + statuses: write + contents: read + +on: + pull_request_target: + types: [opened, reopened, synchronize, edited] + +jobs: + + live-merge: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-LiveMergeCheck.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/PrFileCount.yml b/.github/workflows/PrFileCount.yml new file mode 100644 index 0000000000..17faf7a211 --- /dev/null +++ b/.github/workflows/PrFileCount.yml @@ -0,0 +1,20 @@ +name: PR file count less than limit + +permissions: + pull-requests: write + statuses: write + contents: read + +on: + pull_request_target: + types: [opened, reopened, synchronize, labeled, unlabeled, edited] + +jobs: + + file-count: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-PrFileCount.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/ProtectedFiles.yml b/.github/workflows/ProtectedFiles.yml new file mode 100644 index 0000000000..bbdbbe2e40 --- /dev/null +++ b/.github/workflows/ProtectedFiles.yml @@ -0,0 +1,18 @@ +name: PR has no protected files + +permissions: + pull-requests: write + statuses: write + contents: read + +on: [pull_request_target] + +jobs: + + protected-files: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-ProtectedFiles.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/Stale.yml b/.github/workflows/Stale.yml new file mode 100644 index 0000000000..7f262d325a --- /dev/null +++ b/.github/workflows/Stale.yml @@ -0,0 +1,20 @@ +name: (Scheduled) Mark stale pull requests + +permissions: + issues: write + pull-requests: write + +on: + schedule: + - cron: "0 */6 * * *" + workflow_dispatch: + +jobs: + stale: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-Stale.yml@workflows-prod + with: + RunDebug: false + RepoVisibility: ${{ github.repository_visibility }} + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/StaleBranch.yml b/.github/workflows/StaleBranch.yml new file mode 100644 index 0000000000..30212d1836 --- /dev/null +++ b/.github/workflows/StaleBranch.yml @@ -0,0 +1,32 @@ +name: (Scheduled) Stale branch removal + +permissions: + contents: write + pull-requests: read + +# This workflow is designed to be run in the days up to, and including, a "deletion day", specified by 'DeleteOnDayOfMonth' in env: in https://github.com/MicrosoftDocs/microsoft-365-docs/blob/workflows-prod/.github/workflows/Shared-StaleBranch.yml. +# On the days leading up to "deletion day", the workflow will report the branches to be deleted. This lets users see which branches will be deleted. On "deletion day", those branches are deleted. +# The workflow should not be configured to run after "deletion day" so that users can review the branches were deleted. +# Recommendation: configure cron to run on days 1,15-31 where 1 is what's configured in 'DeleteOnDayOfMonth'. If 'DeleteOnDayOfMonth' is set to something else, update cron to run the two weeks leading up to it. + +on: + schedule: + - cron: "0 9 1,15-31 * *" + + workflow_dispatch: + + +jobs: + + stale-branch: + if: github.repository_owner == 'MicrosoftDocs' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-StaleBranch.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + RepoBranchSkipList: '[ + "ExampleBranch1", + "ExampleBranch2" + ]' + ReportOnly: false + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/TierManagement.yml b/.github/workflows/TierManagement.yml new file mode 100644 index 0000000000..47baf0be65 --- /dev/null +++ b/.github/workflows/TierManagement.yml @@ -0,0 +1,21 @@ +name: Tier management + +permissions: + pull-requests: write + contents: read + +on: + issue_comment: + types: [created, edited] + +jobs: + + tier-mgmt: + if: github.repository_owner == 'MicrosoftDocs' && github.repository_visibility == 'private' + uses: MicrosoftDocs/microsoft-365-docs/.github/workflows/Shared-TierManagement.yml@workflows-prod + with: + PayloadJson: ${{ toJSON(github) }} + EnableWriteSignOff: 1 + EnableReadOnlySignoff: 1 + secrets: + AccessToken: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.gitignore b/.gitignore index 6ff3476cd5..41b9a36fff 100644 --- a/.gitignore +++ b/.gitignore @@ -4,9 +4,13 @@ _site/ .optemp/ _themes*/ .vs/ +common/ +.vscode/ +*.ini +.DS_Store +*.db +\.idea/ .local/ .openpublishing.buildcore.ps1 **/node_modules - -\.idea/ diff --git a/.openpublishing.build.ps1 b/.openpublishing.build.ps1 deleted file mode 100644 index aadef76202..0000000000 --- a/.openpublishing.build.ps1 +++ /dev/null @@ -1,17 +0,0 @@ -param( - [string]$buildCorePowershellUrl = "https://opbuildstorageprod.blob.core.windows.net/opps1container/.openpublishing.buildcore.ps1", - [string]$parameters -) -# Main -$errorActionPreference = 'Stop' - -# Step-1: Download buildcore script to local -echo "download build core script to local with source url: $buildCorePowershellUrl" -$repositoryRoot = Split-Path -Parent $MyInvocation.MyCommand.Definition -$buildCorePowershellDestination = "$repositoryRoot\.openpublishing.buildcore.ps1" -Invoke-WebRequest $buildCorePowershellUrl -OutFile "$buildCorePowershellDestination" - -# Step-2: Run build core -echo "run build core script with parameters: $parameters" -& "$buildCorePowershellDestination" "$parameters" -exit $LASTEXITCODE diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 5b31e08def..72c839af99 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -24,7 +24,7 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -45,40 +45,8 @@ "build_entry_point": "docs", "template_folder": "_themes", "version": 0, - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" - ] - }, - "monikerPath": [ - "mapping/monikerMapping.json" - ] - }, - { - "docset_name": "sharepoint-ps", - "build_source_folder": "sharepoint", - "build_output_subfolder": "sharepoint-ps", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "ManagedReference": "Content", - "RestApi": "Content", - "PowershellModule": "Content", - "PowershellCmdlet": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" - ] - }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -105,13 +73,13 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { - "docset_name": "staffhub-ps", - "build_source_folder": "staffhub", - "build_output_subfolder": "staffhub-ps", + "docset_name": "spmt-ps", + "build_source_folder": "spmt", + "build_output_subfolder": "spmt-ps", "locale": "en-us", "monikers": [], "moniker_ranges": [], @@ -126,13 +94,8 @@ "build_entry_point": "docs", "template_folder": "_themes", "version": 0, - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" - ] - }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -159,34 +122,7 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" - ] - }, - { - "docset_name": "spmt-ps", - "build_source_folder": "spmt", - "build_output_subfolder": "spmt-ps", - "locale": "en-us", - "monikers": [], - "moniker_ranges": [], - "open_to_public_contributors": true, - "type_mapping": { - "Conceptual": "Content", - "ManagedReference": "Content", - "RestApi": "Content", - "PowershellModule": "Content", - "PowershellCmdlet": "Content" - }, - "build_entry_point": "docs", - "template_folder": "_themes", - "version": 0, - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" - ] - }, - "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] }, { @@ -213,23 +149,20 @@ ] }, "monikerPath": [ - "mapping/monikerMapping.json" + "mapping/MAML2Yaml/monikerMapping.json" ] } ], "notification_subscribers": [], "sync_notification_subscribers": [], "branches_to_filter": [], - "git_repository_branch_open_to_public_contributors": "master", - "skip_source_output_uploading": false, + "git_repository_branch_open_to_public_contributors": "main", "need_preview_pull_request": true, - "enable_incremental_build": false, - "contribution_branch_mappings": {}, "dependent_repositories": [ { "path_to_root": "_themes", "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "master", + "branch": "main", "branch_mapping": {} } ], @@ -238,12 +171,16 @@ "Publish" ] }, - "need_generate_pdf_url_template": false, "targets": { "Pdf": { "template_folder": "_themes.pdf" } }, + "docs_build_engine": {}, + "skip_source_output_uploading": false, + "enable_incremental_build": false, + "contribution_branch_mappings": {}, + "need_generate_pdf_url_template": false, "need_generate_intellisense": false, "dependent_packages": [ { @@ -253,8 +190,5 @@ "target_framework": "net45", "version": "latest" } - ], - "docs_build_engine": { - "name": "docfx_v3" - } -} + ] +} \ No newline at end of file diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 6b31f6eab9..0c2327fa83 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -2,72 +2,72 @@ "redirections": [ { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpEdmSschema.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpedmschema", + "redirect_url": "/powershell/module/exchange/new-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-TeamsRetentionCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchange/get-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-TeamsRetentionComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancerule", + "redirect_url": "/powershell/module/exchange/get-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-TeamsRetentionCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchange/new-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-TeamsRetentionComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancerule", + "redirect_url": "/powershell/module/exchange/new-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-TeamsRetentionCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchange/remove-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-TeamsRetentionComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule", + "redirect_url": "/powershell/module/exchange/remove-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-TeamsRetentionCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchange/set-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-TeamsRetentionComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-retentioncompliancerule", + "redirect_url": "/powershell/module/exchange/set-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpComplianceRuleV2.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancerule", + "redirect_url": "/powershell/module/exchange/get-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpComplianceRuleV2.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpcompliancerule", + "redirect_url": "/powershell/module/exchange/new-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRuleV2.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule", + "redirect_url": "/powershell/module/exchange/remove-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpComplianceRuleV2.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancerule", + "redirect_url": "/powershell/module/exchange/set-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/exchange-ps-v2-module/connect-exchangeonline.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/connect-exchangeonline", + "redirect_url": "/powershell/module/exchange/connect-exchangeonline", "redirect_document_id": true }, { @@ -162,6468 +162,8865 @@ }, { "source_path": "sharepoint/docs-conceptual/overview.md", - "redirect_url": "https://docs.microsoft.com/powershell/sharepoint", + "redirect_url": "/powershell/sharepoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Add-ADPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-adpermission", + "redirect_url": "/powershell/module/exchange/add-adpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Dump-ProvisioningCache.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/dump-provisioningcache", + "redirect_url": "/powershell/module/exchange/dump-provisioningcache", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-adpermission", + "redirect_url": "/powershell/module/exchange/get-adpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADServerSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-adserversettings", + "redirect_url": "/powershell/module/exchange/get-adserversettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-ADSite.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-adsite", + "redirect_url": "/powershell/module/exchange/get-adsite", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-AdSiteLink.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-adsitelink", + "redirect_url": "/powershell/module/exchange/get-adsitelink", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-DomainController.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-domaincontroller", + "redirect_url": "/powershell/module/exchange/get-domaincontroller", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-OrganizationalUnit.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-organizationalunit", + "redirect_url": "/powershell/module/exchange/get-organizationalunit", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-Trust.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-trust", + "redirect_url": "/powershell/module/exchange/get-trust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Get-UserPrincipalNamesSuffix.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-userprincipalnamessuffix", + "redirect_url": "/powershell/module/exchange/get-userprincipalnamessuffix", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Remove-ADPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-adpermission", + "redirect_url": "/powershell/module/exchange/remove-adpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Reset-ProvisioningCache.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/reset-provisioningcache", + "redirect_url": "/powershell/module/exchange/reset-provisioningcache", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Set-ADServerSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-adserversettings", + "redirect_url": "/powershell/module/exchange/set-adserversettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Set-ADSite.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-adsite", + "redirect_url": "/powershell/module/exchange/set-adsite", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/active-directory/Set-AdSiteLink.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-adsitelink", + "redirect_url": "/powershell/module/exchange/set-adsitelink", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-AntiPhishRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-antiphishrule", + "redirect_url": "/powershell/module/exchange/disable-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-SafeAttachmentRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-safeattachmentrule", + "redirect_url": "/powershell/module/exchange/disable-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Disable-SafeLinksRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-safelinksrule", + "redirect_url": "/powershell/module/exchange/disable-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-AntiPhishRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-antiphishrule", + "redirect_url": "/powershell/module/exchange/enable-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-SafeAttachmentRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-safeattachmentrule", + "redirect_url": "/powershell/module/exchange/enable-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Enable-SafeLinksRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-safelinksrule", + "redirect_url": "/powershell/module/exchange/enable-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentDetail.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiondocumentdetail", + "redirect_url": "/powershell/module/exchange/get-advancedthreatprotectiondocumentdetail", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionDocumentReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiondocumentreport", + "redirect_url": "/powershell/module/exchange/get-advancedthreatprotectiondocumentreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AdvancedThreatProtectionTrafficReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiontrafficreport", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AntiPhishPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-antiphishpolicy", + "redirect_url": "/powershell/module/exchange/get-antiphishpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AntiPhishRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-antiphishrule", + "redirect_url": "/powershell/module/exchange/get-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-AtpPolicyForO365.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-atppolicyforo365", + "redirect_url": "/powershell/module/exchange/get-atppolicyforo365", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-MailDetailATPReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-maildetailatpreport", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-MailTrafficATPReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficatpreport", + "redirect_url": "/powershell/module/exchange/get-mailtrafficatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-PhishFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-phishfilterpolicy", + "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistspoofitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeAttachmentPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-safeattachmentpolicy", + "redirect_url": "/powershell/module/exchange/get-safeattachmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeAttachmentRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-safeattachmentrule", + "redirect_url": "/powershell/module/exchange/get-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeLinksPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-safelinkspolicy", + "redirect_url": "/powershell/module/exchange/get-safelinkspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SafeLinksRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-safelinksrule", + "redirect_url": "/powershell/module/exchange/get-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-SpoofMailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-spoofmailreport", + "redirect_url": "/powershell/module/exchange/get-spoofmailreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Get-UrlTrace.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-urltrace", + "redirect_url": "/powershell/module/exchange/get-safelinksaggregatereport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-AntiPhishPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-antiphishpolicy", + "redirect_url": "/powershell/module/exchange/new-antiphishpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-AntiPhishRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-antiphishrule", + "redirect_url": "/powershell/module/exchange/new-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeAttachmentPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-safeattachmentpolicy", + "redirect_url": "/powershell/module/exchange/new-safeattachmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeAttachmentRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-safeattachmentrule", + "redirect_url": "/powershell/module/exchange/new-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeLinksPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-safelinkspolicy", + "redirect_url": "/powershell/module/exchange/new-safelinkspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/New-SafeLinksRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-safelinksrule", + "redirect_url": "/powershell/module/exchange/new-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-AntiPhishPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-antiphishpolicy", + "redirect_url": "/powershell/module/exchange/remove-antiphishpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-AntiPhishRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-antiphishrule", + "redirect_url": "/powershell/module/exchange/remove-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeAttachmentPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-safeattachmentpolicy", + "redirect_url": "/powershell/module/exchange/remove-safeattachmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeAttachmentRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-safeattachmentrule", + "redirect_url": "/powershell/module/exchange/remove-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeLinksPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-safelinkspolicy", + "redirect_url": "/powershell/module/exchange/remove-safelinkspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Remove-SafeLinksRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-safelinksrule", + "redirect_url": "/powershell/module/exchange/remove-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AntiPhishPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-antiphishpolicy", + "redirect_url": "/powershell/module/exchange/set-antiphishpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AntiPhishRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-antiphishrule", + "redirect_url": "/powershell/module/exchange/set-antiphishrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-AtpPolicyForO365.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-atppolicyforo365", + "redirect_url": "/powershell/module/exchange/set-atppolicyforo365", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-PhishFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-phishfilterpolicy", + "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistspoofitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeAttachmentPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-safeattachmentpolicy", + "redirect_url": "/powershell/module/exchange/set-safeattachmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeAttachmentRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-safeattachmentrule", + "redirect_url": "/powershell/module/exchange/set-safeattachmentrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeLinksPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-safelinkspolicy", + "redirect_url": "/powershell/module/exchange/set-safelinkspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/advanced-threat-protection/Set-SafeLinksRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-safelinksrule", + "redirect_url": "/powershell/module/exchange/set-safelinksrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-AttachmentFilterEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-attachmentfilterentry", + "redirect_url": "/powershell/module/exchange/add-attachmentfilterentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-ContentFilterPhrase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-contentfilterphrase", + "redirect_url": "/powershell/module/exchange/add-contentfilterphrase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPAllowListEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-ipallowlistentry", + "redirect_url": "/powershell/module/exchange/add-ipallowlistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPAllowListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-ipallowlistprovider", + "redirect_url": "/powershell/module/exchange/add-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPBlockListEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-ipblocklistentry", + "redirect_url": "/powershell/module/exchange/add-ipblocklistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Add-IPBlockListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-ipblocklistprovider", + "redirect_url": "/powershell/module/exchange/add-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Delete-QuarantineMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/delete-quarantinemessage", + "redirect_url": "/powershell/module/exchange/delete-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-HostedContentFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchange/disable-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-HostedOutboundSpamFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchange/disable-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Disable-MalwareFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-malwarefilterrule", + "redirect_url": "/powershell/module/exchange/disable-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-AntispamUpdates.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-antispamupdates", + "redirect_url": "/powershell/module/exchange/enable-antispamupdates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-HostedContentFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchange/enable-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-HostedOutboundSpamFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchange/enable-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Enable-MalwareFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-malwarefilterrule", + "redirect_url": "/powershell/module/exchange/enable-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Export-QuarantineMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-quarantinemessage", + "redirect_url": "/powershell/module/exchange/export-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AgentLog.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-agentlog", + "redirect_url": "/powershell/module/exchange/get-agentlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AttachmentFilterEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-attachmentfilterentry", + "redirect_url": "/powershell/module/exchange/get-attachmentfilterentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-AttachmentFilterListConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-attachmentfilterlistconfig", + "redirect_url": "/powershell/module/exchange/get-attachmentfilterlistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-BlockedSenderAddress.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-blockedsenderaddress", + "redirect_url": "/powershell/module/exchange/get-blockedsenderaddress", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-ContentFilterConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-contentfilterconfig", + "redirect_url": "/powershell/module/exchange/get-contentfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-ContentFilterPhrase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-contentfilterphrase", + "redirect_url": "/powershell/module/exchange/get-contentfilterphrase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-DkimSigningConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dkimsigningconfig", + "redirect_url": "/powershell/module/exchange/get-dkimsigningconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedConnectionFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-hostedconnectionfilterpolicy", + "redirect_url": "/powershell/module/exchange/get-hostedconnectionfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedContentFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-hostedcontentfilterpolicy", + "redirect_url": "/powershell/module/exchange/get-hostedcontentfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedContentFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchange/get-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterpolicy", + "redirect_url": "/powershell/module/exchange/get-hostedoutboundspamfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-HostedOutboundSpamFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchange/get-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ipallowlistconfig", + "redirect_url": "/powershell/module/exchange/get-ipallowlistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ipallowlistentry", + "redirect_url": "/powershell/module/exchange/get-ipallowlistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ipallowlistprovider", + "redirect_url": "/powershell/module/exchange/get-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPAllowListProvidersConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ipallowlistprovidersconfig", + "redirect_url": "/powershell/module/exchange/get-ipallowlistprovidersconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ipblocklistconfig", + "redirect_url": "/powershell/module/exchange/get-ipblocklistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ipblocklistentry", + "redirect_url": "/powershell/module/exchange/get-ipblocklistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ipblocklistprovider", + "redirect_url": "/powershell/module/exchange/get-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-IPBlockListProvidersConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ipblocklistprovidersconfig", + "redirect_url": "/powershell/module/exchange/get-ipblocklistprovidersconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MailboxJunkEmailConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxjunkemailconfiguration", + "redirect_url": "/powershell/module/exchange/get-mailboxjunkemailconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilteringServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-malwarefilteringserver", + "redirect_url": "/powershell/module/exchange/get-malwarefilteringserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-malwarefilterpolicy", + "redirect_url": "/powershell/module/exchange/get-malwarefilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-MalwareFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-malwarefilterrule", + "redirect_url": "/powershell/module/exchange/get-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-QuarantineMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-quarantinemessage", + "redirect_url": "/powershell/module/exchange/get-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-QuarantineMessageHeader.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-quarantinemessageheader", + "redirect_url": "/powershell/module/exchange/get-quarantinemessageheader", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-RecipientFilterConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-recipientfilterconfig", + "redirect_url": "/powershell/module/exchange/get-recipientfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderFilterConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-senderfilterconfig", + "redirect_url": "/powershell/module/exchange/get-senderfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderIdConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-senderidconfig", + "redirect_url": "/powershell/module/exchange/get-senderidconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Get-SenderReputationConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-senderreputationconfig", + "redirect_url": "/powershell/module/exchange/get-senderreputationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-DkimSigningConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dkimsigningconfig", + "redirect_url": "/powershell/module/exchange/new-dkimsigningconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedContentFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-hostedcontentfilterpolicy", + "redirect_url": "/powershell/module/exchange/new-hostedcontentfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedContentFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchange/new-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterpolicy", + "redirect_url": "/powershell/module/exchange/new-hostedoutboundspamfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-HostedOutboundSpamFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchange/new-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-MalwareFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-malwarefilterpolicy", + "redirect_url": "/powershell/module/exchange/new-malwarefilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/New-MalwareFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-malwarefilterrule", + "redirect_url": "/powershell/module/exchange/new-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Preview-QuarantineMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/preview-quarantinemessage", + "redirect_url": "/powershell/module/exchange/preview-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Release-QuarantineMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/release-quarantinemessage", + "redirect_url": "/powershell/module/exchange/release-quarantinemessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-AttachmentFilterEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-attachmentfilterentry", + "redirect_url": "/powershell/module/exchange/remove-attachmentfilterentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-BlockedSenderAddress.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-blockedsenderaddress", + "redirect_url": "/powershell/module/exchange/remove-blockedsenderaddress", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-ContentFilterPhrase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-contentfilterphrase", + "redirect_url": "/powershell/module/exchange/remove-contentfilterphrase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedContentFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterpolicy", + "redirect_url": "/powershell/module/exchange/remove-hostedcontentfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedContentFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchange/remove-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy", + "redirect_url": "/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-HostedOutboundSpamFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchange/remove-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPAllowListEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-ipallowlistentry", + "redirect_url": "/powershell/module/exchange/remove-ipallowlistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPAllowListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-ipallowlistprovider", + "redirect_url": "/powershell/module/exchange/remove-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPBlockListEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-ipblocklistentry", + "redirect_url": "/powershell/module/exchange/remove-ipblocklistentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-IPBlockListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-ipblocklistprovider", + "redirect_url": "/powershell/module/exchange/remove-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-MalwareFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-malwarefilterpolicy", + "redirect_url": "/powershell/module/exchange/remove-malwarefilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Remove-MalwareFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-malwarefilterrule", + "redirect_url": "/powershell/module/exchange/remove-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Rotate-DkimSigningConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/rotate-dkimsigningconfig", + "redirect_url": "/powershell/module/exchange/rotate-dkimsigningconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-AttachmentFilterListConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig", + "redirect_url": "/powershell/module/exchange/set-attachmentfilterlistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-ContentFilterConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-contentfilterconfig", + "redirect_url": "/powershell/module/exchange/set-contentfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-DkimSigningConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dkimsigningconfig", + "redirect_url": "/powershell/module/exchange/set-dkimsigningconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedConnectionFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-hostedconnectionfilterpolicy", + "redirect_url": "/powershell/module/exchange/set-hostedconnectionfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedContentFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-hostedcontentfilterpolicy", + "redirect_url": "/powershell/module/exchange/set-hostedcontentfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedContentFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-hostedcontentfilterrule", + "redirect_url": "/powershell/module/exchange/set-hostedcontentfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterpolicy", + "redirect_url": "/powershell/module/exchange/set-hostedoutboundspamfilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-HostedOutboundSpamFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterrule", + "redirect_url": "/powershell/module/exchange/set-hostedoutboundspamfilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ipallowlistconfig", + "redirect_url": "/powershell/module/exchange/set-ipallowlistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ipallowlistprovider", + "redirect_url": "/powershell/module/exchange/set-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPAllowListProvidersConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ipallowlistprovidersconfig", + "redirect_url": "/powershell/module/exchange/set-ipallowlistprovidersconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ipblocklistconfig", + "redirect_url": "/powershell/module/exchange/set-ipblocklistconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ipblocklistprovider", + "redirect_url": "/powershell/module/exchange/set-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-IPBlockListProvidersConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ipblocklistprovidersconfig", + "redirect_url": "/powershell/module/exchange/set-ipblocklistprovidersconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MailboxJunkEmailConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxjunkemailconfiguration", + "redirect_url": "/powershell/module/exchange/set-mailboxjunkemailconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilteringServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-malwarefilteringserver", + "redirect_url": "/powershell/module/exchange/set-malwarefilteringserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilterPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-malwarefilterpolicy", + "redirect_url": "/powershell/module/exchange/set-malwarefilterpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-MalwareFilterRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-malwarefilterrule", + "redirect_url": "/powershell/module/exchange/set-malwarefilterrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-RecipientFilterConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-recipientfilterconfig", + "redirect_url": "/powershell/module/exchange/set-recipientfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderFilterConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-senderfilterconfig", + "redirect_url": "/powershell/module/exchange/set-senderfilterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderIdConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-senderidconfig", + "redirect_url": "/powershell/module/exchange/set-senderidconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Set-SenderReputationConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-senderreputationconfig", + "redirect_url": "/powershell/module/exchange/set-senderreputationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-IPAllowListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-ipallowlistprovider", + "redirect_url": "/powershell/module/exchange/test-ipallowlistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-IPBlockListProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-ipblocklistprovider", + "redirect_url": "/powershell/module/exchange/test-ipblocklistprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Test-SenderId.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-senderid", + "redirect_url": "/powershell/module/exchange/test-senderid", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/antispam-antimalware/Update-SafeList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-safelist", + "redirect_url": "/powershell/module/exchange/update-safelist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Clear-TextMessagingAccount.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/clear-textmessagingaccount", + "redirect_url": "/powershell/module/exchange/clear-textmessagingaccount", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Compare-TextMessagingVerificationCode.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/compare-textmessagingverificationcode", + "redirect_url": "/powershell/module/exchange/compare-textmessagingverificationcode", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Disable-PushNotificationProxy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-pushnotificationproxy", + "redirect_url": "/powershell/module/exchange/disable-pushnotificationproxy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Enable-PushNotificationProxy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-pushnotificationproxy", + "redirect_url": "/powershell/module/exchange/enable-pushnotificationproxy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Export-AutoDiscoverConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-autodiscoverconfig", + "redirect_url": "/powershell/module/exchange/export-autodiscoverconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-CASMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-casmailbox", + "redirect_url": "/powershell/module/exchange/get-casmailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-CASMailboxPlan.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-casmailboxplan", + "redirect_url": "/powershell/module/exchange/get-casmailboxplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-ClientAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-clientaccessrule", + "redirect_url": "/powershell/module/exchange/get-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-ImapSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-imapsettings", + "redirect_url": "/powershell/module/exchange/get-imapsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxCalendarConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxcalendarconfiguration", + "redirect_url": "/powershell/module/exchange/get-mailboxcalendarconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxMessageConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxmessageconfiguration", + "redirect_url": "/powershell/module/exchange/get-mailboxmessageconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxRegionalConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxregionalconfiguration", + "redirect_url": "/powershell/module/exchange/get-mailboxregionalconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-MailboxSpellingConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxspellingconfiguration", + "redirect_url": "/powershell/module/exchange/get-mailboxspellingconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-OutlookProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-outlookprovider", + "redirect_url": "/powershell/module/exchange/get-outlookprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-OwaMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-owamailboxpolicy", + "redirect_url": "/powershell/module/exchange/get-owamailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-PopSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-popsettings", + "redirect_url": "/powershell/module/exchange/get-popsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Get-TextMessagingAccount.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-textmessagingaccount", + "redirect_url": "/powershell/module/exchange/get-textmessagingaccount", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/New-ClientAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-clientaccessrule", + "redirect_url": "/powershell/module/exchange/new-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/New-OutlookProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-outlookprovider", + "redirect_url": "/powershell/module/exchange/new-outlookprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/New-OwaMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-owamailboxpolicy", + "redirect_url": "/powershell/module/exchange/new-owamailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Remove-ClientAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-clientaccessrule", + "redirect_url": "/powershell/module/exchange/remove-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Remove-OutlookProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-outlookprovider", + "redirect_url": "/powershell/module/exchange/remove-outlookprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Remove-OwaMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-owamailboxpolicy", + "redirect_url": "/powershell/module/exchange/remove-owamailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Send-TextMessagingVerificationCode.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/send-textmessagingverificationcode", + "redirect_url": "/powershell/module/exchange/send-textmessagingverificationcode", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-CASMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-casmailbox", + "redirect_url": "/powershell/module/exchange/set-casmailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/set-CASMailboxPlan.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-casmailboxplan", + "redirect_url": "/powershell/module/exchange/set-casmailboxplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-ClientAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-clientaccessrule", + "redirect_url": "/powershell/module/exchange/set-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-ImapSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-imapsettings", + "redirect_url": "/powershell/module/exchange/set-imapsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxCalendarConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxcalendarconfiguration", + "redirect_url": "/powershell/module/exchange/set-mailboxcalendarconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxMessageConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxmessageconfiguration", + "redirect_url": "/powershell/module/exchange/set-mailboxmessageconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxRegionalConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration", + "redirect_url": "/powershell/module/exchange/set-mailboxregionalconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-MailboxSpellingConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxspellingconfiguration", + "redirect_url": "/powershell/module/exchange/set-mailboxspellingconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-OutlookProvider.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-outlookprovider", + "redirect_url": "/powershell/module/exchange/set-outlookprovider", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-OwaMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-owamailboxpolicy", + "redirect_url": "/powershell/module/exchange/set-owamailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-PopSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-popsettings", + "redirect_url": "/powershell/module/exchange/set-popsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Set-TextMessagingAccount.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-textmessagingaccount", + "redirect_url": "/powershell/module/exchange/set-textmessagingaccount", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-CalendarConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-calendarconnectivity", + "redirect_url": "/powershell/module/exchange/test-calendarconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-ClientAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-clientaccessrule", + "redirect_url": "/powershell/module/exchange/test-clientaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-EcpConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-ecpconnectivity", + "redirect_url": "/powershell/module/exchange/test-ecpconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-ImapConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-imapconnectivity", + "redirect_url": "/powershell/module/exchange/test-imapconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-OutlookConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-outlookconnectivity", + "redirect_url": "/powershell/module/exchange/test-outlookconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-OutlookWebServices.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-outlookwebservices", + "redirect_url": "/powershell/module/exchange/test-outlookwebservices", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-OwaConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-owaconnectivity", + "redirect_url": "/powershell/module/exchange/test-owaconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-PopConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-popconnectivity", + "redirect_url": "/powershell/module/exchange/test-popconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-PowerShellConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-powershellconnectivity", + "redirect_url": "/powershell/module/exchange/test-powershellconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access/Test-WebServicesConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-webservicesconnectivity", + "redirect_url": "/powershell/module/exchange/test-webservicesconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Disable-OutlookAnywhere.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-outlookanywhere", + "redirect_url": "/powershell/module/exchange/disable-outlookanywhere", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Enable-OutlookAnywhere.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-outlookanywhere", + "redirect_url": "/powershell/module/exchange/enable-outlookanywhere", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ActiveSyncVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activesyncvirtualdirectory", + "redirect_url": "/powershell/module/exchange/get-activesyncvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-AuthRedirect.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-authredirect", + "redirect_url": "/powershell/module/exchange/get-authredirect", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-AutodiscoverVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-autodiscovervirtualdirectory", + "redirect_url": "/powershell/module/exchange/get-autodiscovervirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessArray.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-clientaccessarray", + "redirect_url": "/powershell/module/exchange/get-clientaccessarray", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-clientaccessserver", + "redirect_url": "/powershell/module/exchange/get-clientaccessserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-ClientAccessService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-clientaccessservice", + "redirect_url": "/powershell/module/exchange/get-clientaccessservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-EcpVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ecpvirtualdirectory", + "redirect_url": "/powershell/module/exchange/get-ecpvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-MapiVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mapivirtualdirectory", + "redirect_url": "/powershell/module/exchange/get-mapivirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-OutlookAnywhere.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-outlookanywhere", + "redirect_url": "/powershell/module/exchange/get-outlookanywhere", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-OwaVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-owavirtualdirectory", + "redirect_url": "/powershell/module/exchange/get-owavirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-PowerShellVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-powershellvirtualdirectory", + "redirect_url": "/powershell/module/exchange/get-powershellvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-RpcClientAccess.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-rpcclientaccess", + "redirect_url": "/powershell/module/exchange/get-rpcclientaccess", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Get-WebServicesVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-webservicesvirtualdirectory", + "redirect_url": "/powershell/module/exchange/get-webservicesvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-ActiveSyncVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-activesyncvirtualdirectory", + "redirect_url": "/powershell/module/exchange/new-activesyncvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-AuthRedirect.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-authredirect", + "redirect_url": "/powershell/module/exchange/new-authredirect", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-AutodiscoverVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-autodiscovervirtualdirectory", + "redirect_url": "/powershell/module/exchange/new-autodiscovervirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-ClientAccessArray.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-clientaccessarray", + "redirect_url": "/powershell/module/exchange/new-clientaccessarray", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-EcpVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-ecpvirtualdirectory", + "redirect_url": "/powershell/module/exchange/new-ecpvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-MapiVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mapivirtualdirectory", + "redirect_url": "/powershell/module/exchange/new-mapivirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-OwaVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-owavirtualdirectory", + "redirect_url": "/powershell/module/exchange/new-owavirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-PowerShellVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-powershellvirtualdirectory", + "redirect_url": "/powershell/module/exchange/new-powershellvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-RpcClientAccess.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-rpcclientaccess", + "redirect_url": "/powershell/module/exchange/new-rpcclientaccess", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/New-WebServicesVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-webservicesvirtualdirectory", + "redirect_url": "/powershell/module/exchange/new-webservicesvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-ActiveSyncVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-activesyncvirtualdirectory", + "redirect_url": "/powershell/module/exchange/remove-activesyncvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-AuthRedirect.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-authredirect", + "redirect_url": "/powershell/module/exchange/remove-authredirect", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-AutodiscoverVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-autodiscovervirtualdirectory", + "redirect_url": "/powershell/module/exchange/remove-autodiscovervirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-ClientAccessArray.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-clientaccessarray", + "redirect_url": "/powershell/module/exchange/remove-clientaccessarray", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-EcpVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-ecpvirtualdirectory", + "redirect_url": "/powershell/module/exchange/remove-ecpvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-MapiVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mapivirtualdirectory", + "redirect_url": "/powershell/module/exchange/remove-mapivirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-OwaVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-owavirtualdirectory", + "redirect_url": "/powershell/module/exchange/remove-owavirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-PowerShellVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-powershellvirtualdirectory", + "redirect_url": "/powershell/module/exchange/remove-powershellvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-RpcClientAccess.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-rpcclientaccess", + "redirect_url": "/powershell/module/exchange/remove-rpcclientaccess", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Remove-WebServicesVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-webservicesvirtualdirectory", + "redirect_url": "/powershell/module/exchange/remove-webservicesvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ActiveSyncVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-activesyncvirtualdirectory", + "redirect_url": "/powershell/module/exchange/set-activesyncvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-AuthRedirect.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-authredirect", + "redirect_url": "/powershell/module/exchange/set-authredirect", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-AutodiscoverVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-autodiscovervirtualdirectory", + "redirect_url": "/powershell/module/exchange/set-autodiscovervirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessArray.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-clientaccessarray", + "redirect_url": "/powershell/module/exchange/set-clientaccessarray", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-clientaccessserver", + "redirect_url": "/powershell/module/exchange/set-clientaccessserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-ClientAccessService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-clientaccessservice", + "redirect_url": "/powershell/module/exchange/set-clientaccessservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-EcpVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ecpvirtualdirectory", + "redirect_url": "/powershell/module/exchange/set-ecpvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-MapiVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mapivirtualdirectory", + "redirect_url": "/powershell/module/exchange/set-mapivirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-OutlookAnywhere.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-outlookanywhere", + "redirect_url": "/powershell/module/exchange/set-outlookanywhere", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-OwaVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-owavirtualdirectory", + "redirect_url": "/powershell/module/exchange/set-owavirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-PowerShellVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-powershellvirtualdirectory", + "redirect_url": "/powershell/module/exchange/set-powershellvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-RpcClientAccess.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-rpcclientaccess", + "redirect_url": "/powershell/module/exchange/set-rpcclientaccess", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/client-access-servers/Set-WebServicesVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-webservicesvirtualdirectory", + "redirect_url": "/powershell/module/exchange/set-webservicesvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Add-DatabaseAvailabilityGroupServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-databaseavailabilitygroupserver", + "redirect_url": "/powershell/module/exchange/add-databaseavailabilitygroupserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Add-MailboxDatabaseCopy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchange/add-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-DatabaseAvailabilityGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchange/get-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroupnetwork", + "redirect_url": "/powershell/module/exchange/get-databaseavailabilitygroupnetwork", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Get-MailboxDatabaseCopyStatus.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxdatabasecopystatus", + "redirect_url": "/powershell/module/exchange/get-mailboxdatabasecopystatus", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Move-ActiveMailboxDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/move-activemailboxdatabase", + "redirect_url": "/powershell/module/exchange/move-activemailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/New-DatabaseAvailabilityGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchange/new-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/New-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroupnetwork", + "redirect_url": "/powershell/module/exchange/new-databaseavailabilitygroupnetwork", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroupnetwork", + "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroupnetwork", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-DatabaseAvailabilityGroupServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroupserver", + "redirect_url": "/powershell/module/exchange/remove-databaseavailabilitygroupserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Remove-MailboxDatabaseCopy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchange/remove-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Restore-DatabaseAvailabilityGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/restore-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchange/restore-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Resume-MailboxDatabaseCopy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchange/resume-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-DatabaseAvailabilityGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchange/set-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-DatabaseAvailabilityGroupNetwork.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroupnetwork", + "redirect_url": "/powershell/module/exchange/set-databaseavailabilitygroupnetwork", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Set-MailboxDatabaseCopy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchange/set-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Start-DatabaseAvailabilityGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchange/start-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Stop-DatabaseAvailabilityGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/stop-databaseavailabilitygroup", + "redirect_url": "/powershell/module/exchange/stop-databaseavailabilitygroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Suspend-MailboxDatabaseCopy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchange/suspend-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Test-ReplicationHealth.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-replicationhealth", + "redirect_url": "/powershell/module/exchange/test-replicationhealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/database-availability-groups/Update-MailboxDatabaseCopy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-mailboxdatabasecopy", + "redirect_url": "/powershell/module/exchange/update-mailboxdatabasecopy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Clear-ActiveSyncDevice.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/clear-activesyncdevice", + "redirect_url": "/powershell/module/exchange/clear-activesyncdevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Clear-MobileDevice.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/clear-mobiledevice", + "redirect_url": "/powershell/module/exchange/clear-mobiledevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Export-ActiveSyncLog.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-activesynclog", + "redirect_url": "/powershell/module/exchange/export-activesynclog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDevice.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activesyncdevice", + "redirect_url": "/powershell/module/exchange/get-activesyncdevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activesyncdeviceaccessrule", + "redirect_url": "/powershell/module/exchange/get-activesyncdeviceaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceAutoblockThreshold.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activesyncdeviceautoblockthreshold", + "redirect_url": "/powershell/module/exchange/get-activesyncdeviceautoblockthreshold", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceClass.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activesyncdeviceclass", + "redirect_url": "/powershell/module/exchange/get-activesyncdeviceclass", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncDeviceStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activesyncdevicestatistics", + "redirect_url": "/powershell/module/exchange/get-activesyncdevicestatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activesyncmailboxpolicy", + "redirect_url": "/powershell/module/exchange/get-activesyncmailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-ActiveSyncOrganizationSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activesyncorganizationsettings", + "redirect_url": "/powershell/module/exchange/get-activesyncorganizationsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConditionalAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-deviceconditionalaccesspolicy", + "redirect_url": "/powershell/module/exchange/get-deviceconditionalaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConditionalAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-deviceconditionalaccessrule", + "redirect_url": "/powershell/module/exchange/get-deviceconditionalaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConfigurationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-deviceconfigurationpolicy", + "redirect_url": "/powershell/module/exchange/get-deviceconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceConfigurationRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-deviceconfigurationrule", + "redirect_url": "/powershell/module/exchange/get-deviceconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DevicePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-devicepolicy", + "redirect_url": "/powershell/module/exchange/get-devicepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceTenantPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-devicetenantpolicy", + "redirect_url": "/powershell/module/exchange/get-devicetenantpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-DeviceTenantRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-devicetenantrule", + "redirect_url": "/powershell/module/exchange/get-devicetenantrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDevice.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mobiledevice", + "redirect_url": "/powershell/module/exchange/get-mobiledevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDeviceMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mobiledevicemailboxpolicy", + "redirect_url": "/powershell/module/exchange/get-mobiledevicemailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Get-MobileDeviceStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mobiledevicestatistics", + "redirect_url": "/powershell/module/exchange/get-mobiledevicestatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-ActiveSyncDeviceAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-activesyncdeviceaccessrule", + "redirect_url": "/powershell/module/exchange/new-activesyncdeviceaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-ActiveSyncMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-activesyncmailboxpolicy", + "redirect_url": "/powershell/module/exchange/new-activesyncmailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConditionalAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-deviceconditionalaccesspolicy", + "redirect_url": "/powershell/module/exchange/new-deviceconditionalaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConditionalAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-deviceconditionalaccessrule", + "redirect_url": "/powershell/module/exchange/new-deviceconditionalaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConfigurationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-deviceconfigurationpolicy", + "redirect_url": "/powershell/module/exchange/new-deviceconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceConfigurationRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-deviceconfigurationrule", + "redirect_url": "/powershell/module/exchange/new-deviceconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceTenantPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-devicetenantpolicy", + "redirect_url": "/powershell/module/exchange/new-devicetenantpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-DeviceTenantRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-devicetenantrule", + "redirect_url": "/powershell/module/exchange/new-devicetenantrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/New-MobileDeviceMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy", + "redirect_url": "/powershell/module/exchange/new-mobiledevicemailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDevice.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-activesyncdevice", + "redirect_url": "/powershell/module/exchange/remove-activesyncdevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDeviceAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-activesyncdeviceaccessrule", + "redirect_url": "/powershell/module/exchange/remove-activesyncdeviceaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncDeviceClass.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-activesyncdeviceclass", + "redirect_url": "/powershell/module/exchange/remove-activesyncdeviceclass", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-ActiveSyncMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-activesyncmailboxpolicy", + "redirect_url": "/powershell/module/exchange/remove-activesyncmailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConditionalAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccesspolicy", + "redirect_url": "/powershell/module/exchange/remove-deviceconditionalaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConditionalAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccessrule", + "redirect_url": "/powershell/module/exchange/remove-deviceconditionalaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConfigurationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-deviceconfigurationpolicy", + "redirect_url": "/powershell/module/exchange/remove-deviceconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceConfigurationRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-deviceconfigurationrule", + "redirect_url": "/powershell/module/exchange/remove-deviceconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceTenantPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-devicetenantpolicy", + "redirect_url": "/powershell/module/exchange/remove-devicetenantpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-DeviceTenantRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-devicetenantrule", + "redirect_url": "/powershell/module/exchange/remove-devicetenantrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-MobileDevice.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mobiledevice", + "redirect_url": "/powershell/module/exchange/remove-mobiledevice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Remove-MobileDeviceMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mobiledevicemailboxpolicy", + "redirect_url": "/powershell/module/exchange/remove-mobiledevicemailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncDeviceAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-activesyncdeviceaccessrule", + "redirect_url": "/powershell/module/exchange/set-activesyncdeviceaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncDeviceAutoblockThreshold.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-activesyncdeviceautoblockthreshold", + "redirect_url": "/powershell/module/exchange/set-activesyncdeviceautoblockthreshold", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-activesyncmailboxpolicy", + "redirect_url": "/powershell/module/exchange/set-activesyncmailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-ActiveSyncOrganizationSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-activesyncorganizationsettings", + "redirect_url": "/powershell/module/exchange/set-activesyncorganizationsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConditionalAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-deviceconditionalaccesspolicy", + "redirect_url": "/powershell/module/exchange/set-deviceconditionalaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConditionalAccessRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-deviceconditionalaccessrule", + "redirect_url": "/powershell/module/exchange/set-deviceconditionalaccessrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConfigurationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-deviceconfigurationpolicy", + "redirect_url": "/powershell/module/exchange/set-deviceconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceConfigurationRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-deviceconfigurationrule", + "redirect_url": "/powershell/module/exchange/set-deviceconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceTenantPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-devicetenantpolicy", + "redirect_url": "/powershell/module/exchange/set-devicetenantpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-DeviceTenantRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-devicetenantrule", + "redirect_url": "/powershell/module/exchange/set-devicetenantrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Set-MobileDeviceMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy", + "redirect_url": "/powershell/module/exchange/set-mobiledevicemailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/devices/Test-ActiveSyncConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-activesyncconnectivity", + "redirect_url": "/powershell/module/exchange/test-activesyncconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Disable-AddressListPaging.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-addresslistpaging", + "redirect_url": "/powershell/module/exchange/disable-addresslistpaging", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Enable-AddressListPaging.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-addresslistpaging", + "redirect_url": "/powershell/module/exchange/enable-addresslistpaging", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-AddressBookPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-addressbookpolicy", + "redirect_url": "/powershell/module/exchange/get-addressbookpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-AddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-addresslist", + "redirect_url": "/powershell/module/exchange/get-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-DetailsTemplate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-detailstemplate", + "redirect_url": "/powershell/module/exchange/get-detailstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-EmailAddressPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-emailaddresspolicy", + "redirect_url": "/powershell/module/exchange/get-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-GlobalAddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-globaladdresslist", + "redirect_url": "/powershell/module/exchange/get-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-OabVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-oabvirtualdirectory", + "redirect_url": "/powershell/module/exchange/get-oabvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Get-OfflineAddressBook.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-offlineaddressbook", + "redirect_url": "/powershell/module/exchange/get-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Move-AddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/move-addresslist", + "redirect_url": "/powershell/module/exchange/move-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Move-OfflineAddressBook.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/move-offlineaddressbook", + "redirect_url": "/powershell/module/exchange/move-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-AddressBookPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-addressbookpolicy", + "redirect_url": "/powershell/module/exchange/new-addressbookpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-AddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-addresslist", + "redirect_url": "/powershell/module/exchange/new-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-EmailAddressPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-emailaddresspolicy", + "redirect_url": "/powershell/module/exchange/new-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-GlobalAddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-globaladdresslist", + "redirect_url": "/powershell/module/exchange/new-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-OabVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-oabvirtualdirectory", + "redirect_url": "/powershell/module/exchange/new-oabvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/New-OfflineAddressBook.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-offlineaddressbook", + "redirect_url": "/powershell/module/exchange/new-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-AddressBookPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-addressbookpolicy", + "redirect_url": "/powershell/module/exchange/remove-addressbookpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-AddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-addresslist", + "redirect_url": "/powershell/module/exchange/remove-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-EmailAddressPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-emailaddresspolicy", + "redirect_url": "/powershell/module/exchange/remove-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-GlobalAddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-globaladdresslist", + "redirect_url": "/powershell/module/exchange/remove-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-OabVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-oabvirtualdirectory", + "redirect_url": "/powershell/module/exchange/remove-oabvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Remove-OfflineAddressBook.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-offlineaddressbook", + "redirect_url": "/powershell/module/exchange/remove-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Restore-DetailsTemplate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/restore-detailstemplate", + "redirect_url": "/powershell/module/exchange/restore-detailstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-AddressBookPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-addressbookpolicy", + "redirect_url": "/powershell/module/exchange/set-addressbookpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-AddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-addresslist", + "redirect_url": "/powershell/module/exchange/set-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-DetailsTemplate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-detailstemplate", + "redirect_url": "/powershell/module/exchange/set-detailstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-EmailAddressPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-emailaddresspolicy", + "redirect_url": "/powershell/module/exchange/set-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-GlobalAddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-globaladdresslist", + "redirect_url": "/powershell/module/exchange/set-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-OabVirtualDirectory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-oabvirtualdirectory", + "redirect_url": "/powershell/module/exchange/set-oabvirtualdirectory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Set-OfflineAddressBook.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-offlineaddressbook", + "redirect_url": "/powershell/module/exchange/set-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-AddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-addresslist", + "redirect_url": "/powershell/module/exchange/update-addresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-EmailAddressPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-emailaddresspolicy", + "redirect_url": "/powershell/module/exchange/update-emailaddresspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-GlobalAddressList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-globaladdresslist", + "redirect_url": "/powershell/module/exchange/update-globaladdresslist", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/email-addresses-and-address-books/Update-OfflineAddressBook.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-offlineaddressbook", + "redirect_url": "/powershell/module/exchange/update-offlineaddressbook", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Enable-ExchangeCertificate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-exchangecertificate", + "redirect_url": "/powershell/module/exchange/enable-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Export-ExchangeCertificate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-exchangecertificate", + "redirect_url": "/powershell/module/exchange/export-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-DataEncryptionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dataencryptionpolicy", + "redirect_url": "/powershell/module/exchange/get-dataencryptionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-ExchangeCertificate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exchangecertificate", + "redirect_url": "/powershell/module/exchange/get-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-IRMConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-irmconfiguration", + "redirect_url": "/powershell/module/exchange/get-irmconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-OMEConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-omeconfiguration", + "redirect_url": "/powershell/module/exchange/get-omeconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-OMEMessageStatus.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-omemessagestatus", + "redirect_url": "/powershell/module/exchange/get-omemessagestatus", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTemplate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-rmstemplate", + "redirect_url": "/powershell/module/exchange/get-rmstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-RMSTrustedPublishingDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Get-SmimeConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-smimeconfig", + "redirect_url": "/powershell/module/exchange/get-smimeconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-ExchangeCertificate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-exchangecertificate", + "redirect_url": "/powershell/module/exchange/import-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Import-RMSTrustedPublishingDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-DataEncryptionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dataencryptionpolicy", + "redirect_url": "/powershell/module/exchange/new-dataencryptionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-ExchangeCertificate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-exchangecertificate", + "redirect_url": "/powershell/module/exchange/new-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/New-OMEConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-omeconfiguration", + "redirect_url": "/powershell/module/exchange/new-omeconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-ExchangeCertificate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-exchangecertificate", + "redirect_url": "/powershell/module/exchange/remove-exchangecertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-OMEConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-omeconfiguration", + "redirect_url": "/powershell/module/exchange/remove-omeconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Remove-RMSTrustedPublishingDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-DataEncryptionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dataencryptionpolicy", + "redirect_url": "/powershell/module/exchange/set-dataencryptionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-IRMConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-irmconfiguration", + "redirect_url": "/powershell/module/exchange/set-irmconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-OMEConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-omeconfiguration", + "redirect_url": "/powershell/module/exchange/set-omeconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-OMEMessageRevocation.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-omemessagerevocation", + "redirect_url": "/powershell/module/exchange/set-omemessagerevocation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTemplate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-rmstemplate", + "redirect_url": "/powershell/module/exchange/set-rmstemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-RMSTrustedPublishingDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-rmstrustedpublishingdomain", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Set-SmimeConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-smimeconfig", + "redirect_url": "/powershell/module/exchange/set-smimeconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/encryption-and-certificates/Test-IRMConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-irmconfiguration", + "redirect_url": "/powershell/module/exchange/test-irmconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Add-FederatedDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-federateddomain", + "redirect_url": "/powershell/module/exchange/add-federateddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Disable-RemoteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-remotemailbox", + "redirect_url": "/powershell/module/exchange/disable-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Enable-RemoteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-remotemailbox", + "redirect_url": "/powershell/module/exchange/enable-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederatedDomainProof.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-federateddomainproof", + "redirect_url": "/powershell/module/exchange/get-federateddomainproof", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederatedOrganizationIdentifier.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-federatedorganizationidentifier", + "redirect_url": "/powershell/module/exchange/get-federatedorganizationidentifier", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederationInformation.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-federationinformation", + "redirect_url": "/powershell/module/exchange/get-federationinformation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-FederationTrust.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-federationtrust", + "redirect_url": "/powershell/module/exchange/get-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-hybridconfiguration", + "redirect_url": "/powershell/module/exchange/get-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridMailflow.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-hybridmailflow", + "redirect_url": "/powershell/module/exchange/get-hybridmailflow", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-HybridMailflowDatacenterIPs.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-hybridmailflowdatacenterips", + "redirect_url": "/powershell/module/exchange/get-hybridmailflowdatacenterips", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-IntraOrganizationConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-intraorganizationconfiguration", + "redirect_url": "/powershell/module/exchange/get-intraorganizationconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-IntraOrganizationConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-intraorganizationconnector", + "redirect_url": "/powershell/module/exchange/get-intraorganizationconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-OnPremisesOrganization.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-onpremisesorganization", + "redirect_url": "/powershell/module/exchange/get-onpremisesorganization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-PendingFederatedDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-pendingfederateddomain", + "redirect_url": "/powershell/module/exchange/get-pendingfederateddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Get-RemoteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-remotemailbox", + "redirect_url": "/powershell/module/exchange/get-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-FederationTrust.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-federationtrust", + "redirect_url": "/powershell/module/exchange/new-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-HybridConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-hybridconfiguration", + "redirect_url": "/powershell/module/exchange/new-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-IntraOrganizationConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-intraorganizationconnector", + "redirect_url": "/powershell/module/exchange/new-intraorganizationconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-OnPremisesOrganization.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-onpremisesorganization", + "redirect_url": "/powershell/module/exchange/new-onpremisesorganization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/New-RemoteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-remotemailbox", + "redirect_url": "/powershell/module/exchange/new-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-FederatedDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-federateddomain", + "redirect_url": "/powershell/module/exchange/remove-federateddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-FederationTrust.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-federationtrust", + "redirect_url": "/powershell/module/exchange/remove-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-HybridConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-hybridconfiguration", + "redirect_url": "/powershell/module/exchange/remove-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-IntraOrganizationConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-intraorganizationconnector", + "redirect_url": "/powershell/module/exchange/remove-intraorganizationconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-OnPremisesOrganization.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-onpremisesorganization", + "redirect_url": "/powershell/module/exchange/remove-onpremisesorganization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Remove-RemoteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-remotemailbox", + "redirect_url": "/powershell/module/exchange/remove-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-FederatedOrganizationIdentifier.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-federatedorganizationidentifier", + "redirect_url": "/powershell/module/exchange/set-federatedorganizationidentifier", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-FederationTrust.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-federationtrust", + "redirect_url": "/powershell/module/exchange/set-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-HybridConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-hybridconfiguration", + "redirect_url": "/powershell/module/exchange/set-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-HybridMailflow.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-hybridmailflow", + "redirect_url": "/powershell/module/exchange/set-hybridmailflow", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-IntraOrganizationConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-intraorganizationconnector", + "redirect_url": "/powershell/module/exchange/set-intraorganizationconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-OnPremisesOrganization.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-onpremisesorganization", + "redirect_url": "/powershell/module/exchange/set-onpremisesorganization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-PendingFederatedDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-pendingfederateddomain", + "redirect_url": "/powershell/module/exchange/set-pendingfederateddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Set-RemoteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-remotemailbox", + "redirect_url": "/powershell/module/exchange/set-remotemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Test-FederationTrust.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-federationtrust", + "redirect_url": "/powershell/module/exchange/test-federationtrust", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Test-FederationTrustCertificate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-federationtrustcertificate", + "redirect_url": "/powershell/module/exchange/test-federationtrustcertificate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Update-HybridConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-hybridconfiguration", + "redirect_url": "/powershell/module/exchange/update-hybridconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/federation-and-hybrid/Update-Recipient.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-recipient", + "redirect_url": "/powershell/module/exchange/update-recipient", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Add-ResubmitRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-resubmitrequest", + "redirect_url": "/powershell/module/exchange/add-resubmitrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Disable-TransportAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-transportagent", + "redirect_url": "/powershell/module/exchange/disable-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Enable-TransportAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-transportagent", + "redirect_url": "/powershell/module/exchange/enable-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Export-Message.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-message", + "redirect_url": "/powershell/module/exchange/export-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-AcceptedDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-accepteddomain", + "redirect_url": "/powershell/module/exchange/get-accepteddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-AddressRewriteEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-addressrewriteentry", + "redirect_url": "/powershell/module/exchange/get-addressrewriteentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-DeliveryAgentConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-deliveryagentconnector", + "redirect_url": "/powershell/module/exchange/get-deliveryagentconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-EdgeSubscription.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-edgesubscription", + "redirect_url": "/powershell/module/exchange/get-edgesubscription", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-EdgeSyncServiceConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-edgesyncserviceconfig", + "redirect_url": "/powershell/module/exchange/get-edgesyncserviceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ForeignConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-foreignconnector", + "redirect_url": "/powershell/module/exchange/get-foreignconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-FrontendTransportService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-frontendtransportservice", + "redirect_url": "/powershell/module/exchange/get-frontendtransportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-InboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-inboundconnector", + "redirect_url": "/powershell/module/exchange/get-inboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MailboxTransportService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxtransportservice", + "redirect_url": "/powershell/module/exchange/get-mailboxtransportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-Message.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-message", + "redirect_url": "/powershell/module/exchange/get-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrace.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-messagetrace", + "redirect_url": "/powershell/module/exchange/get-messagetrace", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTraceDetail.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-messagetracedetail", + "redirect_url": "/powershell/module/exchange/get-messagetracedetail", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrackingLog.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-messagetrackinglog", + "redirect_url": "/powershell/module/exchange/get-messagetrackinglog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-MessageTrackingReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-messagetrackingreport", + "redirect_url": "/powershell/module/exchange/get-messagetrackingreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-NetworkConnectionInfo.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-networkconnectioninfo", + "redirect_url": "/powershell/module/exchange/get-networkconnectioninfo", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-OutboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-outboundconnector", + "redirect_url": "/powershell/module/exchange/get-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-Queue.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-queue", + "redirect_url": "/powershell/module/exchange/get-queue", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-QueueDigest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-queuedigest", + "redirect_url": "/powershell/module/exchange/get-queuedigest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ReceiveConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-receiveconnector", + "redirect_url": "/powershell/module/exchange/get-receiveconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-RemoteDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-remotedomain", + "redirect_url": "/powershell/module/exchange/get-remotedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-ResubmitRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-resubmitrequest", + "redirect_url": "/powershell/module/exchange/get-resubmitrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-RoutingGroupConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-routinggroupconnector", + "redirect_url": "/powershell/module/exchange/get-routinggroupconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-SendConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-sendconnector", + "redirect_url": "/powershell/module/exchange/get-sendconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-SystemMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-systemmessage", + "redirect_url": "/powershell/module/exchange/get-systemmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-transportagent", + "redirect_url": "/powershell/module/exchange/get-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-transportconfig", + "redirect_url": "/powershell/module/exchange/get-transportconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportPipeline.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-transportpipeline", + "redirect_url": "/powershell/module/exchange/get-transportpipeline", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-transportserver", + "redirect_url": "/powershell/module/exchange/get-transportserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-TransportService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-transportservice", + "redirect_url": "/powershell/module/exchange/get-transportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Get-X400AuthoritativeDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-x400authoritativedomain", + "redirect_url": "/powershell/module/exchange/get-x400authoritativedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Install-TransportAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/install-transportagent", + "redirect_url": "/powershell/module/exchange/install-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-AcceptedDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-accepteddomain", + "redirect_url": "/powershell/module/exchange/new-accepteddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-AddressRewriteEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-addressrewriteentry", + "redirect_url": "/powershell/module/exchange/new-addressrewriteentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-DeliveryAgentConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-deliveryagentconnector", + "redirect_url": "/powershell/module/exchange/new-deliveryagentconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-EdgeSubscription.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-edgesubscription", + "redirect_url": "/powershell/module/exchange/new-edgesubscription", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-EdgeSyncServiceConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-edgesyncserviceconfig", + "redirect_url": "/powershell/module/exchange/new-edgesyncserviceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-ForeignConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-foreignconnector", + "redirect_url": "/powershell/module/exchange/new-foreignconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-InboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-inboundconnector", + "redirect_url": "/powershell/module/exchange/new-inboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-OutboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-outboundconnector", + "redirect_url": "/powershell/module/exchange/new-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-ReceiveConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-receiveconnector", + "redirect_url": "/powershell/module/exchange/new-receiveconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-RemoteDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-remotedomain", + "redirect_url": "/powershell/module/exchange/new-remotedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-RoutingGroupConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-routinggroupconnector", + "redirect_url": "/powershell/module/exchange/new-routinggroupconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-SendConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-sendconnector", + "redirect_url": "/powershell/module/exchange/new-sendconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-SystemMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-systemmessage", + "redirect_url": "/powershell/module/exchange/new-systemmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/New-X400AuthoritativeDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-x400authoritativedomain", + "redirect_url": "/powershell/module/exchange/new-x400authoritativedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Redirect-Message.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/redirect-message", + "redirect_url": "/powershell/module/exchange/redirect-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-AcceptedDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-accepteddomain", + "redirect_url": "/powershell/module/exchange/remove-accepteddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-AddressRewriteEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-addressrewriteentry", + "redirect_url": "/powershell/module/exchange/remove-addressrewriteentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-DeliveryAgentConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-deliveryagentconnector", + "redirect_url": "/powershell/module/exchange/remove-deliveryagentconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-EdgeSubscription.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-edgesubscription", + "redirect_url": "/powershell/module/exchange/remove-edgesubscription", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ForeignConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-foreignconnector", + "redirect_url": "/powershell/module/exchange/remove-foreignconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-InboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-inboundconnector", + "redirect_url": "/powershell/module/exchange/remove-inboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-Message.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-message", + "redirect_url": "/powershell/module/exchange/remove-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-OutboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-outboundconnector", + "redirect_url": "/powershell/module/exchange/remove-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ReceiveConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-receiveconnector", + "redirect_url": "/powershell/module/exchange/remove-receiveconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-RemoteDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-remotedomain", + "redirect_url": "/powershell/module/exchange/remove-remotedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-ResubmitRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-resubmitrequest", + "redirect_url": "/powershell/module/exchange/remove-resubmitrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-RoutingGroupConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-routinggroupconnector", + "redirect_url": "/powershell/module/exchange/remove-routinggroupconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-SendConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-sendconnector", + "redirect_url": "/powershell/module/exchange/remove-sendconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-SystemMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-systemmessage", + "redirect_url": "/powershell/module/exchange/remove-systemmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Remove-X400AuthoritativeDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-x400authoritativedomain", + "redirect_url": "/powershell/module/exchange/remove-x400authoritativedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Resume-Message.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-message", + "redirect_url": "/powershell/module/exchange/resume-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Resume-Queue.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-queue", + "redirect_url": "/powershell/module/exchange/resume-queue", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Retry-Queue.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/retry-queue", + "redirect_url": "/powershell/module/exchange/retry-queue", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Search-MessageTrackingReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/search-messagetrackingreport", + "redirect_url": "/powershell/module/exchange/search-messagetrackingreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-AcceptedDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-accepteddomain", + "redirect_url": "/powershell/module/exchange/set-accepteddomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-AddressRewriteEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-addressrewriteentry", + "redirect_url": "/powershell/module/exchange/set-addressrewriteentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-DeliveryAgentConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-deliveryagentconnector", + "redirect_url": "/powershell/module/exchange/set-deliveryagentconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-EdgeSyncServiceConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-edgesyncserviceconfig", + "redirect_url": "/powershell/module/exchange/set-edgesyncserviceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ForeignConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-foreignconnector", + "redirect_url": "/powershell/module/exchange/set-foreignconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-FrontendTransportService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-frontendtransportservice", + "redirect_url": "/powershell/module/exchange/set-frontendtransportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-InboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-inboundconnector", + "redirect_url": "/powershell/module/exchange/set-inboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-MailboxTransportService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxtransportservice", + "redirect_url": "/powershell/module/exchange/set-mailboxtransportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-OutboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-outboundconnector", + "redirect_url": "/powershell/module/exchange/set-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ReceiveConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-receiveconnector", + "redirect_url": "/powershell/module/exchange/set-receiveconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-RemoteDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-remotedomain", + "redirect_url": "/powershell/module/exchange/set-remotedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-ResubmitRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-resubmitrequest", + "redirect_url": "/powershell/module/exchange/set-resubmitrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-RoutingGroupConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-routinggroupconnector", + "redirect_url": "/powershell/module/exchange/set-routinggroupconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-SendConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-sendconnector", + "redirect_url": "/powershell/module/exchange/set-sendconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-SystemMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-systemmessage", + "redirect_url": "/powershell/module/exchange/set-systemmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-transportagent", + "redirect_url": "/powershell/module/exchange/set-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-transportconfig", + "redirect_url": "/powershell/module/exchange/set-transportconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-transportserver", + "redirect_url": "/powershell/module/exchange/set-transportserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-TransportService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-transportservice", + "redirect_url": "/powershell/module/exchange/set-transportservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Set-X400AuthoritativeDomain.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-x400authoritativedomain", + "redirect_url": "/powershell/module/exchange/set-x400authoritativedomain", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Start-EdgeSynchronization.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-edgesynchronization", + "redirect_url": "/powershell/module/exchange/start-edgesynchronization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Start-HistoricalSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-historicalsearch", + "redirect_url": "/powershell/module/exchange/start-historicalsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Stop-HistoricalSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/stop-historicalsearch", + "redirect_url": "/powershell/module/exchange/stop-historicalsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Suspend-Message.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-message", + "redirect_url": "/powershell/module/exchange/suspend-message", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Suspend-Queue.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-queue", + "redirect_url": "/powershell/module/exchange/suspend-queue", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-EdgeSynchronization.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-edgesynchronization", + "redirect_url": "/powershell/module/exchange/test-edgesynchronization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-Mailflow.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-mailflow", + "redirect_url": "/powershell/module/exchange/test-mailflow", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Test-SmtpConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-smtpconnectivity", + "redirect_url": "/powershell/module/exchange/test-smtpconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Uninstall-TransportAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/uninstall-transportagent", + "redirect_url": "/powershell/module/exchange/uninstall-transportagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mail-flow/Validate-OutboundConnector.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/validate-outboundconnector", + "redirect_url": "/powershell/module/exchange/validate-outboundconnector", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Clean-MailboxDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/clean-mailboxdatabase", + "redirect_url": "/powershell/module/exchange/clean-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Disable-MailboxQuarantine.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-mailboxquarantine", + "redirect_url": "/powershell/module/exchange/disable-mailboxquarantine", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Disable-MetaCacheDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-metacachedatabase", + "redirect_url": "/powershell/module/exchange/disable-metacachedatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Dismount-Database.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/dismount-database", + "redirect_url": "/powershell/module/exchange/dismount-database", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Enable-MailboxQuarantine.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-mailboxquarantine", + "redirect_url": "/powershell/module/exchange/enable-mailboxquarantine", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Enable-MetaCacheDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-metacachedatabase", + "redirect_url": "/powershell/module/exchange/enable-metacachedatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-FailedContentIndexDocuments.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-failedcontentindexdocuments", + "redirect_url": "/powershell/module/exchange/get-failedcontentindexdocuments", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxdatabase", + "redirect_url": "/powershell/module/exchange/get-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxRepairRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxrepairrequest", + "redirect_url": "/powershell/module/exchange/get-mailboxrepairrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-MailboxServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxserver", + "redirect_url": "/powershell/module/exchange/get-mailboxserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-SearchDocumentFormat.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-searchdocumentformat", + "redirect_url": "/powershell/module/exchange/get-searchdocumentformat", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Get-StoreUsageStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-storeusagestatistics", + "redirect_url": "/powershell/module/exchange/get-storeusagestatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Mount-Database.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/mount-database", + "redirect_url": "/powershell/module/exchange/mount-database", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Move-DatabasePath.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/move-databasepath", + "redirect_url": "/powershell/module/exchange/move-databasepath", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-MailboxDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailboxdatabase", + "redirect_url": "/powershell/module/exchange/new-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-MailboxRepairRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailboxrepairrequest", + "redirect_url": "/powershell/module/exchange/new-mailboxrepairrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/New-SearchDocumentFormat.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-searchdocumentformat", + "redirect_url": "/powershell/module/exchange/new-searchdocumentformat", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-MailboxDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxdatabase", + "redirect_url": "/powershell/module/exchange/remove-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-MailboxRepairRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxrepairrequest", + "redirect_url": "/powershell/module/exchange/remove-mailboxrepairrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-SearchDocumentFormat.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-searchdocumentformat", + "redirect_url": "/powershell/module/exchange/remove-searchdocumentformat", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Remove-StoreMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-storemailbox", + "redirect_url": "/powershell/module/exchange/remove-storemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-MailboxDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxdatabase", + "redirect_url": "/powershell/module/exchange/set-mailboxdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-MailboxServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxserver", + "redirect_url": "/powershell/module/exchange/set-mailboxserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Set-SearchDocumentFormat.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-searchdocumentformat", + "redirect_url": "/powershell/module/exchange/set-searchdocumentformat", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-AssistantHealth.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-assistanthealth", + "redirect_url": "/powershell/module/exchange/test-assistanthealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-ExchangeSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-exchangesearch", + "redirect_url": "/powershell/module/exchange/test-exchangesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Test-MRSHealth.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-mrshealth", + "redirect_url": "/powershell/module/exchange/test-mrshealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-DatabaseSchema.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-databaseschema", + "redirect_url": "/powershell/module/exchange/update-databaseschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-FileDistributionService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-filedistributionservice", + "redirect_url": "/powershell/module/exchange/update-filedistributionservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailbox-databases-and-servers/Update-StoreMailboxState.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-storemailboxstate", + "redirect_url": "/powershell/module/exchange/update-storemailboxstate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-MailboxFolderPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission", + "redirect_url": "/powershell/module/exchange/add-mailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-MailboxPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-mailboxpermission", + "redirect_url": "/powershell/module/exchange/add-mailboxpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Add-RecipientPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-recipientpermission", + "redirect_url": "/powershell/module/exchange/add-recipientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Connect-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/connect-mailbox", + "redirect_url": "/powershell/module/exchange/connect-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-App.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-app", + "redirect_url": "/powershell/module/exchange/disable-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-InboxRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-inboxrule", + "redirect_url": "/powershell/module/exchange/disable-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-mailbox", + "redirect_url": "/powershell/module/exchange/disable-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-ServiceEmailChannel.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-serviceemailchannel", + "redirect_url": "/powershell/module/exchange/disable-serviceemailchannel", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Disable-SweepRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-sweeprule", + "redirect_url": "/powershell/module/exchange/disable-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-App.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-app", + "redirect_url": "/powershell/module/exchange/enable-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-InboxRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-inboxrule", + "redirect_url": "/powershell/module/exchange/enable-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-mailbox", + "redirect_url": "/powershell/module/exchange/enable-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-ServiceEmailChannel.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-serviceemailchannel", + "redirect_url": "/powershell/module/exchange/enable-serviceemailchannel", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Enable-SweepRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-sweeprule", + "redirect_url": "/powershell/module/exchange/enable-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Export-MailboxDiagnosticLogs.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-mailboxdiagnosticlogs", + "redirect_url": "/powershell/module/exchange/export-mailboxdiagnosticlogs", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Export-RecipientDataProperty.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-recipientdataproperty", + "redirect_url": "/powershell/module/exchange/export-recipientdataproperty", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-App.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-app", + "redirect_url": "/powershell/module/exchange/get-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticAnalysis.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis", + "redirect_url": "/powershell/module/exchange/get-calendardiagnosticanalysis", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticLog.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticlog", + "redirect_url": "/powershell/module/exchange/get-calendardiagnosticlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarDiagnosticObjects.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticobjects", + "redirect_url": "/powershell/module/exchange/get-calendardiagnosticobjects", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarNotification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-calendarnotification", + "redirect_url": "/powershell/module/exchange/get-calendarnotification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-CalendarProcessing.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-calendarprocessing", + "redirect_url": "/powershell/module/exchange/get-calendarprocessing", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Clutter.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-clutter", + "redirect_url": "/powershell/module/exchange/get-clutter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-FocusedInbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-focusedinbox", + "redirect_url": "/powershell/module/exchange/get-focusedinbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-InboxRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-inboxrule", + "redirect_url": "/powershell/module/exchange/get-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailbox", + "redirect_url": "/powershell/module/exchange/get-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxAutoReplyConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxautoreplyconfiguration", + "redirect_url": "/powershell/module/exchange/get-mailboxautoreplyconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxCalendarFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxcalendarfolder", + "redirect_url": "/powershell/module/exchange/get-mailboxcalendarfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxExportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxexportrequest", + "redirect_url": "/powershell/module/exchange/get-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxExportRequestStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxexportrequeststatistics", + "redirect_url": "/powershell/module/exchange/get-mailboxexportrequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolder", + "redirect_url": "/powershell/module/exchange/get-mailboxfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolderPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission", + "redirect_url": "/powershell/module/exchange/get-mailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxFolderStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolderstatistics", + "redirect_url": "/powershell/module/exchange/get-mailboxfolderstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxImportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboximportrequest", + "redirect_url": "/powershell/module/exchange/get-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxImportRequestStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboximportrequeststatistics", + "redirect_url": "/powershell/module/exchange/get-mailboximportrequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxLocation.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxlocation", + "redirect_url": "/powershell/module/exchange/get-mailboxlocation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxpermission", + "redirect_url": "/powershell/module/exchange/get-mailboxpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxPlan.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxplan", + "redirect_url": "/powershell/module/exchange/get-mailboxplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxRestoreRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchange/get-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxRestoreRequestStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxrestorerequeststatistics", + "redirect_url": "/powershell/module/exchange/get-mailboxrestorerequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxSentItemsConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxsentitemsconfiguration", + "redirect_url": "/powershell/module/exchange/get-mailboxsentitemsconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxstatistics", + "redirect_url": "/powershell/module/exchange/get-mailboxstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MailboxUserConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxuserconfiguration", + "redirect_url": "/powershell/module/exchange/get-mailboxuserconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-MessageCategory.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-messagecategory", + "redirect_url": "/powershell/module/exchange/get-messagecategory", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-Place.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-place", + "redirect_url": "/powershell/module/exchange/get-place", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-RecipientPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-recipientpermission", + "redirect_url": "/powershell/module/exchange/get-recipientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-RecoverableItems.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-recoverableitems", + "redirect_url": "/powershell/module/exchange/get-recoverableitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-ResourceConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-resourceconfig", + "redirect_url": "/powershell/module/exchange/get-resourceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-SweepRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-sweeprule", + "redirect_url": "/powershell/module/exchange/get-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Get-UserPhoto.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-userphoto", + "redirect_url": "/powershell/module/exchange/get-userphoto", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-ContactList.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-contactlist", + "redirect_url": "https://support.microsoft.com/office/import-contacts-to-outlook-bb796340-b58a-46c1-90c7-b549b8f3c5f8", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Import-RecipientDataProperty.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-recipientdataproperty", + "redirect_url": "/powershell/module/exchange/import-recipientdataproperty", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-App.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-app", + "redirect_url": "/powershell/module/exchange/new-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-InboxRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-inboxrule", + "redirect_url": "/powershell/module/exchange/new-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailbox", + "redirect_url": "/powershell/module/exchange/new-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxExportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailboxexportrequest", + "redirect_url": "/powershell/module/exchange/new-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailboxfolder", + "redirect_url": "/powershell/module/exchange/new-mailboxfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxImportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailboximportrequest", + "redirect_url": "/powershell/module/exchange/new-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailboxRestoreRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchange/new-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-MailMessage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailmessage", + "redirect_url": "/powershell/module/exchange/new-mailmessage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-SiteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-sitemailbox", + "redirect_url": "/powershell/module/exchange/new-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/New-SweepRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-sweeprule", + "redirect_url": "/powershell/module/exchange/new-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-App.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-app", + "redirect_url": "/powershell/module/exchange/remove-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-CalendarEvents.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-calendarevents", + "redirect_url": "/powershell/module/exchange/remove-calendarevents", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-InboxRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-inboxrule", + "redirect_url": "/powershell/module/exchange/remove-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailbox", + "redirect_url": "/powershell/module/exchange/remove-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxExportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxexportrequest", + "redirect_url": "/powershell/module/exchange/remove-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxFolderPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission", + "redirect_url": "/powershell/module/exchange/remove-mailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxImportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboximportrequest", + "redirect_url": "/powershell/module/exchange/remove-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxpermission", + "redirect_url": "/powershell/module/exchange/remove-mailboxpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxRestoreRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchange/remove-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-MailboxUserConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxuserconfiguration", + "redirect_url": "/powershell/module/exchange/remove-mailboxuserconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-RecipientPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-recipientpermission", + "redirect_url": "/powershell/module/exchange/remove-recipientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-SweepRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-sweeprule", + "redirect_url": "/powershell/module/exchange/remove-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Remove-UserPhoto.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-userphoto", + "redirect_url": "/powershell/module/exchange/remove-userphoto", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Restore-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/restore-mailbox", + "redirect_url": "/powershell/module/exchange/restore-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Restore-RecoverableItems.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/restore-recoverableitems", + "redirect_url": "/powershell/module/exchange/restore-recoverableitems", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxExportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-mailboxexportrequest", + "redirect_url": "/powershell/module/exchange/resume-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxImportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-mailboximportrequest", + "redirect_url": "/powershell/module/exchange/resume-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Resume-MailboxRestoreRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchange/resume-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Search-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/search-mailbox", + "redirect_url": "/powershell/module/exchange/search-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-App.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-app", + "redirect_url": "/powershell/module/exchange/set-app", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-CalendarNotification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-calendarnotification", + "redirect_url": "/powershell/module/exchange/set-calendarnotification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-CalendarProcessing.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-calendarprocessing", + "redirect_url": "/powershell/module/exchange/set-calendarprocessing", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Clutter.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-clutter", + "redirect_url": "/powershell/module/exchange/set-clutter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-FocusedInbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-focusedinbox", + "redirect_url": "/powershell/module/exchange/set-focusedinbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-InboxRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-inboxrule", + "redirect_url": "/powershell/module/exchange/set-inboxrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Mailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailbox", + "redirect_url": "/powershell/module/exchange/set-mailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxAutoReplyConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration", + "redirect_url": "/powershell/module/exchange/set-mailboxautoreplyconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxCalendarFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxcalendarfolder", + "redirect_url": "/powershell/module/exchange/set-mailboxcalendarfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxExportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxexportrequest", + "redirect_url": "/powershell/module/exchange/set-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxFolderPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission", + "redirect_url": "/powershell/module/exchange/set-mailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxImportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboximportrequest", + "redirect_url": "/powershell/module/exchange/set-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxPlan.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxplan", + "redirect_url": "/powershell/module/exchange/set-mailboxplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxRestoreRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchange/set-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-MailboxSentItemsConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxsentitemsconfiguration", + "redirect_url": "/powershell/module/exchange/set-mailboxsentitemsconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-Place.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-place", + "redirect_url": "/powershell/module/exchange/set-place", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-ResourceConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-resourceconfig", + "redirect_url": "/powershell/module/exchange/set-resourceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-SweepRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-sweeprule", + "redirect_url": "/powershell/module/exchange/set-sweeprule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Set-UserPhoto.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-userphoto", + "redirect_url": "/powershell/module/exchange/set-userphoto", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxExportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-mailboxexportrequest", + "redirect_url": "/powershell/module/exchange/suspend-mailboxexportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxImportRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-mailboximportrequest", + "redirect_url": "/powershell/module/exchange/suspend-mailboximportrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Suspend-MailboxRestoreRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-mailboxrestorerequest", + "redirect_url": "/powershell/module/exchange/suspend-mailboxrestorerequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Test-MAPIConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-mapiconnectivity", + "redirect_url": "/powershell/module/exchange/test-mapiconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/mailboxes/Undo-SoftDeletedMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/undo-softdeletedmailbox", + "redirect_url": "/powershell/module/exchange/undo-softdeletedmailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Complete-MigrationBatch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/complete-migrationbatch", + "redirect_url": "/powershell/module/exchange/complete-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Export-MigrationReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-migrationreport", + "redirect_url": "/powershell/module/exchange/export-migrationreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationBatch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-migrationbatch", + "redirect_url": "/powershell/module/exchange/get-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-migrationconfig", + "redirect_url": "/powershell/module/exchange/get-migrationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationEndpoint.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-migrationendpoint", + "redirect_url": "/powershell/module/exchange/get-migrationendpoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-migrationstatistics", + "redirect_url": "/powershell/module/exchange/get-migrationstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-migrationuser", + "redirect_url": "/powershell/module/exchange/get-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MigrationUserStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-migrationuserstatistics", + "redirect_url": "/powershell/module/exchange/get-migrationuserstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-moverequest", + "redirect_url": "/powershell/module/exchange/get-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-MoveRequestStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-moverequeststatistics", + "redirect_url": "/powershell/module/exchange/get-moverequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequest", + "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxmigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMailboxMigrationRequestStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics", + "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchange/get-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMigrationRequestStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermigrationrequeststatistics", + "redirect_url": "/powershell/module/exchange/get-publicfoldermigrationrequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchange/get-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Get-PublicFolderMoveRequestStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermoverequeststatistics", + "redirect_url": "/powershell/module/exchange/get-publicfoldermoverequeststatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MigrationBatch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-migrationbatch", + "redirect_url": "/powershell/module/exchange/new-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MigrationEndpoint.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-migrationendpoint", + "redirect_url": "/powershell/module/exchange/new-migrationendpoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-MoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-moverequest", + "redirect_url": "/powershell/module/exchange/new-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-PublicFolderMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchange/new-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/New-PublicFolderMoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchange/new-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationBatch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-migrationbatch", + "redirect_url": "/powershell/module/exchange/remove-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationEndpoint.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-migrationendpoint", + "redirect_url": "/powershell/module/exchange/remove-migrationendpoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MigrationUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-migrationuser", + "redirect_url": "/powershell/module/exchange/remove-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-MoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-moverequest", + "redirect_url": "/powershell/module/exchange/remove-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest", + "redirect_url": "/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchange/remove-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Remove-PublicFolderMoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchange/remove-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-MoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-moverequest", + "redirect_url": "/powershell/module/exchange/resume-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-PublicFolderMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchange/resume-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Resume-PublicFolderMoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchange/resume-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationBatch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-migrationbatch", + "redirect_url": "/powershell/module/exchange/set-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-migrationconfig", + "redirect_url": "/powershell/module/exchange/set-migrationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationEndpoint.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-migrationendpoint", + "redirect_url": "/powershell/module/exchange/set-migrationendpoint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MigrationUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-migrationuser", + "redirect_url": "/powershell/module/exchange/set-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-MoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-moverequest", + "redirect_url": "/powershell/module/exchange/set-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-PublicFolderMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchange/set-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Set-PublicFolderMoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchange/set-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Start-MigrationBatch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-migrationbatch", + "redirect_url": "/powershell/module/exchange/start-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Start-MigrationUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-migrationuser", + "redirect_url": "/powershell/module/exchange/start-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Stop-MigrationBatch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/stop-migrationbatch", + "redirect_url": "/powershell/module/exchange/stop-migrationbatch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Stop-MigrationUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/stop-migrationuser", + "redirect_url": "/powershell/module/exchange/stop-migrationuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-MoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-moverequest", + "redirect_url": "/powershell/module/exchange/suspend-moverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMailboxMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest", + "redirect_url": "/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMigrationRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-publicfoldermigrationrequest", + "redirect_url": "/powershell/module/exchange/suspend-publicfoldermigrationrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Suspend-PublicFolderMoveRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-publicfoldermoverequest", + "redirect_url": "/powershell/module/exchange/suspend-publicfoldermoverequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/move-and-migration/Test-MigrationServerAvailability.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-migrationserveravailability", + "redirect_url": "/powershell/module/exchange/test-migrationserveravailability", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Disable-CmdletExtensionAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-cmdletextensionagent", + "redirect_url": "/powershell/module/exchange/disable-cmdletextensionagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Enable-CmdletExtensionAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-cmdletextensionagent", + "redirect_url": "/powershell/module/exchange/enable-cmdletextensionagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Enable-OrganizationCustomization.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-organizationcustomization", + "redirect_url": "/powershell/module/exchange/enable-organizationcustomization", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-AccessToCustomerDataRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-accesstocustomerdatarequest", + "redirect_url": "/powershell/module/exchange/get-accesstocustomerdatarequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ApplicationAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchange/get-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-authconfig", + "redirect_url": "/powershell/module/exchange/get-authconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthenticationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-authenticationpolicy", + "redirect_url": "/powershell/module/exchange/get-authenticationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-AuthServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-authserver", + "redirect_url": "/powershell/module/exchange/get-authserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-CmdletExtensionAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-cmdletextensionagent", + "redirect_url": "/powershell/module/exchange/get-cmdletextensionagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeAssistanceConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exchangeassistanceconfig", + "redirect_url": "/powershell/module/exchange/get-exchangeassistanceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeDiagnosticInfo.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exchangediagnosticinfo", + "redirect_url": "/powershell/module/exchange/get-exchangediagnosticinfo", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exchangeserver", + "redirect_url": "/powershell/module/exchange/get-exchangeserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServerAccessLicense.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicense", + "redirect_url": "/powershell/module/exchange/get-exchangeserveraccesslicense", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeServerAccessLicenseUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicenseuser", + "redirect_url": "/powershell/module/exchange/get-exchangeserveraccesslicenseuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-ExchangeSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exchangesettings", + "redirect_url": "/powershell/module/exchange/get-exchangesettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-Notification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-notification", + "redirect_url": "/powershell/module/exchange/get-notification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-OrganizationConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-organizationconfig", + "redirect_url": "/powershell/module/exchange/get-organizationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-PartnerApplication.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-partnerapplication", + "redirect_url": "/powershell/module/exchange/get-partnerapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-PerimeterConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-perimeterconfig", + "redirect_url": "/powershell/module/exchange/get-perimeterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Get-SettingOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-settingoverride", + "redirect_url": "/powershell/module/exchange/get-settingoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-ApplicationAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchange/new-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-AuthenticationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-authenticationpolicy", + "redirect_url": "/powershell/module/exchange/new-authenticationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-AuthServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-authserver", + "redirect_url": "/powershell/module/exchange/new-authserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-ExchangeSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-exchangesettings", + "redirect_url": "/powershell/module/exchange/new-exchangesettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-PartnerApplication.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-partnerapplication", + "redirect_url": "/powershell/module/exchange/new-partnerapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/New-SettingOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-settingoverride", + "redirect_url": "/powershell/module/exchange/new-settingoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-ApplicationAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchange/remove-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-AuthenticationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-authenticationpolicy", + "redirect_url": "/powershell/module/exchange/remove-authenticationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-AuthServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-authserver", + "redirect_url": "/powershell/module/exchange/remove-authserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-PartnerApplication.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-partnerapplication", + "redirect_url": "/powershell/module/exchange/remove-partnerapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Remove-SettingOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-settingoverride", + "redirect_url": "/powershell/module/exchange/remove-settingoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-AccessToCustomerDataRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-accesstocustomerdatarequest", + "redirect_url": "/powershell/module/exchange/set-accesstocustomerdatarequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-ApplicationAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchange/set-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-authconfig", + "redirect_url": "/powershell/module/exchange/set-authconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthenticationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-authenticationpolicy", + "redirect_url": "/powershell/module/exchange/set-authenticationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-AuthServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-authserver", + "redirect_url": "/powershell/module/exchange/set-authserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-CmdletExtensionAgent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-cmdletextensionagent", + "redirect_url": "/powershell/module/exchange/set-cmdletextensionagent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeAssistanceConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-exchangeassistanceconfig", + "redirect_url": "/powershell/module/exchange/set-exchangeassistanceconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-exchangeserver", + "redirect_url": "/powershell/module/exchange/set-exchangeserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-ExchangeSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-exchangesettings", + "redirect_url": "/powershell/module/exchange/set-exchangesettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-Notification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-notification", + "redirect_url": "/powershell/module/exchange/set-notification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-OrganizationConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-organizationconfig", + "redirect_url": "/powershell/module/exchange/set-organizationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-PartnerApplication.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-partnerapplication", + "redirect_url": "/powershell/module/exchange/set-partnerapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-PerimeterConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-perimeterconfig", + "redirect_url": "/powershell/module/exchange/set-perimeterconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Set-SettingOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-settingoverride", + "redirect_url": "/powershell/module/exchange/set-settingoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Test-ApplicationAccessPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-applicationaccesspolicy", + "redirect_url": "/powershell/module/exchange/test-applicationaccesspolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Test-OAuthConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-oauthconnectivity", + "redirect_url": "/powershell/module/exchange/test-oauthconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Test-SystemHealth.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-systemhealth", + "redirect_url": "/powershell/module/exchange/test-systemhealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/organization/Update-ExchangeHelp.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-exchangehelp", + "redirect_url": "/powershell/module/exchange/update-exchangehelp", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-JournalArchiving.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-journalarchiving", + "redirect_url": "/powershell/module/exchange/disable-journalarchiving", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-JournalRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-journalrule", + "redirect_url": "/powershell/module/exchange/disable-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-OutlookProtectionRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-outlookprotectionrule", + "redirect_url": "/powershell/module/exchange/disable-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Disable-TransportRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-transportrule", + "redirect_url": "/powershell/module/exchange/disable-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-JournalRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-journalrule", + "redirect_url": "/powershell/module/exchange/enable-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-OutlookProtectionRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-outlookprotectionrule", + "redirect_url": "/powershell/module/exchange/enable-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Enable-TransportRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-transportrule", + "redirect_url": "/powershell/module/exchange/enable-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Export-JournalRuleCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-journalrulecollection", + "redirect_url": "/powershell/module/exchange/export-journalrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Export-TransportRuleCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-transportrulecollection", + "redirect_url": "/powershell/module/exchange/export-transportrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-ActivityAlert.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-activityalert", + "redirect_url": "/powershell/module/exchange/get-activityalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-AdministrativeUnit.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-administrativeunit", + "redirect_url": "/powershell/module/exchange/get-administrativeunit", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierPoliciesApplicationStatus.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus", + "redirect_url": "/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierpolicy", + "redirect_url": "/powershell/module/exchange/get-informationbarrierpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-InformationBarrierRecipientStatus.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierrecipientstatus", + "redirect_url": "/powershell/module/exchange/get-informationbarrierrecipientstatus", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-JournalRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-journalrule", + "redirect_url": "/powershell/module/exchange/get-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-Label.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-label", + "redirect_url": "/powershell/module/exchange/get-label", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-LabelPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-labelpolicy", + "redirect_url": "/powershell/module/exchange/get-labelpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-MessageClassification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-messageclassification", + "redirect_url": "/powershell/module/exchange/get-messageclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-OrganizationSegment.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-organizationsegment", + "redirect_url": "/powershell/module/exchange/get-organizationsegment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-OutlookProtectionRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-outlookprotectionrule", + "redirect_url": "/powershell/module/exchange/get-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-ProtectionAlert.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-protectionalert", + "redirect_url": "/powershell/module/exchange/get-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-SupervisoryReviewPolicyV2.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyv2", + "redirect_url": "/powershell/module/exchange/get-supervisoryreviewpolicyv2", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-SupervisoryReviewRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewrule", + "redirect_url": "/powershell/module/exchange/get-supervisoryreviewrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-transportrule", + "redirect_url": "/powershell/module/exchange/get-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRuleAction.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-transportruleaction", + "redirect_url": "/powershell/module/exchange/get-transportruleaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Get-TransportRulePredicate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-transportrulepredicate", + "redirect_url": "/powershell/module/exchange/get-transportrulepredicate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Import-JournalRuleCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-journalrulecollection", + "redirect_url": "/powershell/module/exchange/import-journalrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Import-TransportRuleCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-transportrulecollection", + "redirect_url": "/powershell/module/exchange/import-transportrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Install-UnifiedCompliancePrerequisite.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/install-unifiedcomplianceprerequisite", + "redirect_url": "/powershell/module/exchange/install-unifiedcomplianceprerequisite", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-ActivityAlert.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-activityalert", + "redirect_url": "/powershell/module/exchange/new-activityalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-InformationBarrierPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy", + "redirect_url": "/powershell/module/exchange/new-informationbarrierpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-JournalRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-journalrule", + "redirect_url": "/powershell/module/exchange/new-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-Label.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-label", + "redirect_url": "/powershell/module/exchange/new-label", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-LabelPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-labelpolicy", + "redirect_url": "/powershell/module/exchange/new-labelpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-MessageClassification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-messageclassification", + "redirect_url": "/powershell/module/exchange/new-messageclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-OrganizationSegment.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-organizationsegment", + "redirect_url": "/powershell/module/exchange/new-organizationsegment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-OutlookProtectionRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-outlookprotectionrule", + "redirect_url": "/powershell/module/exchange/new-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-ProtectionAlert.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-protectionalert", + "redirect_url": "/powershell/module/exchange/new-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-SupervisoryReviewPolicyV2.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-supervisoryreviewpolicyv2", + "redirect_url": "/powershell/module/exchange/new-supervisoryreviewpolicyv2", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-SupervisoryReviewRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-supervisoryreviewrule", + "redirect_url": "/powershell/module/exchange/new-supervisoryreviewrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/New-TransportRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-transportrule", + "redirect_url": "/powershell/module/exchange/new-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-ActivityAlert.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-activityalert", + "redirect_url": "/powershell/module/exchange/remove-activityalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-InformationBarrierPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-informationbarrierpolicy", + "redirect_url": "/powershell/module/exchange/remove-informationbarrierpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-JournalRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-journalrule", + "redirect_url": "/powershell/module/exchange/remove-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-Label.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-label", + "redirect_url": "/powershell/module/exchange/remove-label", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-LabelPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-labelpolicy", + "redirect_url": "/powershell/module/exchange/remove-labelpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-MessageClassification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-messageclassification", + "redirect_url": "/powershell/module/exchange/remove-messageclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-OrganizationSegment.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-organizationsegment", + "redirect_url": "/powershell/module/exchange/remove-organizationsegment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-OutlookProtectionRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-outlookprotectionrule", + "redirect_url": "/powershell/module/exchange/remove-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-ProtectionAlert.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-protectionalert", + "redirect_url": "/powershell/module/exchange/remove-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-SupervisoryReviewPolicyV2.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-supervisoryreviewpolicyv2", + "redirect_url": "/powershell/module/exchange/remove-supervisoryreviewpolicyv2", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Remove-TransportRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-transportrule", + "redirect_url": "/powershell/module/exchange/remove-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-ActivityAlert.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-activityalert", + "redirect_url": "/powershell/module/exchange/set-activityalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-InformationBarrierPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-informationbarrierpolicy", + "redirect_url": "/powershell/module/exchange/set-informationbarrierpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-JournalRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-journalrule", + "redirect_url": "/powershell/module/exchange/set-journalrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-Label.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-label", + "redirect_url": "/powershell/module/exchange/set-label", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-LabelPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-labelpolicy", + "redirect_url": "/powershell/module/exchange/set-labelpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-MessageClassification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-messageclassification", + "redirect_url": "/powershell/module/exchange/set-messageclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-OrganizationSegment.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-organizationsegment", + "redirect_url": "/powershell/module/exchange/set-organizationsegment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-OutlookProtectionRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-outlookprotectionrule", + "redirect_url": "/powershell/module/exchange/set-outlookprotectionrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-ProtectionAlert.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-protectionalert", + "redirect_url": "/powershell/module/exchange/set-protectionalert", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-SupervisoryReviewPolicyV2.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-supervisoryreviewpolicyv2", + "redirect_url": "/powershell/module/exchange/set-supervisoryreviewpolicyv2", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-SupervisoryReviewRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-supervisoryreviewrule", + "redirect_url": "/powershell/module/exchange/set-supervisoryreviewrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Set-TransportRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-transportrule", + "redirect_url": "/powershell/module/exchange/set-transportrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Start-InformationBarrierPoliciesApplication.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-informationbarrierpoliciesapplication", + "redirect_url": "/powershell/module/exchange/start-informationbarrierpoliciesapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Stop-InformationBarrierPoliciesApplication.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication", + "redirect_url": "/powershell/module/exchange/stop-informationbarrierpoliciesapplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance/Test-ArchiveConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-archiveconnectivity", + "redirect_url": "/powershell/module/exchange/test-archiveconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AdminAuditLogConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-adminauditlogconfig", + "redirect_url": "/powershell/module/exchange/get-adminauditlogconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-auditconfig", + "redirect_url": "/powershell/module/exchange/get-auditconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfigurationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-auditconfigurationpolicy", + "redirect_url": "/powershell/module/exchange/get-auditconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditConfigurationRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-auditconfigurationrule", + "redirect_url": "/powershell/module/exchange/get-auditconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-AuditLogSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-auditlogsearch", + "redirect_url": "/powershell/module/exchange/get-auditlogsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-MailboxAuditBypassAssociation.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxauditbypassassociation", + "redirect_url": "/powershell/module/exchange/get-mailboxauditbypassassociation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Get-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-unifiedauditlogretentionpolicy", + "redirect_url": "/powershell/module/exchange/get-unifiedauditlogretentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AdminAuditLogSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-adminauditlogsearch", + "redirect_url": "/powershell/module/exchange/new-adminauditlogsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AuditConfigurationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-auditconfigurationpolicy", + "redirect_url": "/powershell/module/exchange/new-auditconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-AuditConfigurationRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-auditconfigurationrule", + "redirect_url": "/powershell/module/exchange/new-auditconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-MailboxAuditLogSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailboxauditlogsearch", + "redirect_url": "/powershell/module/exchange/new-mailboxauditlogsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/New-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-unifiedauditlogretentionpolicy", + "redirect_url": "/powershell/module/exchange/new-unifiedauditlogretentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-AuditConfigurationPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-auditconfigurationpolicy", + "redirect_url": "/powershell/module/exchange/remove-auditconfigurationpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-AuditConfigurationRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-auditconfigurationrule", + "redirect_url": "/powershell/module/exchange/remove-auditconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Remove-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-unifiedauditlogretentionpolicy", + "redirect_url": "/powershell/module/exchange/remove-unifiedauditlogretentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-AdminAuditLog.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/search-adminauditlog", + "redirect_url": "/powershell/module/exchange/search-adminauditlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-MailboxAuditLog.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/search-mailboxauditlog", + "redirect_url": "/powershell/module/exchange/search-mailboxauditlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Search-UnifiedAuditLog.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/search-unifiedauditlog", + "redirect_url": "/powershell/module/exchange/search-unifiedauditlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AdminAuditLogConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-adminauditlogconfig", + "redirect_url": "/powershell/module/exchange/set-adminauditlogconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AuditConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-auditconfig", + "redirect_url": "/powershell/module/exchange/set-auditconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-AuditConfigurationRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-auditconfigurationrule", + "redirect_url": "/powershell/module/exchange/set-auditconfigurationrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-MailboxAuditBypassAssociation.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation", + "redirect_url": "/powershell/module/exchange/set-mailboxauditbypassassociation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Set-UnifiedAuditLogRetentionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-unifiedauditlogretentionpolicy", + "redirect_url": "/powershell/module/exchange/set-unifiedauditlogretentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-audit/Write-AdminAuditLog.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/write-adminauditlog", + "redirect_url": "/powershell/module/exchange/write-adminauditlog", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-compliancesearch", + "redirect_url": "/powershell/module/exchange/get-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSearchAction.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-compliancesearchaction", + "redirect_url": "/powershell/module/exchange/get-compliancesearchaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-ComplianceSecurityFilter.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-compliancesecurityfilter", + "redirect_url": "/powershell/module/exchange/get-compliancesecurityfilter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Get-MailboxSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxsearch", + "redirect_url": "/powershell/module/exchange/get-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Invoke-ComplianceSearchActionStep.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/invoke-compliancesearchactionstep", + "redirect_url": "/powershell/module/exchange/invoke-compliancesearchactionstep", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-compliancesearch", + "redirect_url": "/powershell/module/exchange/new-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-compliancesearchaction", + "redirect_url": "/powershell/module/exchange/new-compliancesearchaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-ComplianceSecurityFilter.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-compliancesecurityfilter", + "redirect_url": "/powershell/module/exchange/new-compliancesecurityfilter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/New-MailboxSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailboxsearch", + "redirect_url": "/powershell/module/exchange/new-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-compliancesearch", + "redirect_url": "/powershell/module/exchange/remove-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSearchAction.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-compliancesearchaction", + "redirect_url": "/powershell/module/exchange/remove-compliancesearchaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-ComplianceSecurityFilter.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-compliancesecurityfilter", + "redirect_url": "/powershell/module/exchange/remove-compliancesecurityfilter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Remove-MailboxSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailboxsearch", + "redirect_url": "/powershell/module/exchange/remove-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-compliancesearch", + "redirect_url": "/powershell/module/exchange/set-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSearchAction.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-compliancesearchaction", + "redirect_url": "/powershell/module/exchange/set-compliancesearchaction", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-ComplianceSecurityFilter.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-compliancesecurityfilter", + "redirect_url": "/powershell/module/exchange/set-compliancesecurityfilter", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Set-MailboxSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailboxsearch", + "redirect_url": "/powershell/module/exchange/set-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Start-ComplianceSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-compliancesearch", + "redirect_url": "/powershell/module/exchange/start-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Start-MailboxSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-mailboxsearch", + "redirect_url": "/powershell/module/exchange/start-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Stop-ComplianceSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/stop-compliancesearch", + "redirect_url": "/powershell/module/exchange/stop-compliancesearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-content-search/Stop-MailboxSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/stop-mailboxsearch", + "redirect_url": "/powershell/module/exchange/stop-mailboxsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Export-DlpPolicyCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-dlppolicycollection", + "redirect_url": "/powershell/module/exchange/export-dlppolicycollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-ClassificationRuleCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-classificationrulecollection", + "redirect_url": "/powershell/module/exchange/get-classificationrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DataClassification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dataclassification", + "redirect_url": "/powershell/module/exchange/get-dataclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DataClassificationConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dataclassificationconfig", + "redirect_url": "/powershell/module/exchange/get-dataclassificationconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancepolicy", + "redirect_url": "/powershell/module/exchange/get-dlpcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancerule", + "redirect_url": "/powershell/module/exchange/get-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpDetailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpdetailreport", + "redirect_url": "/powershell/module/exchange/get-dlpdetailreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpDetectionsReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport", + "redirect_url": "/powershell/module/exchange/get-dlpdetectionsreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpEdmSchema.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpedmschema", + "redirect_url": "/powershell/module/exchange/get-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpKeywordDictionary.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpkeyworddictionary", + "redirect_url": "/powershell/module/exchange/get-dlpkeyworddictionary", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlppolicy", + "redirect_url": "/powershell/module/exchange/get-dlppolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpPolicyTemplate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlppolicytemplate", + "redirect_url": "/powershell/module/exchange/get-dlppolicytemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationType.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype", + "redirect_url": "/powershell/module/exchange/get-dlpsensitiveinformationtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtyperulepackage", + "redirect_url": "/powershell/module/exchange/get-dlpsensitiveinformationtyperulepackage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-DlpSiDetectionsReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dlpsidetectionsreport", + "redirect_url": "/powershell/module/exchange/get-dlpsidetectionsreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Get-PolicyTipConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-policytipconfig", + "redirect_url": "/powershell/module/exchange/get-policytipconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Import-DlpPolicyCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-dlppolicycollection", + "redirect_url": "/powershell/module/exchange/import-dlppolicycollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Import-DlpPolicyTemplate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-dlppolicytemplate", + "redirect_url": "/powershell/module/exchange/import-dlppolicytemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-ClassificationRuleCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-classificationrulecollection", + "redirect_url": "/powershell/module/exchange/new-classificationrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DataClassification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dataclassification", + "redirect_url": "/powershell/module/exchange/new-dataclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpcompliancepolicy", + "redirect_url": "/powershell/module/exchange/new-dlpcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpcompliancerule", + "redirect_url": "/powershell/module/exchange/new-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpEdmSchema.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpedmschema", + "redirect_url": "/powershell/module/exchange/new-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpFingerprint.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpfingerprint", + "redirect_url": "/powershell/module/exchange/new-dlpfingerprint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpKeywordDictionary.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpkeyworddictionary", + "redirect_url": "/powershell/module/exchange/new-dlpkeyworddictionary", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlppolicy", + "redirect_url": "/powershell/module/exchange/new-dlppolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationType.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype", + "redirect_url": "/powershell/module/exchange/new-dlpsensitiveinformationtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage", + "redirect_url": "/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-Fingerprint.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-fingerprint", + "redirect_url": "/powershell/module/exchange/new-fingerprint", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/New-PolicyTipConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-policytipconfig", + "redirect_url": "/powershell/module/exchange/new-policytipconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-ClassificationRuleCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-classificationrulecollection", + "redirect_url": "/powershell/module/exchange/remove-classificationrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DataClassification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dataclassification", + "redirect_url": "/powershell/module/exchange/remove-dataclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancepolicy", + "redirect_url": "/powershell/module/exchange/remove-dlpcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule", + "redirect_url": "/powershell/module/exchange/remove-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpEdmSchema.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlpedmschema", + "redirect_url": "/powershell/module/exchange/remove-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpKeywordDictionary.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlpkeyworddictionary", + "redirect_url": "/powershell/module/exchange/remove-dlpkeyworddictionary", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlppolicy", + "redirect_url": "/powershell/module/exchange/remove-dlppolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpPolicyTemplate.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlppolicytemplate", + "redirect_url": "/powershell/module/exchange/remove-dlppolicytemplate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationType.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype", + "redirect_url": "/powershell/module/exchange/remove-dlpsensitiveinformationtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage", + "redirect_url": "/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Remove-PolicyTipConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-policytipconfig", + "redirect_url": "/powershell/module/exchange/remove-policytipconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-ClassificationRuleCollection.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-classificationrulecollection", + "redirect_url": "/powershell/module/exchange/set-classificationrulecollection", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DataClassification.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dataclassification", + "redirect_url": "/powershell/module/exchange/set-dataclassification", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancepolicy", + "redirect_url": "/powershell/module/exchange/set-dlpcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancerule", + "redirect_url": "/powershell/module/exchange/set-dlpcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpEdmSchema.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dlpedmschema", + "redirect_url": "/powershell/module/exchange/set-dlpedmschema", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpKeywordDictionary.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dlpkeyworddictionary", + "redirect_url": "/powershell/module/exchange/set-dlpkeyworddictionary", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dlppolicy", + "redirect_url": "/powershell/module/exchange/set-dlppolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationType.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype", + "redirect_url": "/powershell/module/exchange/set-dlpsensitiveinformationtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-DlpSensitiveInformationTypeRulePackage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtyperulepackage", + "redirect_url": "/powershell/module/exchange/set-dlpsensitiveinformationtyperulepackage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-dlp/Set-PolicyTipConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-policytipconfig", + "redirect_url": "/powershell/module/exchange/set-policytipconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Add-ComplianceCaseMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-compliancecasemember", + "redirect_url": "/powershell/module/exchange/add-compliancecasemember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Add-eDiscoveryCaseAdmin.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-ediscoverycaseadmin", + "redirect_url": "/powershell/module/exchange/add-ediscoverycaseadmin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-CaseHoldPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-caseholdpolicy", + "redirect_url": "/powershell/module/exchange/get-caseholdpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-CaseHoldRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-caseholdrule", + "redirect_url": "/powershell/module/exchange/get-caseholdrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-ComplianceCase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-compliancecase", + "redirect_url": "/powershell/module/exchange/get-compliancecase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-ComplianceCaseMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-compliancecasemember", + "redirect_url": "/powershell/module/exchange/get-compliancecasemember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Get-eDiscoveryCaseAdmin.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ediscoverycaseadmin", + "redirect_url": "/powershell/module/exchange/get-ediscoverycaseadmin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-CaseHoldPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-caseholdpolicy", + "redirect_url": "/powershell/module/exchange/new-caseholdpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-CaseHoldRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-caseholdrule", + "redirect_url": "/powershell/module/exchange/new-caseholdrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/New-ComplianceCase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-compliancecase", + "redirect_url": "/powershell/module/exchange/new-compliancecase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-caseholdpolicy", + "redirect_url": "/powershell/module/exchange/remove-caseholdpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-CaseHoldRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-caseholdrule", + "redirect_url": "/powershell/module/exchange/remove-caseholdrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-compliancecase", + "redirect_url": "/powershell/module/exchange/remove-compliancecase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-ComplianceCaseMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-compliancecasemember", + "redirect_url": "/powershell/module/exchange/remove-compliancecasemember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Remove-eDiscoveryCaseAdmin.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-ediscoverycaseadmin", + "redirect_url": "/powershell/module/exchange/remove-ediscoverycaseadmin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-CaseHoldPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-caseholdpolicy", + "redirect_url": "/powershell/module/exchange/set-caseholdpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-CaseHoldRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-caseholdrule", + "redirect_url": "/powershell/module/exchange/set-caseholdrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Set-ComplianceCase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-compliancecase", + "redirect_url": "/powershell/module/exchange/set-compliancecase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Update-ComplianceCaseMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-compliancecasemember", + "redirect_url": "/powershell/module/exchange/update-compliancecasemember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-ediscovery/Update-eDiscoveryCaseAdmin.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-ediscoverycaseadmin", + "redirect_url": "/powershell/module/exchange/update-ediscoverycaseadmin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Enable-ComplianceTagStorage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-compliancetagstorage", + "redirect_url": "/powershell/module/exchange/enable-compliancetagstorage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEvent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-complianceretentionevent", + "redirect_url": "/powershell/module/exchange/get-complianceretentionevent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceRetentionEventType.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-complianceretentioneventtype", + "redirect_url": "/powershell/module/exchange/get-complianceretentioneventtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceTag.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-compliancetag", + "redirect_url": "/powershell/module/exchange/get-compliancetag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ComplianceTagStorage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-compliancetagstorage", + "redirect_url": "/powershell/module/exchange/get-compliancetagstorage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-DataRetentionReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dataretentionreport", + "redirect_url": "/powershell/module/exchange/get-dataretentionreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-HoldCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-holdcompliancepolicy", + "redirect_url": "/powershell/module/exchange/get-holdcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-HoldComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-holdcompliancerule", + "redirect_url": "/powershell/module/exchange/get-holdcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedContentSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-managedcontentsettings", + "redirect_url": "/powershell/module/exchange/get-managedcontentsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-managedfolder", + "redirect_url": "/powershell/module/exchange/get-managedfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-ManagedFolderMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-managedfoldermailboxpolicy", + "redirect_url": "/powershell/module/exchange/get-managedfoldermailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchange/get-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancerule", + "redirect_url": "/powershell/module/exchange/get-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionEvent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-retentionevent", + "redirect_url": "/powershell/module/exchange/get-retentionevent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-retentionpolicy", + "redirect_url": "/powershell/module/exchange/get-retentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Get-RetentionPolicyTag.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-retentionpolicytag", + "redirect_url": "/powershell/module/exchange/get-retentionpolicytag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceRetentionEvent.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-complianceretentionevent", + "redirect_url": "/powershell/module/exchange/new-complianceretentionevent", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceRetentionEventType.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-complianceretentioneventtype", + "redirect_url": "/powershell/module/exchange/new-complianceretentioneventtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ComplianceTag.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-compliancetag", + "redirect_url": "/powershell/module/exchange/new-compliancetag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-HoldCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-holdcompliancepolicy", + "redirect_url": "/powershell/module/exchange/new-holdcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-HoldComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-holdcompliancerule", + "redirect_url": "/powershell/module/exchange/new-holdcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedContentSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-managedcontentsettings", + "redirect_url": "/powershell/module/exchange/new-managedcontentsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-managedfolder", + "redirect_url": "/powershell/module/exchange/new-managedfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-ManagedFolderMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-managedfoldermailboxpolicy", + "redirect_url": "/powershell/module/exchange/new-managedfoldermailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchange/new-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancerule", + "redirect_url": "/powershell/module/exchange/new-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-retentionpolicy", + "redirect_url": "/powershell/module/exchange/new-retentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/New-RetentionPolicyTag.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-retentionpolicytag", + "redirect_url": "/powershell/module/exchange/new-retentionpolicytag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ComplianceRetentionEventType.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-complianceretentioneventtype", + "redirect_url": "/powershell/module/exchange/remove-complianceretentioneventtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ComplianceTag.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-compliancetag", + "redirect_url": "/powershell/module/exchange/remove-compliancetag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-HoldCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-holdcompliancepolicy", + "redirect_url": "/powershell/module/exchange/remove-holdcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-HoldComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-holdcompliancerule", + "redirect_url": "/powershell/module/exchange/remove-holdcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedContentSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-managedcontentsettings", + "redirect_url": "/powershell/module/exchange/remove-managedcontentsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-managedfolder", + "redirect_url": "/powershell/module/exchange/remove-managedfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-ManagedFolderMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-managedfoldermailboxpolicy", + "redirect_url": "/powershell/module/exchange/remove-managedfoldermailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchange/remove-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule", + "redirect_url": "/powershell/module/exchange/remove-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-retentionpolicy", + "redirect_url": "/powershell/module/exchange/remove-retentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Remove-RetentionPolicyTag.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-retentionpolicytag", + "redirect_url": "/powershell/module/exchange/remove-retentionpolicytag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ComplianceRetentionEventType.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-complianceretentioneventtype", + "redirect_url": "/powershell/module/exchange/set-complianceretentioneventtype", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ComplianceTag.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-compliancetag", + "redirect_url": "/powershell/module/exchange/set-compliancetag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-HoldCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-holdcompliancepolicy", + "redirect_url": "/powershell/module/exchange/set-holdcompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-HoldComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-holdcompliancerule", + "redirect_url": "/powershell/module/exchange/set-holdcompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedContentSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-managedcontentsettings", + "redirect_url": "/powershell/module/exchange/set-managedcontentsettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-managedfolder", + "redirect_url": "/powershell/module/exchange/set-managedfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-ManagedFolderMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-managedfoldermailboxpolicy", + "redirect_url": "/powershell/module/exchange/set-managedfoldermailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionCompliancePolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-retentioncompliancepolicy", + "redirect_url": "/powershell/module/exchange/set-retentioncompliancepolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionComplianceRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-retentioncompliancerule", + "redirect_url": "/powershell/module/exchange/set-retentioncompliancerule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-retentionpolicy", + "redirect_url": "/powershell/module/exchange/set-retentionpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Set-RetentionPolicyTag.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-retentionpolicytag", + "redirect_url": "/powershell/module/exchange/set-retentionpolicytag", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Start-ManagedFolderAssistant.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-managedfolderassistant", + "redirect_url": "/powershell/module/exchange/start-managedfolderassistant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Start-RetentionAutoTagLearning.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/start-retentionautotaglearning", + "redirect_url": "/powershell/module/exchange/start-retentionautotaglearning", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Stop-ManagedFolderAssistant.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/stop-managedfolderassistant", + "redirect_url": "/powershell/module/exchange/stop-managedfolderassistant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/policy-and-compliance-retention/Validate-RetentionRuleQuery.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/validate-retentionrulequery", + "redirect_url": "/powershell/module/exchange/validate-retentionrulequery", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Connect-ExchangeOnline.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/connect-exchangeonline", + "redirect_url": "/powershell/module/exchange/connect-exchangeonline", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOCasMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exocasmailbox", + "redirect_url": "/powershell/module/exchange/get-exocasmailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exomailbox", + "redirect_url": "/powershell/module/exchange/get-exomailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxFolderPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission", + "redirect_url": "/powershell/module/exchange/get-exomailboxfolderpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxFolderStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics", + "redirect_url": "/powershell/module/exchange/get-exomailboxfolderstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exomailboxpermission", + "redirect_url": "/powershell/module/exchange/get-exomailboxpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMailboxStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exomailboxstatistics", + "redirect_url": "/powershell/module/exchange/get-exomailboxstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXOMobileDeviceStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics", + "redirect_url": "/powershell/module/exchange/get-exomobiledevicestatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXORecipient.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exorecipient", + "redirect_url": "/powershell/module/exchange/get-exorecipient", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/powershell-v2-module/Get-EXORecipientPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-exorecipientpermission", + "redirect_url": "/powershell/module/exchange/get-exorecipientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-ConnectionByClientTypeDetailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-connectionbyclienttypedetailreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-ConnectionByClientTypeReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-connectionbyclienttypereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsActiveUserReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csactiveuserreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsAVConferenceTimeReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csavconferencetimereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsClientDeviceDetailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csclientdevicedetailreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsClientDeviceReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csclientdevicereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsConferenceReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csconferencereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsP2PAVTimeReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csp2pavtimereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsP2PSessionReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csp2psessionreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsPSTNConferenceTimeReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-cspstnconferencetimereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsPSTNUsageDetailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-cspstnusagedetailreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsUserActivitiesReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csuseractivitiesreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-CsUsersBlockedReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-csusersblockedreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-GroupActivityReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-groupactivityreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-HistoricalSearch.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-historicalsearch", + "redirect_url": "/powershell/module/exchange/get-historicalsearch", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-LicenseVsUsageSummaryReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-licensevsusagesummaryreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-LogonStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-logonstatistics", + "redirect_url": "/powershell/module/exchange/get-logonstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxActivityReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxactivityreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxUsageDetailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxusagedetailreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailboxUsageReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailboxusagereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailDlpPolicyReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-maildetaildlppolicyreport", + "redirect_url": "/powershell/module/exchange/get-maildetaildlppolicyreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailMalwareReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-maildetailmalwarereport", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailSpamReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-maildetailspamreport", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailDetailTransportRuleReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-maildetailtransportrulereport", + "redirect_url": "/powershell/module/exchange/get-maildetailtransportrulereport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailFilterListReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailfilterlistreport", + "redirect_url": "/powershell/module/exchange/get-mailfilterlistreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficPolicyReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficpolicyreport", + "redirect_url": "/powershell/module/exchange/get-mailtrafficpolicyreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficreport", + "redirect_url": "/powershell/module/exchange/get-mailtrafficreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficSummaryReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficsummaryreport", + "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MailTrafficTopReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailtraffictopreport", + "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-MxRecordReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mxrecordreport", + "redirect_url": "/powershell/module/exchange/get-mxrecordreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientBrowserDetailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-o365clientbrowserdetailreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientBrowserReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-o365clientbrowserreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientOSDetailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-o365clientosdetailreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-O365ClientOSReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-o365clientosreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-OutboundConnectorReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-outboundconnectorreport", + "redirect_url": "/powershell/module/exchange/get-outboundconnectorreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-RecipientStatisticsReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-recipientstatisticsreport", + "redirect_url": "/powershell/module/exchange/get-recipientstatisticsreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-ReportExecutionInstance.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-reportexecutioninstance", + "redirect_url": "/powershell/module/exchange/get-reportexecutioninstance", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SCInsights.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-scinsights", + "redirect_url": "/powershell/module/exchange/get-scinsights", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-ServiceDeliveryReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-servicedeliveryreport", + "redirect_url": "/powershell/module/exchange/get-servicedeliveryreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOActiveUserReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-spoactiveuserreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOSkyDriveProDeployedReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-sposkydriveprodeployedreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOSkyDriveProStorageReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-sposkydriveprostoragereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTeamSiteDeployedReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-spoteamsitedeployedreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTeamSiteStorageReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-spoteamsitestoragereport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SPOTenantStorageMetricReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-spotenantstoragemetricreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-StaleMailboxDetailReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-stalemailboxdetailreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-StaleMailboxReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-stalemailboxreport", + "redirect_url": "/graph/api/resources/report", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewActivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewactivity", + "redirect_url": "/powershell/module/exchange/get-supervisoryreviewactivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewOverallProgressReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewoverallprogressreport", + "redirect_url": "/powershell/module/exchange/get-supervisoryreviewoverallprogressreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewPolicyReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyreport", + "redirect_url": "/powershell/module/exchange/get-supervisoryreviewpolicyreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewreport", + "redirect_url": "/powershell/module/exchange/get-supervisoryreviewreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-SupervisoryReviewTopCasesReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewtopcasesreport", + "redirect_url": "/powershell/module/exchange/get-supervisoryreviewtopcasesreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-TenantAnalyticsConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-tenantanalyticsconfig", + "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Get-UserAnalyticsConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-useranalyticsconfig", + "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Set-TenantAnalyticsConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-tenantanalyticsconfig", + "redirect_url": "/powershell/module/exchange/myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/reporting/Set-UserAnalyticsConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-useranalyticsconfig", + "redirect_url": "/powershell/module/exchange/myanalyticsfeatureconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Add-ManagementRoleEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-managementroleentry", + "redirect_url": "/powershell/module/exchange/add-managementroleentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Add-RoleGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-rolegroupmember", + "redirect_url": "/powershell/module/exchange/add-rolegroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRole.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-managementrole", + "redirect_url": "/powershell/module/exchange/get-managementrole", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRoleAssignment.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-managementroleassignment", + "redirect_url": "/powershell/module/exchange/get-managementroleassignment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementRoleEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-managementroleentry", + "redirect_url": "/powershell/module/exchange/get-managementroleentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-ManagementScope.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-managementscope", + "redirect_url": "/powershell/module/exchange/get-managementscope", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleAssignmentPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-roleassignmentpolicy", + "redirect_url": "/powershell/module/exchange/get-roleassignmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-rolegroup", + "redirect_url": "/powershell/module/exchange/get-rolegroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Get-RoleGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-rolegroupmember", + "redirect_url": "/powershell/module/exchange/get-rolegroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementRole.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-managementrole", + "redirect_url": "/powershell/module/exchange/new-managementrole", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementRoleAssignment.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-managementroleassignment", + "redirect_url": "/powershell/module/exchange/new-managementroleassignment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-ManagementScope.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-managementscope", + "redirect_url": "/powershell/module/exchange/new-managementscope", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-RoleAssignmentPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-roleassignmentpolicy", + "redirect_url": "/powershell/module/exchange/new-roleassignmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/New-RoleGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-rolegroup", + "redirect_url": "/powershell/module/exchange/new-rolegroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRole.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-managementrole", + "redirect_url": "/powershell/module/exchange/remove-managementrole", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRoleAssignment.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-managementroleassignment", + "redirect_url": "/powershell/module/exchange/remove-managementroleassignment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementRoleEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-managementroleentry", + "redirect_url": "/powershell/module/exchange/remove-managementroleentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-ManagementScope.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-managementscope", + "redirect_url": "/powershell/module/exchange/remove-managementscope", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleAssignmentPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-roleassignmentpolicy", + "redirect_url": "/powershell/module/exchange/remove-roleassignmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-rolegroup", + "redirect_url": "/powershell/module/exchange/remove-rolegroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Remove-RoleGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-rolegroupmember", + "redirect_url": "/powershell/module/exchange/remove-rolegroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementRoleAssignment.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-managementroleassignment", + "redirect_url": "/powershell/module/exchange/set-managementroleassignment", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementRoleEntry.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-managementroleentry", + "redirect_url": "/powershell/module/exchange/set-managementroleentry", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-ManagementScope.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-managementscope", + "redirect_url": "/powershell/module/exchange/set-managementscope", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-RoleAssignmentPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-roleassignmentpolicy", + "redirect_url": "/powershell/module/exchange/set-roleassignmentpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Set-RoleGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-rolegroup", + "redirect_url": "/powershell/module/exchange/set-rolegroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/role-based-access-control/Update-RoleGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-rolegroupmember", + "redirect_url": "/powershell/module/exchange/update-rolegroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Add-GlobalMonitoringOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-globalmonitoringoverride", + "redirect_url": "/powershell/module/exchange/add-globalmonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Add-ServerMonitoringOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-servermonitoringoverride", + "redirect_url": "/powershell/module/exchange/add-servermonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-AvailabilityReportOutage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-availabilityreportoutage", + "redirect_url": "/powershell/module/exchange/get-availabilityreportoutage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-EventLogLevel.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-eventloglevel", + "redirect_url": "/powershell/module/exchange/get-eventloglevel", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-GlobalMonitoringOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-globalmonitoringoverride", + "redirect_url": "/powershell/module/exchange/get-globalmonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-HealthReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-healthreport", + "redirect_url": "/powershell/module/exchange/get-healthreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-MonitoringItemHelp.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-monitoringitemhelp", + "redirect_url": "/powershell/module/exchange/get-monitoringitemhelp", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-MonitoringItemIdentity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-monitoringitemidentity", + "redirect_url": "/powershell/module/exchange/get-monitoringitemidentity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerComponentState.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-servercomponentstate", + "redirect_url": "/powershell/module/exchange/get-servercomponentstate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerHealth.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-serverhealth", + "redirect_url": "/powershell/module/exchange/get-serverhealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ServerMonitoringOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-servermonitoringoverride", + "redirect_url": "/powershell/module/exchange/get-servermonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ThrottlingPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-throttlingpolicy", + "redirect_url": "/powershell/module/exchange/get-throttlingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Get-ThrottlingPolicyAssociation.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-throttlingpolicyassociation", + "redirect_url": "/powershell/module/exchange/get-throttlingpolicyassociation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Invoke-MonitoringProbe.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/invoke-monitoringprobe", + "redirect_url": "/powershell/module/exchange/invoke-monitoringprobe", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/New-AvailabilityReportOutage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-availabilityreportoutage", + "redirect_url": "/powershell/module/exchange/new-availabilityreportoutage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/New-ThrottlingPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-throttlingpolicy", + "redirect_url": "/powershell/module/exchange/new-throttlingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-AvailabilityReportOutage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-availabilityreportoutage", + "redirect_url": "/powershell/module/exchange/remove-availabilityreportoutage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-GlobalMonitoringOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-globalmonitoringoverride", + "redirect_url": "/powershell/module/exchange/remove-globalmonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-ServerMonitoringOverride.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-servermonitoringoverride", + "redirect_url": "/powershell/module/exchange/remove-servermonitoringoverride", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Remove-ThrottlingPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-throttlingpolicy", + "redirect_url": "/powershell/module/exchange/remove-throttlingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-AvailabilityReportOutage.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-availabilityreportoutage", + "redirect_url": "/powershell/module/exchange/set-availabilityreportoutage", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-EventLogLevel.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-eventloglevel", + "redirect_url": "/powershell/module/exchange/set-eventloglevel", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ServerComponentState.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-servercomponentstate", + "redirect_url": "/powershell/module/exchange/set-servercomponentstate", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ServerMonitor.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-servermonitor", + "redirect_url": "/powershell/module/exchange/set-servermonitor", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ThrottlingPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-throttlingpolicy", + "redirect_url": "/powershell/module/exchange/set-throttlingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Set-ThrottlingPolicyAssociation.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-throttlingpolicyassociation", + "redirect_url": "/powershell/module/exchange/set-throttlingpolicyassociation", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/server-health-and-performance/Test-ServiceHealth.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-servicehealth", + "redirect_url": "/powershell/module/exchange/test-servicehealth", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-AvailabilityAddressSpace.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-availabilityaddressspace", + "redirect_url": "/powershell/module/exchange/add-availabilityaddressspace", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-PublicFolderAdministrativePermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-publicfolderadministrativepermission", + "redirect_url": "/powershell/module/exchange/add-publicfolderadministrativepermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Add-PublicFolderClientPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-publicfolderclientpermission", + "redirect_url": "/powershell/module/exchange/add-publicfolderclientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Disable-MailPublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-mailpublicfolder", + "redirect_url": "/powershell/module/exchange/disable-mailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Enable-MailPublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-mailpublicfolder", + "redirect_url": "/powershell/module/exchange/enable-mailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-AvailabilityAddressSpace.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-availabilityaddressspace", + "redirect_url": "/powershell/module/exchange/get-availabilityaddressspace", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-AvailabilityConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-availabilityconfig", + "redirect_url": "/powershell/module/exchange/get-availabilityconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-MailPublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailpublicfolder", + "redirect_url": "/powershell/module/exchange/get-mailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-OrganizationRelationship.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-organizationrelationship", + "redirect_url": "/powershell/module/exchange/get-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfolder", + "redirect_url": "/powershell/module/exchange/get-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderAdministrativePermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfolderadministrativepermission", + "redirect_url": "/powershell/module/exchange/get-publicfolderadministrativepermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderClientPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfolderclientpermission", + "redirect_url": "/powershell/module/exchange/get-publicfolderclientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfolderdatabase", + "redirect_url": "/powershell/module/exchange/get-publicfolderdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderItemStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfolderitemstatistics", + "redirect_url": "/powershell/module/exchange/get-publicfolderitemstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderMailboxDiagnostics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxdiagnostics", + "redirect_url": "/powershell/module/exchange/get-publicfoldermailboxdiagnostics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-PublicFolderStatistics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-publicfolderstatistics", + "redirect_url": "/powershell/module/exchange/get-publicfolderstatistics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SharingPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-sharingpolicy", + "redirect_url": "/powershell/module/exchange/get-sharingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-sitemailbox", + "redirect_url": "/powershell/module/exchange/get-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailboxDiagnostics.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-sitemailboxdiagnostics", + "redirect_url": "/powershell/module/exchange/get-sitemailboxdiagnostics", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Get-SiteMailboxProvisioningPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-sitemailboxprovisioningpolicy", + "redirect_url": "/powershell/module/exchange/get-sitemailboxprovisioningpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-AvailabilityConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-availabilityconfig", + "redirect_url": "/powershell/module/exchange/new-availabilityconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-OrganizationRelationship.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-organizationrelationship", + "redirect_url": "/powershell/module/exchange/new-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-publicfolder", + "redirect_url": "/powershell/module/exchange/new-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolderDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-publicfolderdatabase", + "redirect_url": "/powershell/module/exchange/new-publicfolderdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-PublicFolderDatabaseRepairRequest.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-publicfolderdatabaserepairrequest", + "redirect_url": "/powershell/module/exchange/new-publicfolderdatabaserepairrequest", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SharingPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-sharingpolicy", + "redirect_url": "/powershell/module/exchange/new-sharingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SiteMailboxProvisioningPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-sitemailboxprovisioningpolicy", + "redirect_url": "/powershell/module/exchange/new-sitemailboxprovisioningpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/New-SyncMailPublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-syncmailpublicfolder", + "redirect_url": "/powershell/module/exchange/new-syncmailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-AvailabilityAddressSpace.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-availabilityaddressspace", + "redirect_url": "/powershell/module/exchange/remove-availabilityaddressspace", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-AvailabilityConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-availabilityconfig", + "redirect_url": "/powershell/module/exchange/remove-availabilityconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-OrganizationRelationship.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-organizationrelationship", + "redirect_url": "/powershell/module/exchange/remove-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-publicfolder", + "redirect_url": "/powershell/module/exchange/remove-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderAdministrativePermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-publicfolderadministrativepermission", + "redirect_url": "/powershell/module/exchange/remove-publicfolderadministrativepermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderClientPermission.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-publicfolderclientpermission", + "redirect_url": "/powershell/module/exchange/remove-publicfolderclientpermission", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-PublicFolderDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-publicfolderdatabase", + "redirect_url": "/powershell/module/exchange/remove-publicfolderdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SharingPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-sharingpolicy", + "redirect_url": "/powershell/module/exchange/remove-sharingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SiteMailboxProvisioningPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-sitemailboxprovisioningpolicy", + "redirect_url": "/powershell/module/exchange/remove-sitemailboxprovisioningpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Remove-SyncMailPublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-syncmailpublicfolder", + "redirect_url": "/powershell/module/exchange/remove-syncmailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Resume-PublicFolderReplication.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/resume-publicfolderreplication", + "redirect_url": "/powershell/module/exchange/resume-publicfolderreplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-AvailabilityConfig.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-availabilityconfig", + "redirect_url": "/powershell/module/exchange/set-availabilityconfig", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-MailPublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailpublicfolder", + "redirect_url": "/powershell/module/exchange/set-mailpublicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-OrganizationRelationship.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-organizationrelationship", + "redirect_url": "/powershell/module/exchange/set-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-PublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-publicfolder", + "redirect_url": "/powershell/module/exchange/set-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-PublicFolderDatabase.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-publicfolderdatabase", + "redirect_url": "/powershell/module/exchange/set-publicfolderdatabase", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SharingPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-sharingpolicy", + "redirect_url": "/powershell/module/exchange/set-sharingpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SiteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-sitemailbox", + "redirect_url": "/powershell/module/exchange/set-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Set-SiteMailboxProvisioningPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-sitemailboxprovisioningpolicy", + "redirect_url": "/powershell/module/exchange/set-sitemailboxprovisioningpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Suspend-PublicFolderReplication.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/suspend-publicfolderreplication", + "redirect_url": "/powershell/module/exchange/suspend-publicfolderreplication", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Test-OrganizationRelationship.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-organizationrelationship", + "redirect_url": "/powershell/module/exchange/test-organizationrelationship", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Test-SiteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-sitemailbox", + "redirect_url": "/powershell/module/exchange/test-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolder.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-publicfolder", + "redirect_url": "/powershell/module/exchange/update-publicfolder", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolderHierarchy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-publicfolderhierarchy", + "redirect_url": "/powershell/module/exchange/update-publicfolderhierarchy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-PublicFolderMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-publicfoldermailbox", + "redirect_url": "/powershell/module/exchange/update-publicfoldermailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/sharing-and-collaboration/Update-SiteMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-sitemailbox", + "redirect_url": "/powershell/module/exchange/update-sitemailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMAutoAttendant.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-umautoattendant", + "redirect_url": "/powershell/module/exchange/disable-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMCallAnsweringRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-umcallansweringrule", + "redirect_url": "/powershell/module/exchange/disable-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMIPGateway.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-umipgateway", + "redirect_url": "/powershell/module/exchange/disable-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-ummailbox", + "redirect_url": "/powershell/module/exchange/disable-ummailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-umserver", + "redirect_url": "/powershell/module/exchange/disable-umserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Disable-UMService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-umservice", + "redirect_url": "/powershell/module/exchange/disable-umservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMAutoAttendant.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-umautoattendant", + "redirect_url": "/powershell/module/exchange/enable-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMCallAnsweringRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-umcallansweringrule", + "redirect_url": "/powershell/module/exchange/enable-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMIPGateway.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-umipgateway", + "redirect_url": "/powershell/module/exchange/enable-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-ummailbox", + "redirect_url": "/powershell/module/exchange/enable-ummailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-umserver", + "redirect_url": "/powershell/module/exchange/enable-umserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Enable-UMService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-umservice", + "redirect_url": "/powershell/module/exchange/enable-umservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Export-UMCallDataRecord.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-umcalldatarecord", + "redirect_url": "/powershell/module/exchange/export-umcalldatarecord", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Export-UMPrompt.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/export-umprompt", + "redirect_url": "/powershell/module/exchange/export-umprompt", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-OnlineMeetingConfiguration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-onlinemeetingconfiguration", + "redirect_url": "/powershell/module/exchange/get-onlinemeetingconfiguration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMActiveCalls.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umactivecalls", + "redirect_url": "/powershell/module/exchange/get-umactivecalls", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMAutoAttendant.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umautoattendant", + "redirect_url": "/powershell/module/exchange/get-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallAnsweringRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umcallansweringrule", + "redirect_url": "/powershell/module/exchange/get-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallDataRecord.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umcalldatarecord", + "redirect_url": "/powershell/module/exchange/get-umcalldatarecord", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallRouterSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umcallroutersettings", + "redirect_url": "/powershell/module/exchange/get-umcallroutersettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMCallSummaryReport.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umcallsummaryreport", + "redirect_url": "/powershell/module/exchange/get-umcallsummaryreport", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMDialPlan.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umdialplan", + "redirect_url": "/powershell/module/exchange/get-umdialplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMHuntGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umhuntgroup", + "redirect_url": "/powershell/module/exchange/get-umhuntgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMIPGateway.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umipgateway", + "redirect_url": "/powershell/module/exchange/get-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ummailbox", + "redirect_url": "/powershell/module/exchange/get-ummailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailboxPIN.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ummailboxpin", + "redirect_url": "/powershell/module/exchange/get-ummailboxpin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-ummailboxpolicy", + "redirect_url": "/powershell/module/exchange/get-ummailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UmServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umserver", + "redirect_url": "/powershell/module/exchange/get-umserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Get-UMService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-umservice", + "redirect_url": "/powershell/module/exchange/get-umservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Import-UMPrompt.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/import-umprompt", + "redirect_url": "/powershell/module/exchange/import-umprompt", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMAutoAttendant.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-umautoattendant", + "redirect_url": "/powershell/module/exchange/new-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMCallAnsweringRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-umcallansweringrule", + "redirect_url": "/powershell/module/exchange/new-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMDialPlan.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-umdialplan", + "redirect_url": "/powershell/module/exchange/new-umdialplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMHuntGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-umhuntgroup", + "redirect_url": "/powershell/module/exchange/new-umhuntgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMIPGateway.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-umipgateway", + "redirect_url": "/powershell/module/exchange/new-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/New-UMMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-ummailboxpolicy", + "redirect_url": "/powershell/module/exchange/new-ummailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMAutoAttendant.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-umautoattendant", + "redirect_url": "/powershell/module/exchange/remove-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMCallAnsweringRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-umcallansweringrule", + "redirect_url": "/powershell/module/exchange/remove-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMDialPlan.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-umdialplan", + "redirect_url": "/powershell/module/exchange/remove-umdialplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMHuntGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-umhuntgroup", + "redirect_url": "/powershell/module/exchange/remove-umhuntgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMIPGateway.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-umipgateway", + "redirect_url": "/powershell/module/exchange/remove-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Remove-UMMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-ummailboxpolicy", + "redirect_url": "/powershell/module/exchange/remove-ummailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMAutoAttendant.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-umautoattendant", + "redirect_url": "/powershell/module/exchange/set-umautoattendant", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMCallAnsweringRule.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-umcallansweringrule", + "redirect_url": "/powershell/module/exchange/set-umcallansweringrule", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMCallRouterSettings.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-umcallroutersettings", + "redirect_url": "/powershell/module/exchange/set-umcallroutersettings", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMDialPlan.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-umdialplan", + "redirect_url": "/powershell/module/exchange/set-umdialplan", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMIPGateway.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-umipgateway", + "redirect_url": "/powershell/module/exchange/set-umipgateway", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailbox.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ummailbox", + "redirect_url": "/powershell/module/exchange/set-ummailbox", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailboxPIN.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ummailboxpin", + "redirect_url": "/powershell/module/exchange/set-ummailboxpin", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMMailboxPolicy.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-ummailboxpolicy", + "redirect_url": "/powershell/module/exchange/set-ummailboxpolicy", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UmServer.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-umserver", + "redirect_url": "/powershell/module/exchange/set-umserver", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Set-UMService.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-umservice", + "redirect_url": "/powershell/module/exchange/set-umservice", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/unified-messaging/Test-UMConnectivity.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/test-umconnectivity", + "redirect_url": "/powershell/module/exchange/test-umconnectivity", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Add-DistributionGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-distributiongroupmember", + "redirect_url": "/powershell/module/exchange/add-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Add-UnifiedGroupLinks.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/add-unifiedgrouplinks", + "redirect_url": "/powershell/module/exchange/add-unifiedgrouplinks", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-DistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-distributiongroup", + "redirect_url": "/powershell/module/exchange/disable-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-MailContact.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-mailcontact", + "redirect_url": "/powershell/module/exchange/disable-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Disable-MailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/disable-mailuser", + "redirect_url": "/powershell/module/exchange/disable-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-DistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-distributiongroup", + "redirect_url": "/powershell/module/exchange/enable-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-MailContact.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-mailcontact", + "redirect_url": "/powershell/module/exchange/enable-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Enable-MailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/enable-mailuser", + "redirect_url": "/powershell/module/exchange/enable-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Contact.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-contact", + "redirect_url": "/powershell/module/exchange/get-contact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-distributiongroup", + "redirect_url": "/powershell/module/exchange/get-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DistributionGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-distributiongroupmember", + "redirect_url": "/powershell/module/exchange/get-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-DynamicDistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroup", + "redirect_url": "/powershell/module/exchange/get-dynamicdistributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-EligibleDistributionGroupForMigration.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-eligibledistributiongroupformigration", + "redirect_url": "/powershell/module/exchange/get-eligibledistributiongroupformigration", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Group.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-group", + "redirect_url": "/powershell/module/exchange/get-group", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-LinkedUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-linkeduser", + "redirect_url": "/powershell/module/exchange/get-linkeduser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-MailContact.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailcontact", + "redirect_url": "/powershell/module/exchange/get-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-MailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-mailuser", + "redirect_url": "/powershell/module/exchange/get-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-Recipient.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-recipient", + "redirect_url": "/powershell/module/exchange/get-recipient", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-SecurityPrincipal.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-securityprincipal", + "redirect_url": "/powershell/module/exchange/get-securityprincipal", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-UnifiedGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-unifiedgroup", + "redirect_url": "/powershell/module/exchange/get-unifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-UnifiedGroupLinks.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-unifiedgrouplinks", + "redirect_url": "/powershell/module/exchange/get-unifiedgrouplinks", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Get-User.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/get-user", + "redirect_url": "/powershell/module/exchange/get-user", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-DistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-distributiongroup", + "redirect_url": "/powershell/module/exchange/new-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-DynamicDistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-dynamicdistributiongroup", + "redirect_url": "/powershell/module/exchange/new-dynamicdistributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPDistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-eopdistributiongroup", + "redirect_url": "/powershell/module/exchange/new-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-EOPMailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-eopmailuser", + "redirect_url": "/powershell/module/exchange/new-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-MailContact.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailcontact", + "redirect_url": "/powershell/module/exchange/new-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-MailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-mailuser", + "redirect_url": "/powershell/module/exchange/new-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/New-UnifiedGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/new-unifiedgroup", + "redirect_url": "/powershell/module/exchange/new-unifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-distributiongroup", + "redirect_url": "/powershell/module/exchange/remove-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DistributionGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-distributiongroupmember", + "redirect_url": "/powershell/module/exchange/remove-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-DynamicDistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-dynamicdistributiongroup", + "redirect_url": "/powershell/module/exchange/remove-dynamicdistributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPDistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-eopdistributiongroup", + "redirect_url": "/powershell/module/exchange/remove-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-EOPMailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-eopmailuser", + "redirect_url": "/powershell/module/exchange/remove-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-MailContact.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailcontact", + "redirect_url": "/powershell/module/exchange/remove-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-MailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-mailuser", + "redirect_url": "/powershell/module/exchange/remove-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-UnifiedGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-unifiedgroup", + "redirect_url": "/powershell/module/exchange/remove-unifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Remove-UnifiedGroupLinks.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/remove-unifiedgrouplinks", + "redirect_url": "/powershell/module/exchange/remove-unifiedgrouplinks", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-Contact.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-contact", + "redirect_url": "/powershell/module/exchange/set-contact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-DistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-distributiongroup", + "redirect_url": "/powershell/module/exchange/set-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-DynamicDistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-dynamicdistributiongroup", + "redirect_url": "/powershell/module/exchange/set-dynamicdistributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPDistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-eopdistributiongroup", + "redirect_url": "/powershell/module/exchange/set-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-eopgroup", + "redirect_url": "/powershell/module/exchange/set-group", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPMailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-eopmailuser", + "redirect_url": "/powershell/module/exchange/set-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-EOPUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-eopuser", + "redirect_url": "/powershell/module/exchange/set-user", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-Group.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-group", + "redirect_url": "/powershell/module/exchange/set-group", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-LinkedUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-linkeduser", + "redirect_url": "/powershell/module/exchange/set-linkeduser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-MailContact.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailcontact", + "redirect_url": "/powershell/module/exchange/set-mailcontact", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-MailUser.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-mailuser", + "redirect_url": "/powershell/module/exchange/set-mailuser", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-UnifiedGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-unifiedgroup", + "redirect_url": "/powershell/module/exchange/set-unifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Set-User.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/set-user", + "redirect_url": "/powershell/module/exchange/set-user", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Undo-SoftDeletedUnifiedGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/undo-softdeletedunifiedgroup", + "redirect_url": "/powershell/module/exchange/undo-softdeletedunifiedgroup", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-DistributionGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-distributiongroupmember", + "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Update-EOPDistributionGroupMember.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/update-eopdistributiongroupmember", + "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", "redirect_document_id": false }, { "source_path": "exchange/virtual-folder/exchange/users-and-groups/Upgrade-DistributionGroup.md", - "redirect_url": "https://docs.microsoft.com/powershell/module/exchange/upgrade-distributiongroup", + "redirect_url": "/powershell/module/exchange/upgrade-distributiongroup", "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/office-365-scc/office-365-scc-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/scc-powershell", + "redirect_url": "/powershell/exchange/scc-powershell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/connect-to-scc-powershell", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/office-365-scc/connect-to-scc-powershell/mfa-connect-to-scc-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/connect-to-scc-powershell", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/connect-to-exchange-servers-using-remote-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/connect-to-exchange-servers-using-remote-powershell", + "redirect_url": "/powershell/exchange/connect-to-exchange-servers-using-remote-powershell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-server/control-remote-powershell-access-to-exchange-servers.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/control-remote-powershell-access-to-exchange-servers", + "redirect_url": "/powershell/exchange/control-remote-powershell-access-to-exchange-servers", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-server/exchange-cmdlet-syntax.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax", + "redirect_url": "/powershell/exchange/exchange-cmdlet-syntax", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-server/exchange-management-shell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/exchange-management-shell", + "redirect_url": "/powershell/exchange/exchange-management-shell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-server/find-exchange-cmdlet-permissions.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions", + "redirect_url": "/powershell/exchange/find-exchange-cmdlet-permissions", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-server/open-the-exchange-management-shell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/open-the-exchange-management-shell", + "redirect_url": "/powershell/exchange/open-the-exchange-management-shell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-server/use-update-exchangehelp.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/use-update-exchangehelp", - "redirect_document_id": true + "redirect_url": "/powershell/exchange/exchange-management-shell", + "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/filter-properties.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/filter-properties", + "redirect_url": "/powershell/exchange/filter-properties", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/recipient-filters.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/recipient-filters", + "redirect_url": "/powershell/exchange/recipient-filters", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-server/recipient-filters/recipientfilter-properties.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/recipientfilter-properties", + "redirect_url": "/powershell/exchange/recipientfilter-properties", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-online/disable-access-to-exchange-online-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/disable-access-to-exchange-online-powershell", + "redirect_url": "/powershell/exchange/disable-access-to-exchange-online-powershell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/exchange-online-powershell", + "redirect_url": "/powershell/exchange/exchange-online-powershell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-online/connect-to-exchange-online-powershell/mfa-connect-to-exchange-online-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/app-only-auth-powershell-v2.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/app-only-auth-powershell-v2", + "redirect_url": "/powershell/exchange/app-only-auth-powershell-v2", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/cmdlet-property-sets.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets", + "redirect_url": "/powershell/exchange/cmdlet-property-sets", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2", + "redirect_url": "/powershell/exchange/exchange-online-powershell-v2", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-online/exchange-online-powershell-v2/filters-v2.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/filters-v2", + "redirect_url": "/powershell/exchange/filters-v2", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-eop/connect-to-exchange-online-protection-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-protection-powershell", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-protection-powershell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/exchange-eop/exchange-online-protection-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/exchange-online-protection-powershell", + "redirect_url": "/powershell/exchange/exchange-online-protection-powershell", "redirect_document_id": true }, { "source_path": "exchange/docs-conceptual/mfa-connect-to-exchange-online-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", "redirect_document_id": false }, { "source_path": "exchange/docs-conceptual/mfa-connect-to-scc-powershell.md", - "redirect_url": "https://docs.microsoft.com/powershell/exchange/connect-to-scc-powershell", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-TenantAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-TenantAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchange/set-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UserAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchange/get-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-UserAnalyticsConfig.md", + "redirect_url": "/powershell/module/exchange/set-myanalyticsfeatureconfig", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailMalwareReport.md", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailDetailSpamReport.md", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionTrafficReport.md", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-UrlTrace.md", + "redirect_url": "/powershell/module/exchange/get-safelinksaggregatereport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficReport.md", + "redirect_url": "/powershell/module/exchange/get-maildetailatpreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-ContactList.md", + "redirect_url": "https://support.microsoft.com/office/import-contacts-to-outlook-bb796340-b58a-46c1-90c7-b549b8f3c5f8", + "redirect_document_id": false + }, + { + "source_path": "staffhub/docs-conceptual/index.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/docs-conceptual/intro.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/docs-conceptual/overview.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubMember.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubShift.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Add-StaffHubTeam.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Connect-StaffHub.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubMember.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubShifts.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubTeamsForTenant.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Get-StaffHubUsersForTenant.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubMember.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubShift.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Import-StaffHubTeam.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Remove-StaffHubMember.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/Remove-StaffHubUser.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "staffhub/staffhub-ps/staffhub/staffhub.md", + "redirect_url": "/microsoftteams/expand-teams-across-your-org/shifts-for-teams-landing-page", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Import-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-RMSTrustedPublishingDomain.md", + "redirect_url": "/powershell/module/exchange/#encryption-and-certificates", + "redirect_document_id": false + }, + { + "source_path": "teams/docs-conceptual/intro.md", + "redirect_url": "/powershell/teams", + "redirect_document_id": false + }, + { + "source_path": "spmt/spmt-ps/spmt/spmt.md", + "redirect_url": "/powershell/module/spmt", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CustomNudge.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CustomNudgeAssignment.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CustomNudgeSettings.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-CustomNudge.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-CustomNudgeAssignment.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CustomNudge.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-CustomNudgeAssignment.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CustomNudge.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeAssignment.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-CustomNudgeSettings.md", + "redirect_url": "/powershell/module/exchange/", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailTrafficTopReport.md", + "redirect_url": "/powershell/module/exchange/get-mailtrafficsummaryreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PhishFilterPolicy.md", + "redirect_url": "/powershell/module/exchange/get-tenantallowblocklistspoofitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PhishFilterPolicy.md", + "redirect_url": "/powershell/module/exchange/set-tenantallowblocklistspoofitems", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-protection-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-exchange-online-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchange/new-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-EOPMailUser.md", + "redirect_url": "/powershell/module/exchange/new-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchange/remove-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-EOPMailUser.md", + "redirect_url": "/powershell/module/exchange/remove-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPDistributionGroup.md", + "redirect_url": "/powershell/module/exchange/set-distributiongroup", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPGroup.md", + "redirect_url": "/powershell/module/exchange/set-group", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPMailUser.md", + "redirect_url": "/powershell/module/exchange/set-mailuser", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-EOPUser.md", + "redirect_url": "/powershell/module/exchange/set-user", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Update-EOPDistributionGroupMember.md", + "redirect_url": "/powershell/module/exchange/update-distributiongroupmember", + "redirect_document_id": false + }, + { + "source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.yml", + "redirect_url": "https://review.learn.microsoft.com/en-us/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/use-update-exchangehelp.md", + "redirect_url": "/powershell/exchange/exchange-management-shell", + "redirect_document_id": false + }, + { + "source_path": "exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md", + "redirect_url": "/powershell/exchange/connect-to-scc-powershell", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionDocumentDetail.md", + "redirect_url": "/powershell/module/exchange/get-contentmalwaremdodetailreport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AdvancedThreatProtectionDocumentReport.md", + "redirect_url": "/powershell/module/exchange/get-contentmalwaremdoaggregatereport", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-SecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchange/new-exosecopsoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-SecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchange/remove-exosecopsoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-SecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchange/set-exosecopsoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-PhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchange/new-exophishsimoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-PhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchange/remove-exophishsimoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-PhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchange/set-exophishsimoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ConnectionByClientTypeDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ConnectionByClientTypeReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsActiveUserReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsAVConferenceTimeReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsClientDeviceDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsClientDeviceReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsConferenceReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsP2PAVTimeReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsP2PSessionReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsPSTNConferenceTimeReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsPSTNUsageDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsUserActivitiesReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-CsUsersBlockedReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-GroupActivityReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, { + "source_path": "exchange/virtual-folder/exchange/Get-LicenseVsUsageSummaryReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxActivityReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxUsageDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-MailboxUsageReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, { + "source_path": "exchange/virtual-folder/exchange/Get-O365ClientBrowserDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-O365ClientBrowserReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-O365ClientOSDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-O365ClientOSReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SPOActiveUserReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SPOSkyDriveProDeployedReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SPOSkyDriveProStorageReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SPOTeamSiteDeployedReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SPOTeamSiteStorageReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SPOTenantStorageMetricReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-StaleMailboxDetailReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-StaleMailboxReport.md", + "redirect_url": "/graph/api/resources/report", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-HybridMailflow.md", + "redirect_url": "/exchange/exchange-hybrid", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-HybridMailflow.md", + "redirect_url": "/exchange/exchange-hybrid", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-PhishSimOverrideRule.md", + "redirect_url": "/powershell/module/exchange/get-exophishsimoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-SecOpsOverrideRule.md", + "redirect_url": "/powershell/module/exchange/get-exosecopsoverriderule", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-VivaFeatureCategory.md", + "redirect_url": "/viva/feature-access-management", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuditConfigurationPolicy.md", + "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-AuditConfigurationRule.md", + "redirect_url": "/powershell/module/exchange/set-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Get-ActivityAlert.md", + "redirect_url": "/powershell/module/exchange/get-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/New-ActivityAlert.md", + "redirect_url": "/powershell/module/exchange/new-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-ActivityAlert.md", + "redirect_url": "/powershell/module/exchange/remove-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Set-ActivityAlert.md", + "redirect_url": "/powershell/module/exchange/set-protectionalert", + "redirect_document_id": false + }, + { + "source_path": "exchange/virtual-folder/exchange/Remove-RecordLabel.md", + "redirect_url": "/powershell/module/exchange/remove-label", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/teams/Disable-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/teams/Enable-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/Export-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/export-csonlineaudiofile.md", + "redirect_url": "/powershell/module/teams/export-csonlineaudiofile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Find-CsGroup.md", + "redirect_url": "/powershell/module/teams/Find-CsGroup", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Find-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Find-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsApplicationMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantStatus.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantSupportedLanguage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantSupportedTimeZone", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/teams/Get-CsAutoAttendantTenantInformation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/Get-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsCallQueue.md", + "redirect_url": "/powershell/module/teams/Get-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Get-CsEffectiveTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/Get-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/teams/Get-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsMeetingMigrationStatus.md", + "redirect_url": "/powershell/module/teams/Get-CsMeetingMigrationStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationInstanceAssociationStatus.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineApplicationInstanceAssociationStatus", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingBridge", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingLanguagesSupported.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingLanguagesSupported", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialinConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialinConferencingTenantConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialinConferencingTenantConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialInConferencingUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialOutPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDialOutPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenant.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineDirectoryTenant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlinePstnUsage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineSipDomain.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineSipDomain", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineTelephoneNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineUser.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoicemailUserSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/teams/Get-CsOnlineVoiceUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsClientConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsEducationAssignmentsAppPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestCallingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsGuestMessagingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBroadcastConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/teams/Get-CsTeamsVideoInteropServicePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenant.md", + "redirect_url": "/powershell/module/teams/Get-CsTenant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantBlockedCallingNumbers", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantFederationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantLicensingConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantLicensingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantMigrationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/teams/Get-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/teams/Get-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/Grant-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsCloudMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsCloudMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsDialoutPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsDialoutPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsExternalUserCommunicationPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTeamsVideoInteropServicePolicy.md", + "redirect_url": "/powershell/module/teams/Grant-CsTeamsVideoInteropServicePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Grant-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/Import-CsAutoAttendantHolidays", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/teams/Import-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallableEntity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallFlow", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantCallHandlingAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantDialScope", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenu.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantMenu", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantMenuOption", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/teams/New-CsAutoAttendantPrompt", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/New-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsCallQueue.md", + "redirect_url": "/powershell/module/teams/New-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowAllKnownDomains.md", + "redirect_url": "/powershell/module/teams/New-CsEdgeAllowAllKnownDomains", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeAllowList.md", + "redirect_url": "/powershell/module/teams/New-CsEdgeAllowList", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsEdgeDomainPattern.md", + "redirect_url": "/powershell/module/teams/New-CsEdgeDomainPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/New-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/teams/New-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineDateTimeRange.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineDateTimeRange", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/teams/New-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineTimeRange.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineTimeRange", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPairedApplication.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingPairedApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingExtendedNotification.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallingExtendedNotification", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsEmergencyNumber.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsEmergencyNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/New-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/New-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/teams/New-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/teams/New-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/teams/New-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/teams/New-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/teams/New-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Register-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/teams/Register-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/Remove-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/Remove-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsCallQueue.md", + "redirect_url": "/powershell/module/teams/Remove-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/Remove-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/teams/Remove-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationInstanceAssociation.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineApplicationInstanceAssociation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineAudioFile", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineTelephoneNumber.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineTelephoneNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/Remove-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/teams/Remove-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/teams/Remove-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsApplicationAccessPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsApplicationAccessPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsApplicationMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsApplicationMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/Set-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallingLineIdentity.md", + "redirect_url": "/powershell/module/teams/Set-CsCallingLineIdentity", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsCallQueue.md", + "redirect_url": "/powershell/module/teams/Set-CsCallQueue", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/Set-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsInboundExemptNumberPattern.md", + "redirect_url": "/powershell/module/teams/Set-CsInboundExemptNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingBridge.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingBridge", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingTenantSettings.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingTenantSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDialInConferencingUserDefaultNumber.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineDialInConferencingUserDefaultNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineEnhancedEmergencyServiceDisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisCivicAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisLocation.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisLocation", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisPort.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisPort", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSubnet.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisSwitch.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisSwitch", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineLisWirelessAccessPoint", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlinePSTNGateway.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlinePSTNGateway", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlinePstnUsage.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlinePstnUsage", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineSchedule.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineSchedule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoicemailPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoicemailUserSettings.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoicemailUserSettings", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoute.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceRoute", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUser.md", + "redirect_url": "/powershell/module/teams/Set-CsOnlineVoiceUser", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppPermissionPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsAppPermissionPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAppSetupPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsAppSetupPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsAudioConferencingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsAudioConferencingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallHoldPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsCallHoldPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCallParkPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsCallParkPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsChannelsPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsChannelsPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsClientConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsClientConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingApplication.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsComplianceRecordingApplication", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsComplianceRecordingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsComplianceRecordingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsCortanaPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsCortanaPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEducationAssignmentsAppPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsEducationAssignmentsAppPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsEmergencyCallingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsEmergencyCallRoutingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsEmergencyCallRoutingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsFeedbackPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsFeedbackPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestCallingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestCallingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsGuestMessagingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsGuestMessagingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsIPPhonePolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsIPPhonePolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBrandingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBrandingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBroadcastConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingBroadcastPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingBroadcastPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMeetingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMessagingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMessagingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsMobilityPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsMobilityPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsNetworkRoamingPolicy.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsNetworkRoamingPolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsPinnedApp.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsPinnedApp", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/Set-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantBlockedCallingNumbers.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantBlockedCallingNumbers", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantFederationConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantFederationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantMigrationConfiguration.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantMigrationConfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkRegion.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkRegion", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSite.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkSite", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantNetworkSubnet.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantNetworkSubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantTrustedIPAddress.md", + "redirect_url": "/powershell/module/teams/Set-CsTenantTrustedIPAddress", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsVideoInteropServiceProvider.md", + "redirect_url": "/powershell/module/teams/Set-CsVideoInteropServiceProvider", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Start-CsExMeetingMigration.md", + "redirect_url": "/powershell/module/teams/Start-CsExMeetingMigration", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Sync-CsOnlineApplicationInstance.md", + "redirect_url": "/powershell/module/teams/Sync-CsOnlineApplicationInstance", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsEffectiveTenantDialPlan.md", + "redirect_url": "/powershell/module/teams/Test-CsEffectiveTenantDialPlan", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsInboundBlockedNumberPattern.md", + "redirect_url": "/powershell/module/teams/Test-CsInboundBlockedNumberPattern", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsTeamsTranslationRule.md", + "redirect_url": "/powershell/module/teams/Test-CsTeamsTranslationRule", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Unregister-CsOnlineDialInConferencingServiceNumber.md", + "redirect_url": "/powershell/module/teams/Unregister-CsOnlineDialInConferencingServiceNumber", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsAutoAttendant.md", + "redirect_url": "/powershell/module/teams/Update-CsAutoAttendant", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Clear-CsOnlineTelephoneNumberReservation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Disable-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Enable-CsOnlineDialInConferencingUser.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Export-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHuntGroup.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsHuntGroupTenantInformation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserInfo.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDialInConferencingUserState.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineDirectoryTenantNumberCities.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineNumberPortOutOrderPin.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberAvailableCount.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryAreas.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCities.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryCountries.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryRegions.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberInventoryTypes.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOnlineTelephoneNumberReservationsInformation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantStatus.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedLanguage.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantSupportedTimeZone.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsOrganizationalAutoAttendantTenantInformation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTeamsUpgradeStatus.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Get-CsTenantPublicProvider.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Grant-CsBroadcastMeetingPolicy.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Import-CsOrganizationalAutoAttendantHolidays.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsHuntGroup.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineAudioFile.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineBulkAssignmentInput.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOnlineSession.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallableEntity.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallFlow.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantCallHandlingAssociation.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantDialScope.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenu.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantMenuOption.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/New-CsOrganizationalAutoAttendantPrompt.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsHuntGroup.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Remove-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Search-CsOnlineTelephoneNumberInventory.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Select-CsOnlineTelephoneNumberInventory.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsHuntGroup.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineApplicationEndpoint.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineDirectoryUser.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortInOrder.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineNumberPortOutOrderPin.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOnlineVoiceUserBulk.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Set-CsTenantPublicProvider.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlineCarrierPortabilityIn.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlineLisCivicAddress.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Test-CsOnlinePortabilityIn.md", + "redirect_url": "/powershell/module/teams/", + "redirect_document_id": false + }, + { + "source_path": "skype/virtual-folder/skype/Update-CsOrganizationalAutoAttendant.md", + "redirect_url": "/powershell/module/teams/", "redirect_document_id": false } - ] -} + ] } diff --git a/ContentOwners.txt b/ContentOwners.txt new file mode 100644 index 0000000000..95093fb98b --- /dev/null +++ b/ContentOwners.txt @@ -0,0 +1 @@ +* @tiburd @yogkumgit diff --git a/README.md b/README.md index 307cb573aa..799d11a6c6 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,92 @@ -**Short URL: aka.ms/office-powershell** +--- +ms.date: 05/16/2025 +--- # Overview -This repository holds reference content of Office PowerShell cmdlets for help purpose. The expert knowledge around Office PowerShell is distributed among customers, MVPs, partners, product teams, support, and other community members. Consumers have various preferences when consuming knowledge such as a website, PowerShell Get-Help, Windows app, iOS app, Android app, and others. The following diagram illustrates the point. +## Learn how to contribute -![Contribution and Consumption model for Office PowerShell reference content.](images/contrib-consumption-model.png) +Anyone who is interested can contribute to the articles. When you contribute, your work goes into the content set after it's been reviewed and merged. It's then published to [Microsoft Learn](https://learn.microsoft.com/), and you're listed as a contributor at: . -## Learn How To Contribute - -Anyone who is interested can contribute to the Microsoft Office PowerShell reference topics. Your contributions will go directly into the Microsoft Office products and show up in Get-Help for the given Office cmdlet. - -> [!NOTE] -> If you're interested in contributing to the **PnP PowerShell** cmdlets, their documentation is automatically generated from code, and you should be submitting your change towards the original code at . See, for example, how the attributes are used in code for the [Get-PnPList](https://github.com/SharePoint/PnP-PowerShell/blob/master/Commands/Lists/GetList.cs) cmdlet. - -## Quick Start - -Contributors who only make infrequent or small updates can edit the file directly on GitHub.com without having to install any additional software. This article shows you how. - -This brief video also covers how to contribute: - -[![Image of Quick Start video.](images/edit_video_capture.jpg)](https://support.office.com/article/edit-powershell-cmdlet-in-github-dcd20227-3764-48ce-ad6e-763af8b48daf) +If you get stuck and are a Microsoft employee or vendor, post a message to [Ask an Admin](https://aka.ms/askanadmin). ### Quickly update an article using GitHub.com -1. Make sure you're signed in to GitHub.com with your GitHub account. -2. Go to the page you want to edit on docs.microsoft.com. -3. On the right-hand side of the page, click **Edit** (pencil icon). +Contributors who make infrequent or small updates can edit the file directly on GitHub.com without installing any software. This article shows you how. [This two-minute video](https://learn-video.azurefd.net/vod/player?id=b5167c5a-9c69-499b-99ac-e5467882bc92) also covers how to contribute. - ![Edit button on docs.microsoft.com.](images/quick-update-edit.png) +> [!TIP] +> To edit an article, you need to get to it on the GitHub.com backend. If you're already on the GitHub.com page of the article, you're starting at step 4. +> +> Your permissions in the repo determine what you see in step 5 and later. People with no special privileges see the steps as described. People with permissions to approve their own pull requests see a similar experience with different button and page titles (for example, **Commit changes** instead of **Propose changes**), extra options for creating a new branch, and fewer confirmation pages. The point is: click any green buttons that are presented to you until there are no more. -4. The corresponding topic file on GitHub opens, where you need to click the **Edit this file** pencil icon. +1. Verify that you're signed in to GitHub.com with your GitHub account. +2. On learn.microsoft.com, find the article that you want to update. +3. Above the title of the article, select ![Edit this document icon.](images/m365-cc-sc-edit-icon.png) **Edit this document**. - ![Edit button on github.com.](images/quick-update-github.png) + ![Screenshot of how to select the Edit this document button on a learn.microsoft.com article.](images/quick-update-edit-button-on-learn-page.png) -5. The topic opens in a line-numbered editing page where you can make changes to the file. +4. The corresponding article file opens on GitHub. Select ![Edit icon.](images/quick-update-github-edit-icon.png) **Edit**. - In this example, we'll add a link to the **Related Links** section of a topic. To add the link, scroll down to the **Related Links** section and add the link in the correct format. + ![Screenshot of how to select the Edit button on a GitHub article file.](images/quick-update-edit-button-on-github-page.png) - **Notes**: +5. If a **You need to fork this repository to propose changes** page opens, select **Fork this repository**. - - Files in GitHub are written and edited using Markdown language. For help on using Markdown, see [Mastering Markdown](https://guides.github.com/features/mastering-markdown/). + ![Screenshot of how to select Fork this repository on the You need to fork this repository to propose changes page.](images/quick-update-fork-this-repository-page.png) - - In cmdlet reference topics, the layout of headings and subheadings must follow a required schema for PowerShell Get-Help. Any deviation will throw errors in the Pull Request. For more information, see . +6. The article file opens in a line-numbered editor page where you can make updates. - - Since you are likely not a maintainer of the Git repository, GitHub will automatically 'Fork' the project into your personal GitHub account. A fork is a copy of the repository in your git account. By forking, you can freely make edits without affecting the original repository. You can always find it again by looking at your GitHub Repositories in your GitHub Profile (drop-down from your name in the top right). + Articles on learn.microsoft.com are formatted using the Markdown language. For help on using Markdown, see [Mastering Markdown](https://guides.github.com/features/mastering-markdown/). - ![Image of Automatic Fork message on Github.](images/auto_fork.png) + > [!TIP] + > Cmdlet reference articles follow a very strict schema with limited formatting options, because the articles are also converted and used for help at the command line (`Get-Help `). Use existing content as a guide. For more information, see [platyPS Schema](https://github.com/PowerShell/platyPS/blob/master/docs/developer/platyPS/platyPS.schema.md). -6. You can click the **Preview changes** tab to see what the changes will look like. + Select **Preview** to view your changes as you go. Select **Edit** to go back to making updates. -7. When you're finished making changes, go to the **Propose file change** section at the bottom of the page: + When you're finished making changes, select the green **Commit changes** button. - - A brief title is required. By default, the title is the name of the file, but you can change it. - - Optionally, you can enter more details in the **Add an optional extended description** box. + ![Screenshot of how to select the green Commit changes button on the article editor page.](images/quick-update-editor-page.png) - When you're ready, click the green **Propose file change** button. +7. In the **Propose changes** dialog that opens, review and/or enter the following values: + - **Commit message**: This value is required. You can accept the default value ("Update \") or you can change it. + - **Extended description**: This value is optional. For example: + - An explanation of the changes. + - @ include the GitHub alias of someone to review and merge your changes. - ![Propose file change section.](images/propose-file-change.png) + When you're finished on the **Propose changes** dialog, select the green **Propose changes** button. -8. On the **Comparing changes** page that appears, click the green **Create pull request** button. + ![Screenshot of how to select the green Propose changes button in the Propose changes dialog.](images/quick-update-propose-changes-dialog.png) - ![Comparing changes page.](images/comparing-changes-page.png) +8. On the **Comparing changes** page that opens, select the green **Create pull request** button. -9. On the **Open a pull request** page that appears, click the green **Create pull request** button. + ![Screenshot of how to select the green Create pull request button on the Comparing changes page.](images/quick-update-comparing-changes-page.png) - ![Open a pull request page.](images/open-a-pull-request-page.png) +9. On the **Open a pull request** page that opens, review the title and comments, and then select the green **Create pull request** button. -> [!NOTE] -> Your permissions in the repo determine what you see in the last several steps. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages.

The point is: click any green buttons that are presented to you until there are no more. + ![Screenshot of how to select the green Create pull request button on the Open a pull request page.](images/quick-update-open-a-pull-request-page.png) -Looking for more in-depth content? Check out the following topics: +10. That's it. There's nothing more for you to do. -- [Frequently Asked Questions (FAQ)](repo_docs/FAQ.md) -- [Using more advanced tools with the PowerShell GitHub repo](repo_docs/ADVANCED.md) -- [Creating content for brand new cmdlets](repo_docs/NEW_CMDLETS.md) + The article owner (identified in metadata) is notified about the changes to the article. Eventually, the article owner or another party will review, possibly edit, and approve your changes. After your pull request is merged, the article is updated on learn.microsoft.com. ## Microsoft Open Source Code of Conduct This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. +For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any questions or comments. ### Contributing -This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit . +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit . -When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. +When you submit a pull request, a CLA-bot automatically determines whether you need to provide a CLA and decorate the PR appropriately (for example, label, comment). Follow the instructions provided by the bot. You only need to do this step once across all repos using our CLA. -## Legal Notices +### Legal Notices Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode), see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the [LICENSE-CODE](LICENSE-CODE) file. -Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at . +Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries/regions. + +The licenses for this project don't grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at . Privacy information can be found at diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000..e138ec5d6a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,41 @@ + + +## Security + +Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). + +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below. + +## Reporting Security Issues + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report). + +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey). + +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). + +Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: + + * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) + * Full paths of source file(s) related to the manifestation of the issue + * The location of the affected source code (tag/branch/commit or direct URL) + * Any special configuration required to reproduce the issue + * Step-by-step instructions to reproduce the issue + * Proof-of-concept or exploit code (if possible) + * Impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. + +If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs. + +## Preferred Languages + +We prefer all communications to be in English. + +## Policy + +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd). + + diff --git a/cabgen-bootstrap.yml b/cabgen-bootstrap.yml new file mode 100644 index 0000000000..51843abfaa --- /dev/null +++ b/cabgen-bootstrap.yml @@ -0,0 +1,14 @@ +trigger: +- live + +pr: none # Disable pull request triggers. + +resources: + repositories: + - repository: templates + type: git + name: Content CI/ReferenceAutomation + ref: refs/heads/master + +extends: + template: PowerShell/cabgen.yml@templates \ No newline at end of file diff --git a/exchange/docfx.json b/exchange/docfx.json index 0518a822b3..e0a0abf6b0 100644 --- a/exchange/docfx.json +++ b/exchange/docfx.json @@ -75,6 +75,7 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "uhfHeaderId": "MSDocsHeader-M365-IT", "author": "chrisda", "ms.author": "chrisda", "manager": "serdars", @@ -86,9 +87,8 @@ "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" ], "ms.devlang": "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" + "feedback_system": "Standard", + "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" }, "fileMetadata": { "apiPlatform": { diff --git a/exchange/docs-conceptual/app-only-auth-powershell-v2.md b/exchange/docs-conceptual/app-only-auth-powershell-v2.md index d14fa78ca2..f23758f7ff 100644 --- a/exchange/docs-conceptual/app-only-auth-powershell-v2.md +++ b/exchange/docs-conceptual/app-only-auth-powershell-v2.md @@ -1,122 +1,175 @@ --- -title: App-only authentication +title: App-only authentication in Exchange Online PowerShell and Security & Compliance PowerShell ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 12/12/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-online -ms.reviewer: navgupta -localization_priority: Priority +ms.reviewer: +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn about using the Exchange Online V2 module in scripts and other long-running tasks with modern authentication and app-only authentication." +description: "Learn how to configure app-only authentication (also known as certificate based authentication or CBA) using the Exchange Online PowerShell V3 module in scripts and other long-running tasks." --- -# App-only authentication for unattended scripts in the EXO V2 module +# App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell + +Auditing and reporting scenarios in Microsoft 365 often involve unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell. In the past, unattended sign in required you to store the username and password in a local file or in a secret vault that's accessed at run-time. But, as we all know, storing user credentials locally isn't a good security practice. + +Certificate based authentication (CBA) or app-only authentication as described in this article supports unattended script and automation scenarios by using Microsoft Entra apps and self-signed certificates. > [!NOTE] -> The features and procedures described in this article require version 2.0.3 or later of the EXO V2 module. For instructions on how to install or update to this version of the module, see [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). +> +> - Did you know that you can connect to Exchange Online PowerShell using managed identities in Azure? Check out [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). +> +> - The features and procedures described in this article require the following versions of the Exchange Online PowerShell module: +> - **Exchange Online PowerShell (Connect-ExchangeOnline)**: Version 2.0.3 or later. +> - **Security & Compliance PowerShell (Connect-IPPSSession)**: Version 3.0.0 or later. +> +> For instructions on how to install or update the module, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). For instructions on how to use the module in Azure automation, see [Manage modules in Azure Automation](/azure/automation/shared-resources/modules). +> +> - REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). +> +> If the procedures in this article don't work for you, verify that you don't have Beta versions of the PackageManagement or PowerShellGet modules installed by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. +> +> - In Exchange Online PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: +> - [New-UnifiedGroup](/powershell/module/exchange/new-unifiedgroup) +> - [Remove-UnifiedGroup](/powershell/module/exchange/remove-unifiedgroup) +> - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) +> - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) +> +> You can use Microsoft Graph to replace most of the functionality from those cmdlets. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). +> +> - In Security & Compliance PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: +> - [Get-ComplianceSearchAction](/powershell/module/exchange/get-compliancesearchaction) +> - [New-ComplianceSearch](/powershell/module/exchange/new-compliancesearch) +> - [Start-ComplianceSearch](/powershell/module/exchange/start-compliancesearch) +> +> - Delegated scenarios are supported in Exchange Online. The recommended method for connecting with delegation is using GDAP and App Consent. For more information, see [Use the Exchange Online PowerShell v3 Module with GDAP and App Consent](/powershell/partnercenter/exchange-online-gdap-app). You can also use multi-tenant applications when CSP relationships are not created with the customer. The required steps for using multi-tenant applications are called out within the regular instructions in this article. +> +> - Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet if you get the following error when using the Windows PowerShell SDK to connect: `The term 'Update-ModuleManifest' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.` + +## How does it work? -Auditing and reporting scenarios in Exchange Online often involve scripts that run unattended. In most cases, these unattended scripts access Exchange Online PowerShell using Basic authentication (a username and password). Even when the connection to Exchange Online PowerShell uses modern authentication, the credentials are stored in a local file or a secret vault that's accessed at run-time. +The Exchange Online PowerShell module uses the Active Directory Authentication Library to fetch an app-only token using the application ID, tenant ID (organization), and certificate thumbprint. The application object provisioned inside Microsoft Entra ID has a Directory Role assigned to it, which is returned in the access token. The session's role based access control (RBAC) is configured using the directory role information that's available in the token. -Because storing user credentials locally is not a safe practice, we're releasing this feature to support authentication for unattended scripts (automation) scenarios using AzureAD applications and self-signed certificates. +## Connection examples -The following examples show how to use the Exchange Online PowerShell V2 module with app-only authentication: +The following examples show how to use the Exchange Online PowerShell module with app-only authentication: > [!IMPORTANT] -> In the **Connect-ExchangeOnline** commands, be sure to use an `.onmicrosoft.com` domain in the _Organization_ parameter value. Otherwise, you might encounter cryptic permission issues when you run commands in the app context. +> In the following connection commands, use the primary `.onmicrosoft.com` domain for your organization as the value of the _Organization_ parameter. +> +> The following connection commands have many of the same options available as described in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) and [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). For example: +> +> - Microsoft 365 GCC High or Microsoft 365 DoD environments require the following additional parameters and values: +> - **Connect-ExchangeOnline in GCC High**: `-ExchangeEnvironmentName O365USGovGCCHigh`. +> - **Connect-IPPSSession in GCC High**: `-ConnectionUri https://ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common`. +> - **Connect-ExchangeOnline in DoD**: `-ExchangeEnvironmentName O365USGovDoD`. +> - **Connect-IPPSSession in DoD**: `-ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common`. +> +> - If a **Connect-IPPSSession** command presents a login prompt, run the command: `$Global:IsWindows = $true` before the **Connect-IPPSSession** command. -- Connect using a local certificate: +- **Connect using a certificate thumbprint**: - ```powershell - Connect-ExchangeOnline -CertificateFilePath "C:\Users\johndoe\Desktop\automation-cert.pfx" -CertificatePassword (ConvertTo-SecureString -String "" -AsPlainText -Force) -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" - ``` + > [!NOTE] + > The CertificateThumbprint parameter is supported only in Microsoft Windows. -- Connect using a certificate thumbprint: + The certificate needs to be installed on the computer where you're running the command. The certificate should be installed in the user certificate store. - ```powershell - Connect-ExchangeOnline -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" - ``` + - Exchange Online PowerShell: - When you use the _CertificateThumbPrint_ parameter, the certificate needs to be installed on the computer where you are running the command. The certificate should be installed in the user certificate store. + ```powershell + Connect-ExchangeOnline -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` -- Connect using a certificate object: + - Security & Compliance PowerShell: - ```powershell - Connect-ExchangeOnline -Certificate <%X509Certificate2 Object%> -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" - ``` + ```powershell + Connect-IPPSSession -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` - When you use the _Certificate_ parameter, the certificate does not need to be installed on the computer where you are running the command. This parameter is applicable for scenarios where the certificate object is stored remotely and fetched at runtime during script execution. +- **Connect using a certificate object**: -> [!TIP] -> App-only authentication does not support delegation. Unattended scripting in delegation scenarios is supported with the Secure App Model. For more information, go [here](/powershell/partnercenter/multi-factor-auth#exchange). + The certificate doesn't need to be installed on the computer where you're running the command. You can store the certificate object remotely. The certificate is fetched when the script is run. -## How does it work? + - Exchange Online PowerShell: -The EXO V2 module uses the Active Directory Authentication Library to fetch an app-only token using the application Id, tenant Id (organization), and certificate thumbprint. The application object provisioned inside Azure AD has a Directory Role assigned to it, which is returned in the access token. Exchange Online configures the session RBAC using the directory role information that's available in the token. + ```powershell + Connect-ExchangeOnline -Certificate <%X509Certificate2 Object%> -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` -## Set up app-only authentication + - Security & Compliance PowerShell: -An initial onboarding is required for authentication using application objects. Application and service principal are used interchangeably, but an application is like a class object while a service principal is like an instance of the class. You can learn more about this at [Application and service principal objects in Azure Active Directory](/azure/active-directory/develop/app-objects-and-service-principals). + ```powershell + Connect-IPPSSession -Certificate <%X509Certificate2 Object%> -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` -For a detailed visual flow about creating applications in Azure AD, see . +- **Connect using a local certificate**: -1. [Register the application in Azure AD](#step-1-register-the-application-in-azure-ad). + > [!NOTE] + > Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. -2. [Assign Exchange Online API permissions to the application](#step-2-assign-api-permissions-to-the-application). + - Exchange Online PowerShell: - An application object has the default permission `User.Read`. For the application object to access Exchange Online resources, it needs to have the Application permission `Exchange.ManageAsApp`. + ```powershell + Connect-ExchangeOnline -CertificateFilePath "C:\Users\navin\Desktop\automation-cert.pfx" -CertificatePassword (Get-Credential).password -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` -3. [Generate a self-signed certificate](#step-3-generate-a-self-signed-certificate) + - Security & Compliance PowerShell: - - For app-only authentication in Azure AD, you typically use a certificate to request access. Anyone who has the certificate and its private key can use the app, and the permissions granted to the app. + ```powershell + Connect-IPPSSession -CertificateFilePath "C:\Users\navin\Desktop\automation-cert.pfx" -CertificatePassword (Get-Credential).password -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contosoelectronics.onmicrosoft.com" + ``` - - Create and configure a self-signed X.509 certificate, which will be used to authenticate your Application against Azure AD, while requesting the app-only access token. +## Set up app-only authentication - - This is similar to generating a password for user accounts. The certificate can be self-signed as well. See the [Appendix](#step-3-generate-a-self-signed-certificate) section later in this article for instructions for generating certificates in PowerShell. +An initial onboarding is required for authentication using application objects. Application and service principal are used interchangeably, but an application is like a class object while a service principal is like an instance of the class. For more information, see [Application and service principal objects in Microsoft Entra ID](/entra/identity-platform/app-objects-and-service-principals). - > [!NOTE] - > Cryptography: Next Generation (CNG) certificates are not supported for app-only authentication with Exchange. CNG certificates are created by default in modern Windows versions. You must use a certificate from a CSP key provider. The [Appendix](#step-3-generate-a-self-signed-certificate) section covers two supported methods to create a CSP certificate. +For a detailed visual flow about creating applications in Microsoft Entra ID, see . -4. [Attach the certificate to the Azure AD application](#step-4-attach-the-certificate-to-the-azure-ad-application) +1. [Register the application in Microsoft Entra ID](#step-1-register-the-application-in-microsoft-entra-id). -5. [Assign Azure AD roles to the application](#step-5-assign-azure-ad-roles-to-the-application) +2. [Assign API permissions to the application](#step-2-assign-api-permissions-to-the-application). - The application needs to have the appropriate RBAC roles assigned. Because the apps are provisioned in Azure AD, you can use any of the built-in roles. The following roles are supported: + An application object has the **Delegated** API permission **Microsoft Graph** \> **User.Read** by default. For the application object to access resources in Exchange, it needs the **Application** API permission **Office 365 Exchange Online** \> **Exchange.ManageAsApp**. - - Global administrator - - Compliance administrator - - Security reader - - Security administrator - - Helpdesk administrator - - Exchange administrator - - Global Reader +3. [Generate a self-signed certificate](#step-3-generate-a-self-signed-certificate) - > [!NOTE] - > The Global administrator and Exchange administrator roles provide the necessary permissions for any Exchange-related tasks, including recipient management and protection features (anti-spam, anti-malware, etc). The Security administrator role doesn't not have the necessary permissions for these same Exchange-related tasks. + - For app-only authentication in Microsoft Entra ID, you typically use a certificate to request access. Anyone who has the certificate and its private key can use the app with the permissions granted to the app. -## Appendix + - Create and configure a self-signed X.509 certificate, which is used to authenticate your Application against Microsoft Entra ID, while requesting the app-only access token. -## Step 1: Register the application in Azure AD + - This procedure is similar to generating a password for user accounts. The certificate can be self-signed as well. See [this section](#step-3-generate-a-self-signed-certificate) later in this article for instructions to generate certificates in PowerShell. -**Note**: If you encounter problems, check the [required permissions](/azure/active-directory/develop/howto-create-service-principal-portal#required-permissions) to verify that your account can create the identity. + > [!NOTE] + > Cryptography: Next Generation (CNG) certificates aren't supported for app-only authentication with Exchange. CNG certificates are created by default in modern versions of Windows. You must use a certificate from a CSP key provider. [This section](#step-3-generate-a-self-signed-certificate) section covers two supported methods to create a CSP certificate. -1. Open the Azure AD portal at . +4. [Attach the certificate to the Microsoft Entra application](#step-4-attach-the-certificate-to-the-microsoft-entra-application) -2. Under **Manage Azure Active Directory**, click **View**. +5. [Assign Microsoft Entra roles to the application](#step-5-assign-microsoft-entra-roles-to-the-application) - ![Click View in the Azure AD portal under Manage Azure Active Directory.](media/exo-app-only-auth-manage-ad-view.png) + The application needs to have the appropriate RBAC roles assigned. Because the apps are provisioned in Microsoft Entra ID, you can use any of the supported built-in roles. + +### Step 1: Register the application in Microsoft Entra ID + +> [!NOTE] +> If you encounter problems, check the [required permissions](/entra/identity-platform/howto-create-service-principal-portal#permissions-required-for-registering-an-app) to verify that your account can create the identity. -3. On the **Overview** page that opens, under **Manage**, select **App registrations**. +1. Open the Microsoft Entra admin center at . - ![Select App registrations.](media/exo-app-only-auth-select-app-registrations.png) +2. In the **Search** box at the top of the page, start typing **App registrations**, and then select **App registrations** from the results in the **Services** section. -4. On the **App registrations** page that opens, click **New registration**. + ![Screenshot that shows App registrations in the Search results on the home page of the Azure portal.](media/exo-app-only-auth-find-app-registrations.png) + + Or, to go directly to the **App registrations** page, use . + +3. On the **App registrations** page, select **New registration**. ![Select New registration on the App registrations page.](media/exo-app-only-auth-new-app-registration.png) @@ -126,66 +179,156 @@ For a detailed visual flow about creating applications in Azure AD, see only - Single tenant)** is selected. - - **Redirect URI (optional)**: In the first box, verify that **Web** is selected. In the second box, enter the URI where the access token is sent. + > [!NOTE] + > To make the application multi-tenant for **Exchange Online** delegated scenarios, select the value **Accounts in any organizational directory (Any Microsoft Entra directory - Multitenant)**. + + - **Redirect URI (optional)**: This setting is optional. If you need to use it, configure the following settings: + - **Platform**: Select **Web**. + - **URI**: Enter the URI where the access token is sent. - Note that you can't create credentials for [native applications](/azure/active-directory/manage-apps/application-proxy-configure-native-client-application), because you can't use that type for automated applications. + > [!NOTE] + > You can't create credentials for [native applications](/entra/identity/app-proxy/application-proxy-configure-native-client-application), because you can't use native applications for automated applications. ![Register an application.](media/exo-app-only-auth-register-app.png) - When you're finished, click **Register**. + When you're finished on the **App registrations** page, select **Register**. -5. Leave the app page that you return to open. You'll use it in the next step. +4. You're taken to the **Overview** page of the app you just registered. Leave this page open. You'll use it in the next step. -## Step 2: Assign API permissions to the application +### Step 2: Assign API permissions to the application -> [!NOTE] -> The procedures in this section replace any default permissions that were automatically configured for the new app. The app doesn't need the default permissions that were replaced. +Choose **one** of the following methods in this section to assign API permissions to the app: -1. On the app page under **Management**, select **Manifest**. +- Select and assign the API permissions from the portal. +- Modify the app manifest to assign API permissions. (Microsoft 365 GCC High and DoD organizations should use this method) - ![Select Manifest on the application properties page.](media/exo-app-only-auth-select-manifest.png) +#### Select and assign the API permissions from the portal -2. On the **Manifest** page that opens, find the `requiredResourceAccess` entry (on or about line 44). +1. On the app **Overview** page, select **API permissions** from the **Manage** section. - Modify the `resourceAppId`, `resourceAccess`, `id`, and `type` values as shown in the following code snippet: + ![Select API permissions on the application overview page.](media/exo-app-only-auth-select-manifest.png) + +2. On the app **API Permissions** page, select **Add a permission**. + + ![Select Add a permission on the API permissions page of the application.](media/exo-app-only-auth-api-permissions-add-a-permission.png) + +3. In the **Request API permissions** flyout that opens, select the **APIs my organization uses** tab, start typing **Office 365 Exchange Online** in the **Search** box, and then select it from the results. + + ![Find and select Office 365 Exchange Online on the APIs my organization uses tab.](media/exo-app-only-auth-api-permissions-select-o365-exo.png) + +4. On the **What type of permissions does your application require?** flyout that appears, select **Application permissions**. + +5. In the permissions list that appears, expand **Exchange**, select **Exchange.ManageAsApp**, and then select **Add permissions**. + + ![Find and select Exchange.ManageAsApp permissions from the Application permission tab.](media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png) + +6. Back on the app **API permissions** page, verify **Office 365 Exchange Online** \> **Exchange.ManageAsApp** is listed and contains the following values: + - **Type**: **Application**. + - **Admin consent required**: **Yes**. + + - **Status**: The current incorrect value is **Not granted for \**. + + Change this value by selecting **Grant admin consent for \**, reading the confirmation dialog that opens, and then selecting **Yes**. + + ![Admin consent required but not granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-original-permissions.png) + + The **Status** value is now **Granted for \**. + + ![Admin consent granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-admin-consent-granted.png) + +7. For the default **Microsoft Graph** \> **User.Read** entry, select **...** \> **Revoke admin consent**, and then select **Yes** in the confirmation dialog that opens to return **Status** back to the default blank value. + + ![Admin consent removed from default Microsoft Graph User.Read permissions.](media/exo-app-only-auth-admin-consent-removed-from-graph.png) + +8. Close the current **API permissions** page (not the browser tab) to return to the **App registrations** page. You use the **App registrations** page in an upcoming step. + +#### Modify the app manifest to assign API permissions + +> [!NOTE] +> The procedures in this section _append_ the existing default permissions on the app (delegated **User.Read** permissions in **Microsoft Graph**) with the required application **Exchange.ManageAsApp** permissions in **Office 365 Exchange Online**. + +1. On the app **Overview** page, select **Manifest** from the **Manage** section. + + ![Select Manifest on the application overview page.](media/exo-app-only-auth-select-manifest.png) + +2. On the app **Manifest** page, find the `requiredResourceAccess` entry (on or about line 42), and make the entry look like the following code snippet: ```json "requiredResourceAccess": [ - { - "resourceAppId": "00000002-0000-0ff1-ce00-000000000000", - "resourceAccess": [ - { - "id": "dc50a0fb-09a3-484d-be87-e023b12c6440", - "type": "Role" - } - ] - } + { + "resourceAppId": "00000002-0000-0ff1-ce00-000000000000", + "resourceAccess": [ + { + "id": "dc50a0fb-09a3-484d-be87-e023b12c6440", + "type": "Role" + } + ] + }, + { + "resourceAppId": "00000003-0000-0000-c000-000000000000", + "resourceAccess": [ + { + "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d", + "type": "Scope" + } + ] + } ], ``` - When you're finished, click **Save**. + > [!NOTE] + > Microsoft 365 GCC High or DoD environments have access to Security & Compliance PowerShell only. Use the following values for the `requiredResourceAccess` entry: + > + > ```json + > "requiredResourceAccess": [ + > { + > "resourceAppId": "00000007-0000-0ff1-ce00-000000000000", + > "resourceAccess": [ + > { + > "id": "455e5cd2-84e8-4751-8344-5672145dfa17", + > "type": "Role" + > } + > ] + > }, + > { + > "resourceAppId": "00000003-0000-0000-c000-000000000000", + > "resourceAccess": [ + > { + > "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d", + > "type": "Scope" + > } + > ] + > } + > ], + > ``` + + When you're finished on the **Manifest** page, select **Save**. -3. Still on the **Manifest** page, under **Management**, select **API permissions**. +3. Still on the **Manifest** page, select **API permissions** from the **Manage** section. - ![Select API permissions on the application properties page.](media/exo-app-only-auth-select-api-permissions.png) + ![Select API permissions from the Manifest page.](media/exo-app-only-auth-manifest-select-api-permissions.png) - On the **API permissions** page that opens, do the following steps: +4. On the **API permissions** page, verify **Office 365 Exchange Online** \> **Exchange.ManageAsApp** is listed and contains the following values: + - **Type**: **Application**. + - **Admin consent required**: **Yes**. - - **API / Permissions name**: Verify the value **Exchange.ManageAsApp** is shown. + - **Status**: The current incorrect value is **Not granted for \** for the **Office 365 Exchange Online** \> **Exchange.ManageAsApp** entry. - - **Status**: The current incorrect value is **Not granted for \**, and this value needs to be changed. + Change the **Status** value by selecting **Grant admin consent for \**, reading the confirmation dialog that opens, and then selecting **Yes**. - ![Original incorrect API permissions.](media/exo-app-only-auth-original-permissions.png) + ![Admin consent required but not granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-original-permissions.png) - Select **Grant admin consent for \**, read the confirmation dialog that opens, and then click **Yes**. + The **Status** value is now **Granted for \**. - The **Status** value should now be **Granted for \**. + ![Admin consent granted for Exchange.ManageAsApp permissions.](media/exo-app-only-auth-admin-consent-granted.png) - ![Admin consent granted.](media/exo-app-only-auth-admin-consent-granted.png) +5. For the default **Microsoft Graph** \> **User.Read** entry, select **...** \> **Revoke admin consent**, and then select **Yes** in the confirmation dialog that opens to return **Status** back to the default blank value. -4. Close the current **API permissions** page (not the browser tab) to return to the **App registrations** page. You'll use it in an upcoming step. + ![Admin consent removed from default Microsoft Graph User.Read permissions.](media/exo-app-only-auth-admin-consent-removed-from-graph.png) -## Step 3: Generate a self-signed certificate +6. Close the current **API permissions** page (not the browser tab) to return to the **App registrations** page. You use the **App registrations** page in an upcoming step. + +### Step 3: Generate a self-signed certificate Create a self-signed x.509 certificate using one of the following methods: @@ -196,7 +339,7 @@ Create a self-signed x.509 certificate using one of the following methods: $mycert = New-SelfSignedCertificate -DnsName "contoso.org" -CertStoreLocation "cert:\CurrentUser\My" -NotAfter (Get-Date).AddYears(1) -KeySpec KeyExchange # Export certificate to .pfx file - $mycert | Export-PfxCertificate -FilePath mycert.pfx -Password $(ConvertTo-SecureString -String "P@ssw0Rd1234" -AsPlainText -Force) + $mycert | Export-PfxCertificate -FilePath mycert.pfx -Password (Get-Credential).password # Export certificate to .cer file $mycert | Export-Certificate -FilePath mycert.cer @@ -208,33 +351,29 @@ Create a self-signed x.509 certificate using one of the following methods: .\Create-SelfSignedCertificate.ps1 -CommonName "MyCompanyName" -StartDate 2021-01-06 -EndDate 2022-01-06 ``` -## Step 4: Attach the certificate to the Azure AD application +### Step 4: Attach the certificate to the Microsoft Entra application After you register the certificate with your application, you can use the private key (`.pfx` file) or the thumbprint for authentication. -1. On the **Apps registration** page from the end of [Step 2](#step-2-assign-api-permissions-to-the-application), select your application. - - If you need to get back to **Apps registration** page, do the following steps: +1. On the **Owned applications** tab on the **Apps registration** page from the end of [Step 2](#step-2-assign-api-permissions-to-the-application), select your application. - 1. Open the Azure AD portal at . - 2. Under **Manage Azure Active Directory**, click **View**. - 3. Under **Manage**, select **App registrations**. + If you need to get back to **Apps registration** page, use , verify the **Owned applications** tab is selected, and then select your application. ![Apps registration page where you select your app.](media/exo-app-only-auth-app-registration-page.png) -2. On the application page that opens, under **Manage**, select **Certificates & secrets**. +2. On the application page that opens, select **Certificates & secrets** from the **Manage** section. ![Select Certificates & Secrets on the application properties page.](media/exo-app-only-auth-select-certificates-and-secrets.png) -3. On the **Certificates & secrets** page that opens, click **Upload certificate**. +3. On the **Certificates & secrets** page, select **Upload certificate**. ![Select Upload certificate on the Certificates & secrets page.](media/exo-app-only-auth-select-upload-certificate.png) In the dialog that opens, browse to the self-signed certificate (`.cer` file) that you created in [Step 3](#step-3-generate-a-self-signed-certificate). - ![Browse to the certificate and then click Add.](media/exo-app-only-auth-upload-certificate-dialog.png) + ![Browse to the certificate and then select Add.](media/exo-app-only-auth-upload-certificate-dialog.png) - When you're finished, click **Add**. + When you're finished, select **Add**. The certificate is now shown in the **Certificates** section. @@ -242,42 +381,160 @@ After you register the certificate with your application, you can use the privat 4. Close the current **Certificates & secrets** page, and then the **App registrations** page to return to the main page. You'll use it in the next step. -## Step 5: Assign Azure AD roles to the application +### Step 4b: Exchange Online delegated scenarios only: Grant admin consent for the multi-tenant app -Azure AD has more than 50 admin roles available. For app-only authentication in Exchange Online, we currently support the previously mentioned roles: +If you made the application multi-tenant for **Exchange Online** delegated scenarios in [Step 1](#step-1-register-the-application-in-microsoft-entra-id), you need to grant admin consent to the Exchange.ManageAsApp permission so the application can run cmdlets in Exchange Online **in each tenant organization**. To do this, generate an admin consent URL for each customer tenant. Before anyone uses the multi-tenant application to connect to Exchange Online in the tenant organization, an admin in the customer tenant should open the following URL: -- Global administrator -- Compliance administrator -- Security reader -- Security administrator -- Helpdesk administrator -- Exchange administrator -- Global Reader +`https://login.microsoftonline.com//adminconsent?client_id=&scope=https://outlook.office365.com/.default` -For general instructions about assigning roles in Azure AD, see [View and assign administrator roles in Azure Active Directory](/azure/active-directory/roles/manage-roles-portal). +- `` is the customer's tenant ID. +- `` is the ID of the multi-tenant application. +- The default scope is used to grant application permissions. -1. On the Azure AD portal at , under **Manage Azure Active Directory**, click **View**. +For more information about the URL syntax, see [Request the permissions from a directory admin](/entra/identity-platform/v2-admin-consent#request-the-permissions-from-a-directory-admin). - ![View in the Azure AD portal under Manage Azure Active Directory.](media/exo-app-only-auth-manage-ad-view.png) +### Step 5: Assign Microsoft Entra roles to the application -2. On the **Overview** page that opens, under **Manage**, select **Roles and administrators**. +You have two options: - ![Select Roles and administrators from the overview page.](media/exo-app-only-auth-select-roles-and-administrators.png) +- **Assign Microsoft Entra roles to the application** +- **Assign custom role groups to the application using service principals**: This method is supported only when you connect to Exchange Online PowerShell or Security & Compliance PowerShell in [REST API mode](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module). Security & Compliance PowerShell supports REST API mode in v3.2.0 or later. -3. On the **Roles and administrators** page that opens, find and select one of the supported roles by _clicking on the name of the role_ (not the check box) in the results. +> [!NOTE] +> You can also combine both methods to assign permissions. For example, you can use Microsoft Entra roles for the "Exchange Recipient Administrator" role and also assign your custom RBAC role to extend the permissions. +> +> For multi-tenant applications in **Exchange Online** delegated scenarios, you need to assign permissions in each customer tenant. - ![Find and select a supported role by clicking on the role name.](media/exo-app-only-auth-find-and-select-supported-role.png) +#### Assign Microsoft Entra roles to the application -4. On the **Assignments** page that opens, click **Add assignments**. +The supported Microsoft Entra roles are described in the following table: - ![Select Add assignments on the role assignments page.](media/exo-app-only-auth-role-assignments-click-add-assignments.png) +|Role|Exchange Online
PowerShell|Security & Compliance
PowerShell| +|---|:---:|:---:| +|[Compliance Administrator](/entra/identity/role-based-access-control/permissions-reference#compliance-administrator)|✔|✔| +|[Exchange Administrator](/entra/identity/role-based-access-control/permissions-reference#exchange-administrator)¹|✔|| +|[Exchange Recipient Administrator](/entra/identity/role-based-access-control/permissions-reference#exchange-recipient-administrator)|✔|| +|[Global Administrator](/entra/identity/role-based-access-control/permissions-reference#global-administrator)¹ ²|✔|✔| +|[Global Reader](/entra/identity/role-based-access-control/permissions-reference#global-reader)|✔|✔| +|[Helpdesk Administrator](/entra/identity/role-based-access-control/permissions-reference#helpdesk-administrator)|✔|| +|[Security Administrator](/entra/identity/role-based-access-control/permissions-reference#security-administrator)¹|✔|✔| +|[Security Reader](/entra/identity/role-based-access-control/permissions-reference#security-reader)|✔|✔| -5. In the **Add assignments** flyout that opens, find and select the app that you created in [Step 1](#step-1-register-the-application-in-azure-ad). +¹ The Global Administrator and Exchange Administrator roles provide the required permissions for any task in Exchange Online PowerShell. For example: + +- Recipient management. +- Security and protection features. For example, anti-spam, anti-malware, anti-phishing, and the associated reports. + +The Security Administrator role does not have the necessary permissions for those same tasks. + +² Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +For general instructions about assigning roles in Microsoft Entra ID, see [Assign Microsoft Entra roles to users](/entra/identity/role-based-access-control/manage-roles-portal). + +> [!NOTE] +> The following steps are slightly different for Exchange Online PowerShell vs. Security & Compliance PowerShell. The steps for both environments are shown. To configure roles for both environments, repeat the steps in this section. + +1. In Microsoft Entra admin center at , start typing **roles and administrators** in the **Search** box at the top of the page, and then select **Microsoft Entra roles and administrators** from the results in the **Services** section. + + ![Screenshot that shows Microsoft Entra roles and administrators in the Search results on the on the home page of the Azure portal.](media/exo-app-only-auth-find-roles-and-administrators.png) + + Or, to go directly to the **Microsoft Entra roles and administrators** page, use . + +2. On the **Roles and administrators** page that opens, find and select one of the supported roles by _clicking on the name of the role_ (not the check box) in the results. + + - **Exchange Online PowerShell**: For example, find and select the **Exchange administrator** role. + + ![Find and select a supported Exchange Online PowerShell role by clicking on the role name.](media/exo-app-only-auth-find-and-select-supported-role.png) + + - **Security & Compliance PowerShell**: For example, find and select the **Compliance Administrator** role. + + ![Find and select a supported Security & Compliance PowerShell role by clicking on the role name.](media/exo-app-only-auth-find-and-select-supported-role-scc.png) + +3. On the **Assignments** page that opens, select **Add assignments**. + + - **Exchange Online PowerShell**: + + ![Select Add assignments on the role assignments page for Exchange Online PowerShell.](media/exo-app-only-auth-role-assignments-click-add-assignments.png) + + - **Security & Compliance PowerShell**: + + ![Select Add assignments on the role assignments page for Security & Compliance PowerShell.](media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png) + +4. In the **Add assignments** flyout that opens, find and select the app that you created in [Step 1](#step-1-register-the-application-in-microsoft-entra-id). ![Find and select your app on the Add assignments flyout.](media/exo-app-only-auth-find-add-select-app-for-assignment.png) - When you're finished, click **Add**. + When you're finished in the **Add assignments** flyout, select **Add**. + +5. Back on the **Assignments** page, verify that the role has been assigned to the app. -6. Back on the **Assignments** page, verify that the app has been assigned to the role. + - **Exchange Online PowerShell**: + + ![The role assignments page after to added the app to the role for Exchange Online PowerShell.](media/exo-app-only-auth-app-assigned-to-role.png) + + - **Security & Compliance PowerShell**: + + ![The role assignments page after to added the app to the role for Security & Compliance PowerShell.](media/exo-app-only-auth-app-assigned-to-role-scc.png) + +#### Assign custom role groups to the application using service principals + +> [!NOTE] +> You need to connect to Exchange Online PowerShell or Security & Compliance PowerShell _before_ completing steps to create a new service principal. Creating a new service principal without connecting to PowerShell won't work (your Azure App ID and Object ID are needed to create the new service principal). +> +> This method is supported only when you connect to Exchange Online PowerShell or Security & Compliance PowerShell in [REST API mode](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module). Security & Compliance PowerShell supports REST API mode in v3.2.0 or later. + +For information about creating custom role groups, see [Create role groups in Exchange Online](/exchange/permissions-exo/role-groups#create-role-groups) and [Create Email & collaboration role groups in the Microsoft Defender portal](/defender-office-365/mdo-portal-permissions#create-email--collaboration-role-groups-in-the-microsoft-defender-portal). The custom role group that you assign to the application can contain any combination of built-in and custom roles. + +To assign custom role groups to the application using service principals, do the following steps: + +1. In [Microsoft Graph PowerShell](/powershell/microsoftgraph/installation), run the following commands to store the details of the Microsoft Entra application that you registered in [Step 1](#step-1-register-the-application-in-microsoft-entra-id) in a variable: + + ```powershell + Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All + + $ = Get-MgServicePrincipal -Filter "DisplayName eq ''" + ``` + + For example: + + ```powershell + Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All + + $AzureADApp = Get-MgServicePrincipal -Filter "DisplayName eq 'ExO PowerShell CBA'" + ``` + + For detailed syntax and parameter information, see [Get-MgServicePrincipal](/powershell/module/microsoft.graph.applications/get-mgserviceprincipal). + +2. In the same PowerShell window, connect to [Exchange Online PowerShell](connect-to-exchange-online-powershell.md) or [Security & Compliance PowerShell](connect-to-scc-powershell.md) and run the following commands to: + - Create a service principal object for the Microsoft Entra application. + - Store the details of the service principal in a variable to use in the next step. + + ```powershell + New-ServicePrincipal -AppId $.AppId -ObjectId $.Id -DisplayName "" + + $ = Get-ServicePrincipal -Identity "" + ``` + + For example: + + ```powershell + New-ServicePrincipal -AppId $AzureADApp.AppId -ObjectId $AzureADApp.Id -DisplayName "SP for Azure AD App ExO PowerShell CBA" + + $SP = Get-ServicePrincipal -Identity "SP for Azure AD App ExO PowerShell CBA" + ``` + + For detailed syntax and parameter information, see [New-ServicePrincipal](/powershell/module/exchange/new-serviceprincipal). + +3. In Exchange Online PowerShell or Security & Compliance PowerShell, run the following command to add the service principal as a member of the custom role group: + + ```powershell + Add-RoleGroupMember -Identity "" -Member <$.Identity | $.ObjectId | $.Id> + ``` + + For example: + + ```powershell + Add-RoleGroupMember -Identity "Contoso View-Only Recipients" -Member $SP.Identity + ``` - ![The role assignments page after to added the app to the role.](media/exo-app-only-auth-app-assigned-to-role.png) + For detailed syntax and parameter information, see [Add-RoleGroupMember](/powershell/module/exchange/add-rolegroupmember). diff --git a/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md deleted file mode 100644 index 07ca275413..0000000000 --- a/exchange/docs-conceptual/basic-auth-connect-to-eop-powershell.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "Basic auth - Connect to Exchange Online Protection PowerShell" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -localization_priority: Normal -ms.assetid: -ROBOTS: NOINDEX -description: "Use remote PowerShell to connect to a standalone Exchange Online Protection (EOP) organization without mailboxes in Exchange Online." ---- - -# Bssic auth - Connect to Exchange Online Protection PowerShell - -> [!NOTE] -> The connection instructions in this article [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Exchange Online Protection PowerShell. For instructions, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). - -In standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes, standalone EOP PowerShell allows you to manage your EOP organization from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to EOP. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the EOP cmdlets into your local Windows PowerShell session so that you can use them. - -The following introductory video shows you how to connect to and use Exchange Online Protection PowerShell: - -[Use Exchange Online Protection PowerShell](https://videoplayercdn.osi.office.net/hub/?csid=ux-cms-en-us-msoffice&uuid=9cb28006-c2cb-45b6-b72e-eeed8767dee7&AutoPlayVideo=false) - -**Note:** This video applies to Exchange Online PowerShell and EOP PowerShell. When you connect to your organization, be sure to specify the correct URL (*ConnectionUri* value). The required URL is different for Exchange Online and standalone EOP organizations. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- **The procedures in this article are only for EOP organizations that don't have Exchange Online mailboxes** (for example, you have a standalone EOP subscription that protects your on-premises email environment). If you have a Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to Exchange Online Protection PowerShell. The same features are available in [Exchange Online PowerShell](exchange-online-powershell.md). - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in standalone EOP](/microsoft-365/security/office-365-security/feature-permissions-in-eop). - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)\* - - Windows Server 2008 R2 SP1\* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. - - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ```powershell - Set-ExecutionPolicy RemoteSigned - ``` - - For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note**: You must temporarily enable WinRM to run the following commands. You can enable it by running the command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -> [!TIP] -> Having problems? Ask for help in the [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351) forum. - -## Connect to Exchange Online Protection - -1. On your local computer, open Windows PowerShell and run the following command: - - ```powershell - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**. - -2. Run the following command: - - ```powershell - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - - For Office 365 Germany, use the _ConnectionUri_ value: `https://ps.protection.outlook.de/powershell-liveid/` - - - For on-premises Exchange organization with Exchange Enterprise CAL with Services licenses, use the _ConnectionUri_ value: `https://outlook.office365.com/powershell-liveid/` - -3. Run the following command: - - ```powershell - Import-PSSession $Session -DisableNameChecking - ``` - - > [!NOTE] - > Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: - - ```powershell - Remove-PSSession $Session - ``` - -## How do you know this worked? - -After Step 3, the Exchange Online Protection cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online Protection cmdlet, for example, **Get-TransportRule**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Exchange Online Protection. - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- The account you use to connect to Exchange Online Protection PowerShell must be represented as a [mail user in EOP](/microsoft-365/security/office-365-security/manage-mail-users-in-eop) (created manually or by directory synchronization). If the account is not visible in the Exchange admin center (EAC) as a mail user at **Recipients** \> **Contacts**, you'll receive the following error when you try to connect: - - > Import-PSSession : Running the Get-Command command in a remote session reported the following error: Processing data for a remote command failed with the following error message: The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - -- The **New-PSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - > The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Exchange Online Protection PowerShell endpoint. - -## See also - -The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - -- [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) -- [New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession) -- [Import-PSSession](/powershell/module/microsoft.powershell.utility/import-pssession) -- [Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession) -- [Set-ExecutionPolicy](/powershell/module/microsoft.powershell.security/set-executionpolicy) diff --git a/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md deleted file mode 100644 index 6c1e0d75d4..0000000000 --- a/exchange/docs-conceptual/basic-auth-connect-to-exo-powershell.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "Basic auth - Connect to Exchange Online PowerShell" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -localization_priority: Priority -ms.collection: Strat_EX_Admin -ms.custom: -ms.assetid: -ROBOTS: NOINDEX -search.appverid: MET150 -description: "Learn how to use remote PowerShell to connect to Exchange Online with Basic authentication." ---- - -# Basic auth - Connect to Exchange Online PowerShell - -> [!NOTE] -> The connection instructions in this article [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - -Exchange Online PowerShell allows you to manage your Exchange Online settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Exchange Online. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the Exchange Online cmdlets into your local Windows PowerShell session so that you can use them. - -The following introductory video shows you how to connect to and use Exchange Online PowerShell: - -[Use Exchange Online PowerShell](https://videoplayercdn.osi.office.net/hub/?csid=ux-cms-en-us-msoffice&uuid=9cb28006-c2cb-45b6-b72e-eeed8767dee7&AutoPlayVideo=false) - -**Note:** This video applies to Exchange Online PowerShell and EOP PowerShell. When you connect to your organization, be sure to specify the correct URL (*ConnectionUri* value). The required URL is different for Exchange Online and standalone EOP organizations. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](/exchange/permissions-exo/permissions-exo). - -- If your on-premises Exchange organization has Exchange Enterprise CAL with Services licenses, you can use the instructions in this article to connect to your EOP organization. - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)* - - Windows Server 2008 R2 SP1* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. - - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ```powershell - Set-ExecutionPolicy RemoteSigned - ``` - - For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note**: You must temporarily enable WinRM to run the following commands. You can enable it by running the command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Connect to Exchange Online PowerShell - -1. On your local computer, open Windows PowerShell and run the following command. - - ```powershell - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box, type your work or school account and password, and then click **OK**. - -2. Run the following command: - - ```powershell - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - - For Office 365 operated by 21Vianet, use the _ConnectionUri_ value: `https://partner.outlook.cn/PowerShell` - - For Office 365 Germany, use the _ConnectionUri_ value: `https://outlook.office.de/powershell-liveid/` - - For Microsoft 365 GCC High, use the _ConnectionUri_ value: `https://outlook.office365.us/powershell-liveid/` - - For Microsoft 365 DoD, use the _ConnectionUri_ value: `https://webmail.apps.mil/powershell-liveid` - - - If you're behind a proxy server, run this command first: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. - - Then, add the following parameter and value to the end of the $Session = ... command: `-SessionOption $ProxyOptions`. - - For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). - -3. Run the following command: - - ```powershell - Import-PSSession $Session -DisableNameChecking - ``` - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command. - -```powershell -Remove-PSSession $Session -``` - -## How do you know this worked? - -After Step 3, the Exchange Online cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online cmdlet, for example, **Get-Mailbox**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Exchange Online. - -- The account you use to connect to Exchange Online must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. - -- If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a non-federated account in Microsoft 365 to connect to Exchange Online PowerShell. - -## See also - -The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - -- [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) -- [New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession) -- [Import-PSSession](/powershell/module/microsoft.powershell.utility/import-pssession) -- [Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession) -- [Set-ExecutionPolicy](/powershell/module/microsoft.powershell.security/set-executionpolicy) - -For more information about managing Microsoft 365, see [Manage Microsoft 365 and Office 365](/Office365/). diff --git a/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md b/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md deleted file mode 100644 index 4bfcc1285e..0000000000 --- a/exchange/docs-conceptual/basic-auth-connect-to-scc-powershell.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: "Basic auth - Connect to Security & Compliance Center PowerShell" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -localization_priority: Normal -ms.assetid: -ROBOTS: NOINDEX -search.appverid: MET150 -description: "Learn how to connect to Security & Compliance Center PowerShell." ---- - -# Basic auth - Connect to Security & Compliance Center PowerShell - -> [!NOTE] -> The connection instructions in this article [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163) due to the security concerns around Basic authentication. Instead, you should use the Exchange Online PowerShell V2 module (the EXO V2 module) to connect to Security & Compliance Center PowerShell. For instructions, see [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md). - -Security & Compliance Center PowerShell allows you to manage your Microsoft 365 Defender portal and Microsoft 365 compliance center settings from the command line. You use Windows PowerShell on your local computer to create a remote PowerShell session to Security & Compliance Center PowerShell. It's a simple three-step process where you enter your Microsoft 365 credentials, provide the required connection settings, and then import the Security & Compliance Center PowerShell cmdlets into your local Windows PowerShell session so that you can use them. - -> [!NOTE] -> The procedures in this article won't work if: -> -> - Your account uses multi-factor authentication (MFA). -> -> - Your organization uses federated authentication. -> -> - A location condition in an Azure Active Directory conditional access policy restricts your access to trusted IPs. -> -> In these scenarios, you need to download and use the Exchange Online PowerShell V2 module (EXO V2 module) to connect to Security & Compliance Center PowerShell. For instructions, see [Connect to Security & Compliance Center PowerShell using the EXO V2 module](connect-to-scc-powershell.md). -> -> Some features in the Microsoft 365 Defender portal and Microsoft 365 compliance center (for example, mailbox archiving) link to existing functionality in Exchange Online. To use PowerShell with these features, you need to connect to Exchange Online PowerShell instead of Security & Compliance Center PowerShell. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) and [Permissions in the Microsoft 365 security center](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)* - - Windows Server 2008 R2 SP1* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: - - > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. - - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): - - ```powershell - Set-ExecutionPolicy RemoteSigned - ``` - - For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note** You must temporarily enable WinRM to run the following commands. You can enable it by running the command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -## Connect to Security & Compliance Center PowerShell - -1. On your local computer, open Windows PowerShell and run the following command: - - ```powershell - $UserCredential = Get-Credential - ``` - - In the **Windows PowerShell Credential Request** dialog box that appears, type your work or school account and password, and then click **OK**. - -2. Run the following command: - - ```powershell - $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://ps.compliance.protection.outlook.com/powershell-liveid/ -Credential $UserCredential -Authentication Basic -AllowRedirection - ``` - - **Notes**: - - - For Office 365 Germany, use the _ConnectionUri_ value: `https://ps.compliance.protection.outlook.de/powershell-liveid/`. - - For Microsoft 365 GCC High, use the _ConnectionUri_ value: `https://ps.compliance.protection.office365.us/powershell-liveid/`. - - For Microsoft 365 DoD, use the _ConnectionUri_ value: `https://l5.ps.compliance.protection.office365.us/powershell-liveid/`. - -3. Run the following command: - - ```powershell - Import-PSSession $Session -DisableNameChecking - ``` - - If you want to connect to Security & Compliance Center PowerShell in the same window as an active Exchange Online PowerShell connection, you need to add the Prefix parameter and value (for example, `-Prefix "CC"`) to the end of this command to prevent cmdlet name collisions (both environments share some cmdlets with the same names). - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: - -```powershell -Remove-PSSession $Session -``` - -## How do you know this worked? - -After Step 3, the Security & Compliance Center PowerShell cmdlets are imported into your local Windows PowerShell session as tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run a Security & Compliance Center cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. - -If you receive errors, check the following requirements: - -- A common problem is an incorrect password. Run the three steps again and pay close attention to the user name and password you enter in Step 1. - -- Verify that your account has permission to access the Microsoft 365 Defender portal or the Microsoft 365 compliance center. For details, see [Give users access to the Security & Compliance Center](/microsoft-365/security/office-365-security/grant-access-to-the-security-and-compliance-center). - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Security & Compliance Center PowerShell. - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- The **New-PSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - > The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Security & Compliance Center PowerShell endpoint. - -## See also - -The cmdlets that you use in this article are Windows PowerShell cmdlets. For more information about these cmdlets, see the following articles. - -- [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) -- [New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession) -- [Import-PSSession](/powershell/module/microsoft.powershell.utility/import-pssession) -- [Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession) -- [Set-ExecutionPolicy](/powershell/module/microsoft.powershell.security/set-executionpolicy) diff --git a/exchange/docs-conceptual/client-advanced-settings.md b/exchange/docs-conceptual/client-advanced-settings.md new file mode 100644 index 0000000000..dc5a85dd20 --- /dev/null +++ b/exchange/docs-conceptual/client-advanced-settings.md @@ -0,0 +1,436 @@ +--- +title: PowerShell advanced settings for Microsoft Purview Information Protection client +ms.author: yangczhang +author: zhang-yangchen +manager: aashishr +ms.date: 04/17/2024 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: purview +ms.reviewer: +ms.localizationpriority: high +ms.collection: +- tier3 +- purview-compliance +search.appverid: +description: "Security & Compliance PowerShell advanced settings for Microsoft Purview Information Protection client." +--- + +# Advanced settings for Microsoft Purview Information Protection client + +This article contains the [Security & Compliance PowerShell](/powershell/exchange/office-365-scc/office-365-scc-powershell) advanced settings that are supported by [Microsoft Purview Information Protection client](/purview/information-protection-client) when you use the following cmdlets: + +- [New-Label](/powershell/module/exchange/new-label) or [Set-Label](/powershell/module/exchange/set-label) +- [New-LabelPolicy](/powershell/module/exchange/new-labelpolicy) or [Set-LabelPolicy](/powershell/module/exchange/set-labelpolicy) + +The advanced settings that are supported by sensitivity labels built into Microsoft 365 apps and services are included on the cmdlet page itself. You might also find useful [PowerShell tips for specifying the advanced settings](/purview/create-sensitivity-labels#powershell-tips-for-specifying-the-advanced-settings). + +|Advanced settings for labels|Description| +|---|---| +|[Color](#color)|Specify a color for the label| +|[DefaultSubLabelId](#defaultsublabelid)|Specify a default sublabel for a parent label| + +|Advanced settings for label policies|Description| +|---|---| +|[AdditionalPPrefixExtensions](#additionalpprefixextensions)|Support for changing \.PFILE to P\| +|[EnableAudit](#enableaudit)|Prevent audit data from being sent to Microsoft Purview| +|[EnableContainerSupport](#enablecontainersupport)|Enable removal of encryption from PST, rar, 7zip, and MSG files| +|[EnableCustomPermissions](#enablecustompermissions)|Turn off custom permissions in File Explorer| +|[EnableCustomPermissionsForCustomProtectedFiles](#enablecustompermissionsforcustomprotectedfiles)|For files encrypted with custom permissions, always display custom permissions to users in File Explorer| +|[EnableGlobalization](#enableglobalization) |Turn on classification globalization features| +|[JustificationTextForUserText](#justificationtextforusertext) |Customize justification prompt texts for modified labels| +|[LogMatchedContent](#logmatchedcontent)|Send information type matches to Microsoft Purview| +|[OfficeContentExtractionTimeout](#officecontentextractiontimeout)|Configure the auto-labeling timeout for Office files| +|[PFileSupportedExtensions](#pfilesupportedextensions)|Change which file types to protect| +|[ReportAnIssueLink](#reportanissuelink) |Add "Report an Issue" for users| +|[ScannerMaxCPU](#scannermaxcpu) |Limit CPU consumption| +|[ScannerMinCPU](#scannermincpu) |Limit CPU consumption| +|[ScannerConcurrencyLevel](#scannerconcurrencylevel)|Limit the number of threads used by the scanner| +|[ScannerFSAttributesToSkip](#scannerfsattributestoskip) |Skip or ignore files during scans depending on file attributes) +|[SharepointWebRequestTimeout](#sharepointwebrequesttimeout)|Configure SharePoint timeouts| +|[SharepointFileWebRequestTimeout](#sharepointfilewebrequesttimeout )|Configure SharePoint timeouts| +|[UseCopyAndPreserveNTFSOwner](#usecopyandpreserventfsowner) |Preserve NTFS owners during labeling| + +## AdditionalPPrefixExtensions + +This advanced property to change \.PFILE to P\ is supported by File Explorer, PowerShell, and by the scanner. All apps have similar behavior. + +- Key: **AdditionalPPrefixExtensions** + +- Value: **\** + +Use the following table to identify the string value to specify: + +| String value| Client and scanner| +|---|---| +|\*|All PFile extensions become P\| +|\| Default value behaves like the default encryption value.| +|ConvertTo-Json(".dwg", ".zip")|In addition to the previous list, ".dwg" and ".zip" become P\| + +With this setting, the following extensions always become **P\**: ".txt", ".xml", ".bmp", ".jt", ".jpg", ".jpeg", ".jpe", ".jif", ".jfif", ".jfi", ".png", ".tif", ".tiff", ".gif"). Notable exclusion is that "ptxt" does not become "txt.pfile". + +This setting requires the advanced setting *PFileSupportedExtension* to be enabled. + +**Example 1**: PowerShell command to behave like the default behavior where Protect ".dwg" becomes ".dwg.pfile": + +```PowerShell +Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions =""} +``` + +**Example 2**: PowerShell command to change all PFile extensions from generic encryption to native encryption when the files are labeled and encrypted: + +```PowerShell +Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions ="*"} +``` + +**Example 3**: PowerShell command to change ".dwg" to ".pdwg" when using this service protect this file: + +```PowerShell +Set-LabelPolicy -AdvancedSettings @{ AdditionalPPrefixExtensions =ConvertTo-Json(".dwg")} +``` + +## Color + +Use this advanced setting to set a color for a label. To specify the color, enter a hex triplet code for the red, green, and blue (RGB) components of the color. For example, #40e0d0 is the RGB hex value for turquoise. + +If you need a reference for these codes, you'll find a helpful table from the [\](https://developer.mozilla.org/docs/Web/CSS/color_value) page from the MSDN web docs. You also find these codes in many applications that let you edit pictures. For example, Microsoft Paint lets you choose a custom color from a palette and the RGB values are automatically displayed, which you can then copy. + +To configure the advanced setting for a label's color, enter the following strings for the selected label: + +- Key: **color** + +- Value: **\** + +Example PowerShell command, where your label is named "Public": + +```PowerShell +Set-Label -Identity Public -AdvancedSettings @{color="#40e0d0"} +``` + +## DefaultSubLabelId + +When you add a sublabel to a label, users can no longer apply the parent label to a document or email. By default, users select the parent label to see the sublabels that they can apply, and then select one of those sublabels. If you configure this advanced setting, when users select the parent label, a sublabel is automatically selected and applied for them: + +- Key: **DefaultSubLabelId** + +- Value: **\** + +Example PowerShell command, where your parent label is named "Confidential" and the "All Employees" sublabel has a GUID of 8faca7b8-8d20-48a3-8ea2-0f96310a848e: + +```PowerShell +Set-Label -Identity "Confidential" -AdvancedSettings @{DefaultSubLabelId="8faca7b8-8d20-48a3-8ea2-0f96310a848e"} +``` + +## EnableAudit + +By default, the information protection client sends audit data to Microsoft Purview where you can view this data in [activity explorer](/purview/data-classification-activity-explorer). + +To change this behavior, use the following advanced setting: + +- Key: **EnableAudit** + +- Value: **False** + +For example, if your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"} +``` + +Then on local computers that run the information protection client, delete the following folder: **%localappdata%\Microsoft\MSIP\mip** + +To enable the client to send audit log data again, change the advanced setting value to **True**. You do not need to manually create the **%localappdata%\Microsoft\MSIP\mip** folder again on your client computers. + +## EnableContainerSupport + +This setting enables the information protection client to remove encryption from PST, rar, and 7zip files. + +- Key: **EnableContainerSupport** + +- Value: **True** + +For example, if your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableContainerSupport="True"} +``` + +## EnableCustomPermissions + +By default, users see an option named **Protect with custom permissions** when they right-click in File Explorer with the file labeler. This option lets them set their own encryption settings that can override any encryption settings that you might have included with a label configuration. Users can also see an option to remove encryption. When you configure this setting, users do not see these options. + +Use the following setting so users don't see these options: + +- Key: **EnableCustomPermissions** + +- Value: **False** + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableCustomPermissions="False"} +``` + +## EnableCustomPermissionsForCustomProtectedFiles + +When you configure the advanced client setting *EnableCustomPermissions* to turn off custom permissions in File Explorer, by default, users are not able to see or change custom permissions that are already set in an encrypted document. + +However, there's another advanced client setting that you can specify so that in this scenario, users can see and change custom permissions for an encrypted document when they use File Explorer and right-click the file. + +- Key: **EnableCustomPermissionsForCustomProtectedFiles** + +- Value: **True** + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableCustomPermissionsForCustomProtectedFiles="True"} +``` + +## EnableGlobalization + +Classification globalization features including increased accuracy for East Asian languages and support for double-byte characters. These enhancements are provided only for 64-bit processes, and are turned off by default. + +Turn on these features for your policy specify the following strings: + +- Key: **EnableGlobalization** + +- Value: `True` + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableGlobalization="True"} +``` + +To turn off support again and revert to the default, set the **EnableGlobalization** advanced setting to an empty string. + +## JustificationTextForUserText + +Customize the justification prompts that are displayed when end users change sensitivity labels on files. + +For example, as an administrator, you might want to remind your users not to add any customer identifying information into this field. + +To modify the default **Other** option that users can select in the dialog box, use the *JustificationTextForUserText* advanced setting. Set the value to the text you want to use instead. + +Example PowerShell command, where your label policy is named "Global": + +``` PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{JustificationTextForUserText="Other (please explain) - Do not enter sensitive info"} +``` + +## LogMatchedContent + +By default, the information protection client doesn't send content matches for sensitive info types to Microsoft Purview, which can then be displayed in [activity explorer](/purview/data-classification-activity-explorer). The scanner always sends this information. For more information about this additional information that can be sent, see [Content matches for deeper analysis](/azure/information-protection/reports-aip#content-matches-for-deeper-analysis). + +To send content matches when sensitive information types are sent, use the following advanced setting in a label policy: + +- Key: **LogMatchedContent** + +- Value: **True** + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{LogMatchedContent="True"} +``` + +## OfficeContentExtractionTimeout + +By default, the scanner's auto-labeling timeout on Office files is 3 seconds. + +If you have a complex Excel file with many sheets or rows, 3 seconds might not be enough to automatically apply labels. To increase this timeout for the selected label policy, specify the following strings: + +- Key: **OfficeContentExtractionTimeout** + +- Value: Seconds, in the following format: `hh:mm:ss`. + +> [!IMPORTANT] +> We recommend that you don't raise this timeout to higher than 15 seconds. + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{OfficeContentExtractionTimeout="00:00:15"} +``` + +The updated timeout applies to auto-labeling on all Office files. + +## PFileSupportedExtensions + +With this setting, you can change which file types are encrypted but you cannot change the default encryption level from native to generic. For example, for users running the file labeler, you can change the default setting so that only Office files and PDF files are encrypted instead of all file types. But you cannot change these file types to be generically encrypted with a .pfile file name extension. + +- Key: **PFileSupportedExtensions** + +- Value: **\** + +Use the following table to identify the string value to specify: + +| String value|Client|Scanner| +|---|---|---| +|\*|Default value: Apply encryption to all file types|Apply encryption to all file types| +|ConvertTo-Json(".jpg", ".png")|In addition to Office file types and PDF files, apply encryption to the specified file name extensions | In addition to Office file types and PDF files, apply encryption to the specified file name extensions + +**Example 1**: PowerShell command for the scanner to encrypt all file types, where your label policy is named "Scanner": + +```PowerShell +Set-LabelPolicy -Identity Scanner -AdvancedSettings @{PFileSupportedExtensions="*"} +``` + +**Example 2**: PowerShell command for the scanner to encrypt .txt files and .csv files in addition to Office files and PDF files, where your label policy is named "Scanner": + +```PowerShell +Set-LabelPolicy -Identity Scanner -AdvancedSettings @{PFileSupportedExtensions=ConvertTo-Json(".txt", ".csv")} +``` + +## ReportAnIssueLink + +When you specify the following advanced client setting, users see a **Report an Issue** option that they can select from the **Help and Feedback** client dialog box in the file labeler. Specify an HTTP string for the link. For example, a customized web page that you have for users to report issues, or an email address that goes to your help desk. + +To configure this advanced setting, enter the following strings for the selected label policy: + +- Key: **ReportAnIssueLink** + +- Value: **\** + +Example value for a website: `https://support.contoso.com` + +Example value for an email address: `mailto:helpdesk@contoso.com` + +Example PowerShell command, where your label policy is named "Global": + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{ReportAnIssueLink="mailto:helpdesk@contoso.com"} +``` + +## ScannerMaxCPU + +> [!IMPORTANT] +> We recommend limiting CPU consumption by using the advanced settings *ScannerMaxCPU* and *ScannerMinCPU* instead of *ScannerConcurrencyLevel* that's supported for backwards compatibility. +> +> If the older advanced setting is specified,*ScannerMaxCPU* and *ScannerMinCPU* advanced settings are ignored. + +Use this advanced setting in conjunction with *ScannerMinCPU* to limit CPU consumption on the scanner computer. + +- Key: **ScannerMaxCPU** + +- Value: \** + +The value is set to **100** by default, which means there is no limit of maximum CPU consumption. In this case, the scanner process will try to use all available CPU time to maximize your scan rates. + +If you set **ScannerMaxCPU** to less than 100, the scanner will monitor the CPU consumption over the last 30 minutes. If the average CPU crossed the limit you set, it will start to reduce the number of threads allocated for new files. + +The limit on the number of threads will continue as long as CPU consumption is higher than the limit set for **ScannerMaxCPU**. + +## ScannerMinCPU + +> [!IMPORTANT] +> We recommend limiting CPU consumption by using the advanced settings *ScannerMaxCPU* and *ScannerMinCPU* instead of *ScannerConcurrencyLevel* that's supported for backwards compatibility. +> +> If the older advanced setting is specified,*ScannerMaxCPU* and *ScannerMinCPU* advanced settings are ignored. + +Used only if *ScannerMaxCPU* is not equal to 100, and cannot be set to a number that is higher than the **ScannerMaxCPU** value. + +We recommend keeping **ScannerMinCPU** set at least 15 points lower than the value of *ScannerMaxCPU*. + +The value is set to **50** by default, which means that if CPU consumption in the last 30 minutes when lower than this value, the scanner will start adding new threads to scan more files in parallel, until the CPU consumption reaches the level you have set for *ScannerMaxCPU*-15. + +## ScannerConcurrencyLevel + +> [!IMPORTANT] +> We recommend limiting CPU consumption by using the advanced settings *ScannerMaxCPU* and *ScannerMinCPU* instead of *ScannerConcurrencyLevel* that's supported for backwards compatibility. +> +> When this older advanced setting is specified,*ScannerMaxCPU* and *ScannerMinCPU* advanced settings are ignored. + +By default, the scanner uses all available processor resources on the computer running the scanner service. If you need to limit the CPU consumption while this service is scanning, specify the number of concurrent threads that the scanner can run in parallel. The scanner uses a separate thread for each file that it scans, so this throttling configuration also defines the number of files that can be scanned in parallel. + +When you first configure the value for testing, we recommend you specify 2 per core, and then monitor the results. For example, if you run the scanner on a computer that has 4 cores, first set the value to 8. If necessary, increase or decrease that number, according to the resulting performance you require for the scanner computer and your scanning rates. + +- Key: **ScannerConcurrencyLevel** + +- Value: **\** + +Example PowerShell command, where your label policy is named "Scanner": + +```PowerShell +Set-LabelPolicy -Identity Scanner -AdvancedSettings @{ScannerConcurrencyLevel="8"} +``` + +## ScannerFSAttributesToSkip + +By default, the information protection scanner scans all relevant files. However, you might want to define specific files to be skipped, such as for archived files or files that have been moved. + +Enable the scanner to skip specific files based on their file attributes by using the **ScannerFSAttributesToSkip** advanced setting. In the setting value, list the file attributes that will enable the file to be skipped when they are all set to **true**. This list of file attributes uses the AND logic. + +Example PowerShell commands, where your label policy is named "Global". + +**Skip files that are both read-only and archived** + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{ ScannerFSAttributesToSkip =" FILE_ATTRIBUTE_READONLY, FILE_ATTRIBUTE_ARCHIVE"} +``` + +**Skip files that are either read-only or archived** + +To use an OR logic, run the same property multiple times. For example: + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{ ScannerFSAttributesToSkip =" FILE_ATTRIBUTE_READONLY"} +Set-LabelPolicy -Identity Global -AdvancedSettings @{ ScannerFSAttributesToSkip =" FILE_ATTRIBUTE_ARCHIVE"} +``` + +> [!TIP] +> We recommend that you consider enabling the scanner to skip files with the following attributes: +> +> - FILE_ATTRIBUTE_SYSTEM +> - FILE_ATTRIBUTE_HIDDEN +> - FILE_ATTRIBUTE_DEVICE +> - FILE_ATTRIBUTE_OFFLINE +> - FILE_ATTRIBUTE_RECALL_ON_DATA_ACCESS +> - FILE_ATTRIBUTE_RECALL_ON_OPEN +> - FILE_ATTRIBUTE_TEMPORARY + +For a list of all file attributes that can be defined in the **ScannerFSAttributesToSkip** advanced setting, see the [Win32 File Attribute Constants](/windows/win32/fileio/file-attribute-constants) + +## SharepointWebRequestTimeout + +By default, the timeout for SharePoint interactions is two minutes, after which the attempted information protection client operation fails. Control this timeout using the *SharepointWebRequestTimeout* and *SharepointFileWebRequestTimeout* advanced settings, using an **hh:mm:ss** syntax to define the timeouts. + +Specify a value to determine the timeout for all information protection client web requests to SharePoint. The default is minutes. + +For example, if your policy is named **Global**, the following sample PowerShell command updates the web request timeout to 5 minutes. + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{SharepointWebRequestTimeout="00:05:00"} +``` + +## SharepointFileWebRequestTimeout + +By default, the timeout for SharePoint interactions is two minutes, after which the attempted information protection client operation fails. Control this timeout using the *SharepointWebRequestTimeout* and *SharepointFileWebRequestTimeout* advanced settings, using an **hh:mm:ss** syntax to define the timeouts. + +Specify the timeout value for SharePoint files via information protection client web requests. The default is 15 minutes. + +For example, if your policy is named **Global**, the following sample PowerShell command updates the file web request timeout to 10 minutes. + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{SharepointFileWebRequestTimeout="00:10:00"} +``` + +## UseCopyAndPreserveNTFSOwner + +> [!NOTE] +> This feature is currently in PREVIEW. The [Azure Preview Supplemental Terms](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) include additional legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability. + +By default, the information protection client doesn't preserve the NTFS owner that was defined before applying a sensitivity label. + +To ensure that the NTFS owner value is preserved, set the *UseCopyAndPreserveNTFSOwner* advanced setting to **true** for the selected label policy. + +> [!CAUTION] +> For the scanner: Define this advanced setting only when you can ensure a low-latency, reliable network connection between the scanner and the scanned repository. A network failure during the automatic labeling process can cause the file to be lost. + +Example PowerShell command, where your label policy is named "Global" + +```PowerShell +Set-LabelPolicy -Identity Global -AdvancedSettings @{UseCopyAndPreserveNTFSOwner ="true"} +``` diff --git a/exchange/docs-conceptual/cmdlet-property-sets.md b/exchange/docs-conceptual/cmdlet-property-sets.md index bb2def48c0..bbd2cf89d9 100644 --- a/exchange/docs-conceptual/cmdlet-property-sets.md +++ b/exchange/docs-conceptual/cmdlet-property-sets.md @@ -1,36 +1,35 @@ --- -title: Property sets in Exchange Online PowerShell V2 cmdlets +title: Property sets in Exchange Online PowerShell module cmdlets ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 9/1/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -ms.reviewer: navgupta -localization_priority: Priority +ms.reviewer: +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Admins can lear about the property sets that are available in the Get-EXO* cmdlets in the Exchange Online PowerShell V2 module." +description: "Admins can lear about the property sets that are available in the nine exclusive Get-EXO cmdlets in the Exchange Online PowerShell V2 module and V3 module." --- -# Property sets in Exchange Online PowerShell V2 cmdlets +# Property sets in Exchange Online PowerShell module cmdlets -This article describes the property sets that are available in the **Get-EXO\*** cmdlets in the [Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). For more information about property sets, see [Properties and property sets in the EXO V2 module](exchange-online-powershell-v2.md#properties-and-property-sets-in-the-exo-v2-module). +This article describes the property sets that are available in the nine exclusive **Get-EXO\*** [cmdlets in the Exchange Online PowerShell module](exchange-online-powershell-v2.md#cmdlets-in-the-exchange-online-powershell-module). For more information about property sets, see [Properties and property sets in the Exchange Online PowerShell module](exchange-online-powershell-v2.md#properties-and-property-sets-in-the-exchange-online-powershell-module). -For more information about filtering in the EXO V2 module, see [Filters in the EXO V2 module](filters-v2.md). +For more information about filtering with cmdlets in the module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). + + > [!TIP] + > Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). ## Get-EXOCasMailbox property sets The available property sets for the **Get-EXOCasMailbox** cmdlet and the properties they contain are described in the following table: -
- -**** - |PropertySet|Properties| |---|---| |**Minimum**|ActiveSyncEnabled
DisplayName
ECPEnabled
EmailAddresses
EwsEnabled
ExchangeVersion
Guid
Identity
ImapEnabled
MAPIEnabled
Name
OWAEnabled
OrganizationId
PopEnabled
PrimarySmtpAddress
ServerLegacyDN| @@ -40,7 +39,6 @@ The available property sets for the **Get-EXOCasMailbox** cmdlet and the propert |**Mapi**|ExternalDirectoryObjectId
Guid
Identity
MAPIBlockOutlookExternalConnectivity
MAPIBlockOutlookNonCachedMode
MAPIBlockOutlookRpcHttp
MAPIBlockOutlookVersions
MAPIEnabled
MapiHttpEnabled
Name
OrganizationId| |**Pop**|ExternalDirectoryObjectId
Guid
Identity
Name
OrganizationId
PopEnableExactRFC822Size
PopEnabled
PopMessagesRetrievalMimeFormat
PopSuppressReadReceipt
PopUseProtocolDefaults| |**ProtocolSettings**|ExternalDirectoryObjectId
ExternalImapSettings
ExternalPopSettings
ExternalSmtpSettings
Guid
Identity
InternalImapSettings
InternalPopSettings
InternalSmtpSettings
Name
OrganizationId| -| **Note**: The following **Get-CasMailbox** parameters aren't available on **Get-EXOCasMailbox**: @@ -58,10 +56,6 @@ For more information, see: The available property sets for the **Get-EXOMailbox** cmdlet and the properties they contain are described in the following table: -
- -**** - |PropertySet|Properties| |---|---| |**Minimum**|Alias
DisplayName
DistinguishedName
EmailAddresses
ExchangeVersion
ExternalDirectoryObjectId
Guid
Id
Name
OrganizationId
PrimarySmtpAddress
RecipientType
RecipientTypeDetails
UserPrincipalName| @@ -81,7 +75,6 @@ The available property sets for the **Get-EXOMailbox** cmdlet and the properties |**SCL**|AntispamBypassEnabled
ExternalDirectoryObjectId
SCLDeleteEnabled
SCLDeleteThreshold
SCLJunkEnabled
SCLJunkThreshold
SCLQuarantineEnabled
SCLQuarantineThreshold
SCLRejectEnabled
SCLRejectThreshold| |**SoftDelete**|ExternalDirectoryObjectId
IncludeInGarbageCollection
IsInactiveMailbox
IsSoftDeletedByDisable
IsSoftDeletedByRemove
WhenSoftDeleted| |**StatisticsSeed**|ArchiveDatabaseGuid
DatabaseGuid
ExchangeGuid
ExternalDirectoryObjectId| -| **Note**: The following **Get-Mailbox** parameters aren't available on **Get-EXOMailbox**: @@ -100,15 +93,10 @@ For more information, see: The available property sets for the **Get-EXOMailboxStatistics** cmdlet and the properties they contain are described in the following table: -
- -**** - |PropertySet|Properties| |---|---| |**Minimum**|DeletedItemCount
DisplayName
ItemCount
MailboxGuid
TotalDeletedItemSize
TotalItemSize| |**All**|AssociatedItemCount
AttachmentTableAvailableSize
AttachmentTableTotalSize
DatabaseIssueWarningQuota
DatabaseName
DatabaseProhibitSendQuota
DatabaseProhibitSendReceiveQuota
DeletedItemCount
DisconnectDate
DisconnectReason
DisplayName
DumpsterMessagesPerFolderCountReceiveQuota
DumpsterMessagesPerFolderCountWarningQuota
ExternalDirectoryOrganizationId
FastIsEnabled
FolderHierarchyChildrenCountReceiveQuota
FolderHierarchyChildrenCountWarningQuota
FolderHierarchyDepthReceiveQuota
FolderHierarchyDepthWarningQuota
FoldersCountReceiveQuota
FoldersCountWarningQuota
IsAbandonedMoveDestination
IsArchiveMailbox
IsDatabaseCopyActive
IsHighDensityShard
IsMoveDestination
IsQuarantined
ItemCount
LastLoggedOnUserAccount
LastLogoffTime
LastLogonTime
LegacyDN
MailboxGuid
MailboxMessagesPerFolderCountReceiveQuota
MailboxMessagesPerFolderCountWarningQuota
MailboxType
MailboxTypeDetail
MessageTableAvailableSize
MessageTableTotalSize
NamedPropertiesCountQuota
NeedsToMove
OtherTablesAvailableSize
OtherTablesTotalSize
OwnerADGuid
QuarantineClients
QuarantineDescription
QuarantineEnd
QuarantineFileVersion
QuarantineLastCrash
ResourceUsageRollingAvgDatabaseReads
ResourceUsageRollingAvgRop
ResourceUsageRollingClientTypes
ServerName
StorageLimitStatus
SystemMessageCount
SystemMessageSize
SystemMessageSizeShutoffQuota
SystemMessageSizeWarningQuota
TotalDeletedItemSize
TotalItemSize| -| For more information, see: @@ -119,10 +107,6 @@ For more information, see: The available property sets for the **Get-EXORecipient** cmdlet and the properties they contain are described in the following table: -
- -**** - |PropertySet|Properties| |---|---| |**Minimum**|ExchangeVersion
ExternalDirectoryObjectID
Name
OrganizationId
RecipientType
RecipientTypeDetails| @@ -130,7 +114,6 @@ The available property sets for the **Get-EXORecipient** cmdlet and the properti |**Custom**|CustomAttribute1
CustomAttribute2
CustomAttribute3
CustomAttribute4
CustomAttribute5
CustomAttribute6
CustomAttribute7
CustomAttribute8
CustomAttribute9
CustomAttribute10
CustomAttribute11
CustomAttribute12
CustomAttribute13
CustomAttribute14
CustomAttribute15
ExtensionCustomAttribute1
ExtensionCustomAttribute2
ExtensionCustomAttribute3
ExtensionCustomAttribute4
ExtensionCustomAttribute5| |**MailboxMove**|MailboxMoveBatchName
MailboxMoveFlags
MailboxMoveRemoteHostName
MailboxMoveSourceMDB
MailboxMoveStatus
MailboxMoveTargetMDB| |**Policy**|ActiveSyncMailboxPolicy
ActiveSyncMailboxPolicyIsDefaulted
AddressBookPolicy
EmailAddressPolicyEnabled
ManagedFolderMailboxPolicy
OwaMailboxPolicy
PoliciesExcluded
PoliciesIncluded
RetentionPolicy
SharingPolicy
ShouldUseDefaultRetentionPolicy
UMMailboxPolicy| -| **Note**: The following **Get-Recipient** parameters aren't available on **Get-EXORecipient**: diff --git a/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md new file mode 100644 index 0000000000..2f484fd336 --- /dev/null +++ b/exchange/docs-conceptual/connect-exo-powershell-managed-identity.md @@ -0,0 +1,595 @@ +--- +title: Use Azure managed identities to connect to Exchange Online PowerShell +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 8/24/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +ms.localizationpriority: high +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn about using the Exchange Online PowerShell V3 module and Azure managed identity to connect to Exchange Online PowerShell." +--- + +# Use Azure managed identities to connect to Exchange Online PowerShell + +Using the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module), you can connect to Exchange Online PowerShell using a user-assigned or system assigned Azure managed identity. For more information about managed identities, see [What are managed identities for Azure resources?](/entra/identity/managed-identities-azure-resources/overview). + +Unlike other connection methods using the Exchange Online PowerShell module, you can't run the connection commands in a Windows PowerShell session on your local computer. Instead, you connect in the context of the Azure resource that's associated with the managed identity (for example, an Azure automation account or an Azure Virtual Machine). + +The rest of this article explains how to connect using managed identity, and the requirements for creating and configuring the proper resources with managed identities in Azure. + +> [!NOTE] +> In Exchange Online PowerShell, you can't use the procedures in this article with the following Microsoft 365 Group cmdlets: +> +> - [New-UnifiedGroup](/powershell/module/exchange/new-unifiedgroup) +> - [Remove-UnifiedGroup](/powershell/module/exchange/remove-unifiedgroup) +> - [Remove-UnifiedGroupLinks](/powershell/module/exchange/remove-unifiedgrouplinks) +> - [Add-UnifiedGroupLinks](/powershell/module/exchange/add-unifiedgrouplinks) +> +> You can use Microsoft Graph to replace most of the functionality from those cmdlets. For more information, see [Working with groups in Microsoft Graph](/graph/api/resources/groups-overview). +> +> REST API connections in the V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + +## Connect to Exchange Online PowerShell using system-assigned managed identity + +After you've [Created and configured a system-assigned managed identity](#create-and-configure-a-system-assigned-managed-identity), use the following syntax to connect to Exchange Online PowerShell: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization .onmicrosoft.com +``` + +For example: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com +``` + +The rest of this section explains how to connect using supported Azure resources. For example: + +- A PowerShell runbook on the Azure Automation account with system-assigned managed identity. +- An Azure VM with a system-assigned managed identity. + +After the resource is connected, the Exchange Online PowerShell cmdlets and parameters are available based on the RBAC role you assigned in [Step 5: Assign Microsoft Entra roles to the managed identity](#step-5-assign-microsoft-entra-roles-to-the-managed-identity) + +### Connect to Exchange Online PowerShell using Azure Automation accounts with system-assigned managed identity + +Create a PowerShell runbook on the automation account. For instructions, see [Manage runbooks in Azure Automation](/azure/automation/manage-runbooks). + +The first command in the PowerShell runbook must be the `Connect-ExchangeOnline...` command as described in the beginning of this section. For example: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com +``` + +After that, as a test, you can start with as simple, low-impact command in the runbook before moving on to more complex commands or scripts. For example: + +```powershell +Get-AcceptedDomain | Format-Table Name +``` + +After you've successfully created, saved, and published the PowerShell runbook, do the following steps to run it in the future: + +1. On the **Automation accounts** page at , select the Automation account. +2. In the details flyout that opens, start typing "Runbooks" in the ![Search icon.](media/search-icon.png) **Search** box, and then select **Runbooks** from results. +3. On the **Runbooks** flyout that opens, select the runbook. +4. On the details page of the runbook, select **Start**. + +### Connect to Exchange Online PowerShell using Azure VMs with system-assigned managed identity + +In a Windows PowerShell window in the Azure VM, use the command as described in the beginning of this section. For example: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com +``` + +## Connect to Exchange Online PowerShell using user-assigned managed identity + +After you've [created and configured a user-assigned managed identity](#create-and-configure-a-user-assigned-managed-identity), use the following syntax to connect to Exchange Online PowerShell: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization .onmicrosoft.com -ManagedIdentityAccountId +``` + +You get the \ value from [Step 3: Store the user-assigned managed identity in a variable](#step-3-store-the-user-assigned-managed-identity-in-a-variable). + +The rest of this section explains how to connect using supported Azure resources. For example: + +- A PowerShell runbook on the Azure Automation account with user-assigned managed identity. +- An Azure VM with a user-assigned managed identity. + +After the resource is connected, the Exchange Online PowerShell cmdlets and parameters are available based on the RBAC role you assigned in [Step 6: Assign Microsoft Entra roles to the managed identity](#step-6-assign-microsoft-entra-roles-to-the-managed-identity). + +### Connect to Exchange Online PowerShell using Azure Automation accounts with user-assigned managed identities + +Create a PowerShell runbook on the automation account. For instructions, see [Manage runbooks in Azure Automation](/azure/automation/manage-runbooks). + +The first command in the PowerShell runbook must be the `Connect-ExchangeOnline...` command as described in the beginning of this section. For example: + +```powershell +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com -ManagedIdentityAccountId bf6dcc76-4331-4942-8d50-87ea41d6e8a1 +``` + +You get the ManagedIdentityAccount value from [Step 3: Store the user-assigned managed identity in a variable](#step-3-store-the-user-assigned-managed-identity-in-a-variable). + +After that, as a test, you can start with as simple, low-impact command in the runbook before moving on to more complex commands or scripts. For example: + +```powershell +Get-AcceptedDomain | Format-Table Name +``` + +After you've successfully created the PowerShell runbook, do the following steps to run it in the future: + +1. On the **Automation accounts** page at , select the Automation account. +2. In the details flyout that opens, start typing "Runbooks" in the ![Search icon.](media/search-icon.png) **Search** box, and then select **Runbooks** from results. +3. On the **Runbooks** flyout that opens, select the runbook. +4. On the details page of the runbook, select **Start**. + +### Connect to Exchange Online PowerShell using Azure VMs with system-assigned managed identities + +In a Windows PowerShell window in the Azure VM, use the command as described in the beginning of this section. For example: + +```powershell +$MI_ID = (Get-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2").ClientId + +Connect-ExchangeOnline -ManagedIdentity -Organization contoso.onmicrosoft.com -ManagedIdentityAccountId $MI_ID +``` + +## Create and configure a system-assigned managed identity + +The steps are: + +1. [(Optional) Create a resource with system-assigned managed identity](#step-1-create-a-resource-with-system-assigned-managed-identity) +2. [Store the system-assigned managed identity in a variable](#step-2-store-the-system-assigned-managed-identity-in-a-variable) +3. [Add the Exchange Online PowerShell module to the managed identity](#step-3-add-the-exchange-online-powershell-module-to-the-managed-identity) +4. [Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online](#step-4-grant-the-exchangemanageasapp-api-permission-for-the-managed-identity-to-call-exchange-online) +5. [Assign Microsoft Entra roles to the managed identity](#step-5-assign-microsoft-entra-roles-to-the-managed-identity) + +After you complete the steps, you're ready to [Connect to Exchange Online PowerShell using system-assigned managed identity](#connect-to-exchange-online-powershell-using-system-assigned-managed-identity). + +### Step 1: Create a resource with system-assigned managed identity + +If you're going to use an existing resource that's already configured with system-assigned managed identity, you can skip to the [next step](#step-2-store-the-system-assigned-managed-identity-in-a-variable). The following resource types are supported: + +- Azure Automation accounts +- Azure virtual machines (VMs) + +#### Create Azure Automation accounts with system-assigned managed identities + +Create an Automation account that's configured for system-assigned managed identity by using the instructions at [Quickstart: Create an Automation account using the Azure portal](/azure/automation/quickstarts/create-azure-automation-account-portal). + +- Automation accounts are available on the **Automation accounts** page at . + +- When you create the Automation account, system-assigned managed identity is selected by default on the **[Advanced](/azure/automation/quickstarts/create-azure-automation-account-portal#advanced)** tab of the details of the Automation account. + +- To enable the system-assigned managed identity on an existing Automation account, see [Enable system-assigned managed identity](/azure/automation/quickstarts/enable-managed-identity#enable-system-assigned-managed-identity). + +To create the Automation account with system-assigned managed identity in [Azure PowerShell](/powershell/azure/what-is-azure-powershell), do the following steps: + +1. Connect to [Azure Az PowerShell](/powershell/azure/install-az-ps) by running the following command: + + ```powershell + Connect-AzAccount + ``` + +2. If necessary, create an Azure resource group to use with the Automation account by running the following command: + + ```powershell + New-AzResourceGroup -Name "" -Location "" + ``` + + - \ is the unique name for the new resource group. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + New-AzResourceGroup -Name "ContosoRG" -Location "West US" + ``` + + For complete instructions, see [Create resource groups](/azure/azure-resource-manager/management/manage-resource-groups-powershell#create-resource-groups). + +3. Use the following syntax to create an Automation account with system-assigned managed identity: + + ```powershell + New-AzAutomationAccount -Name "" -ResourceGroupName "" -Location "" -AssignSystemIdentity + ``` + + - \ is the unique name for the new Automation account. + - \ is the name of the existing resource group that you want to use. Valid values are visible in the output of the command: `Get-AzResourceGroup`. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + New-AzAutomationAccount -Name "ContosoAzAuto1" -ResourceGroupName "ContosoRG" -Location "West US" -AssignSystemIdentity + ``` + + For detailed syntax and parameter information, see [New-AzAutomationAccount](/powershell/module/az.automation/new-azautomationaccount). + +#### Configure Azure VMs with system-assigned managed identities + +For instructions, see the following articles: + +- [System-assigned managed identity in the Azure portal](/entra/identity/managed-identities-azure-resources/qs-configure-portal-windows-vm#system-assigned-managed-identity) + +- [System-assigned managed identity in PowerShell](/entra/identity/managed-identities-azure-resources/qs-configure-powershell-windows-vm#system-assigned-managed-identity) + +### Step 2: Store the system-assigned managed identity in a variable + +Use the following syntax to store the Id (GUID) value of the managed identity in a variable that you'll use in the upcoming steps in [Azure Az PowerShell](/powershell/azure/install-az-ps). + +```powershell +$MI_ID = (Get-AzADServicePrincipal -DisplayName "").Id +``` + +Where \ is the name of the Azure Automation account or the Azure VM. For example: + +```powershell +$MI_ID = (Get-AzADServicePrincipal -DisplayName "ContosoAzAuto1").Id +``` + +To verify that the variable was captured successfully, run the command `$MI_ID`. The output should be a GUID value (for example, 9f164909-3007-466e-a1fe-28d20b16e2c2). + +For detailed syntax and parameter information, see [Get-AzADServicePrincipal](/powershell/module/az.resources/get-azadserviceprincipal). + +### Step 3: Add the Exchange Online PowerShell module to the managed identity + +#### Add the Exchange Online PowerShell module to Azure Automation accounts with system-assigned managed identities + +> [!TIP] +> If the following procedure in the Azure portal doesn't work for you, try the **New-AzAutomationModule** command in Azure PowerShell that's described after the Azure portal procedure. + +1. On the **Automation accounts** page at , select the Automation account. +2. In the details flyout that opens, start typing "Modules" in the ![Search icon.](media/search-icon.png) **Search** box, and then select **Modules** from results. +3. On the **Modules** flyout that opens, select ![Add module icon.](media/add-icon.png) **Add a module**. +4. On the **Add a module** page that opens, configure the following settings: + - **Upload a module file**: Select **Browse from gallery**. + - **PowerShell module file**: Select **Click here to browse from gallery**: + 1. In the **Browse Gallery** page that opens, start typing "ExchangeOnlineManagement" in the ![Search icon.](media/search-icon.png) **Search** box, press Enter, and then select **ExchangeOnlineManagement** from the results. + 2. On the details page that opens, select **Select** to return to the **Add a module** page. + - **Runtime version**: Select **5.1** or **7.1 (Preview)**. To add both versions, repeat the steps in this section to add and select the other runtime version for the module. + + When you're finished, select **Import**. + + ![Screenshot of adding a module to an Automation account in the Azure portal.](media/mi-add-exo-module.png) + +5. Back on the **Modules** flyout, start typing "ExchangeOnlineManagement" in the ![Search icon.](media/search-icon.png) **Search** box to see the **Status** value. When the module import is complete, the value is **Available**. + +To add the module to the Automation account in Azure PowerShell, use the following syntax: + +```powershell +New-AzAutomationModule -ResourceGroupName "" -AutomationAccountName "" -Name ExchangeOnlineManagement -ContentLinkUri https://www.powershellgallery.com/packages/ExchangeOnlineManagement/ +``` + +- \ is the name of the resource group that's already assigned to the Automation account. +- \ is the name of the Automation account. +- \ is the current version of the ExchangeOnlineManagement module. To see the latest General Availability (GA; non-Preview) version of the module, run the following command in Windows PowerShell: `Find-Module ExchangeOnlineManagement`. To see the latest Preview release, run the following command: `Find-Module ExchangeOnlineManagement -AllowPrerelease`. +- Currently, the PowerShell procedures don't give you a choice for the runtime version (it's 5.1). + +For example: + +```powershell +New-AzAutomationModule -ResourceGroupName "ContosoRG" -AutomationAccountName "ContosoAzAuto1" -Name ExchangeOnlineManagement -ContentLinkUri https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.1.0 +``` + +To verify that the module imported successfully, run the following command: + +```powershell +Get-AzAutomationModule -ResourceGroupName ContosoRG -AutomationAccountName ContosoAzAuto1 -Name ExchangeOnlineManagement +``` + +During the import, the ProvisioningState property will have the value Creating. When the module import is complete, the value will change to Succeeded. + +For detailed syntax and parameter information, see [New-AzAutomationModule](/powershell/module/az.automation/new-azautomationmodule). + +#### Add the Exchange Online PowerShell module to Azure VMs with system-assigned managed identities + +Install the Exchange Online PowerShell module in the Azure VM. For instructions, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). + +### Step 4: Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online + +The procedures in this step require the Microsoft Graph PowerShell SDK. For installation instructions, see [Install the Microsoft Graph PowerShell SDK](/powershell/microsoftgraph/installation). + +1. Run the following command to connect to Microsoft Graph PowerShell with the required permissions: + + ```powershell + Connect-MgGraph -Scopes AppRoleAssignment.ReadWrite.All,Application.Read.All + ``` + + If a **Permissions requested** dialog opens, select **Consent on behalf of your organization**, and then click **Accept**. + +2. Run the following command to verify that the Office 365 Exchange Online resource is available in Microsoft Entra ID: + + ```powershell + Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" + ``` + + If the command returns no results, the next step won't work. See the subsection at the end of this section to fix the issue before you continue. + +3. Run the following commands to grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online: + + ```powershell + $AppRoleID = "dc50a0fb-09a3-484d-be87-e023b12c6440" + + $ResourceID = (Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'").Id + + New-MgServicePrincipalAppRoleAssignment -ServicePrincipalId $MI_ID -PrincipalId $MI_ID -AppRoleId $AppRoleID -ResourceId $ResourceID + ``` + + - `$MI_ID` is the Id (GUID) value of the managed identity that you stored in a variable in [Step 2](#step-2-store-the-system-assigned-managed-identity-in-a-variable). + - `$AppRoleID` is the Id (GUID) value of the **Exchange.ManageAsApp** API permission that's the same in every organization. + - `$ResourceID` is the Id (GUID) value of the **Office 365 Exchange Online** resource in Microsoft Entra ID. The AppId value is the same in every organization, but the Id value is different in every organization. + +For detailed syntax and parameter information, see the following articles: + +- [Connect-MgGraph](/powershell/module/microsoft.graph.applications/new-mgserviceprincipalapproleassignment) +- [Get-MgServicePrincipal](/powershell/module/microsoft.graph.applications/get-mgserviceprincipal) +- [New-MgServicePrincipalAppRoleAssignment](/powershell/module/microsoft.graph.applications/new-mgserviceprincipalapproleassignment) + +#### What to do if the Office 365 Exchange Online resource is not available in Microsoft Entra ID + +If the following command returns no results: + +```powershell +Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" +``` + +Do the following steps: + +1. Register an application in Microsoft Entra ID as described in [Step 1: Register the application in Microsoft Entra ID](app-only-auth-powershell-v2.md#step-1-register-the-application-in-microsoft-entra-id). +2. Assign the Office 365 Exchange Online \> Exchange.ManageAsApp API permission to the application using the "Modify the app manifest" method as described in [Step 2: Assign API permissions to the application](app-only-auth-powershell-v2.md#step-2-assign-api-permissions-to-the-application). + +After you do these steps, run the **Get-MgServicePrincipal** command again to confirm that the Office 365 Exchange Online resource is available in Microsoft Entra ID. + +For even more information, run the following command to verify that the Exchange.ManageAsApp API permission (`dc50a0fb-09a3-484d-be87-e023b12c6440`) is available in the Office 365 Exchange Online resource: + +```powershell +Get-MgServicePrincipal -Filter "AppId eq '00000002-0000-0ff1-ce00-000000000000'" | Select-Object -ExpandProperty AppRoles | Format-Table Value,Id +``` + +Now that the Office 365 Exchange Online resource is available, return to Step 4.3 in this section. + +### Step 5: Assign Microsoft Entra roles to the managed identity + +The supported Microsoft Entra roles are described in the following list: + +- [Compliance Administrator](/entra/identity/role-based-access-control/permissions-reference#compliance-administrator) +- [Exchange Administrator](/entra/identity/role-based-access-control/permissions-reference#exchange-administrator)¹ +- [Exchange Recipient Administrator](/entra/identity/role-based-access-control/permissions-reference#exchange-recipient-administrator) +- [Global Administrator](/entra/identity/role-based-access-control/permissions-reference#global-administrator)¹ ² +- [Global Reader](/entra/identity/role-based-access-control/permissions-reference#global-reader) +- [Helpdesk Administrator](/entra/identity/role-based-access-control/permissions-reference#helpdesk-administrator) +- [Security Administrator](/entra/identity/role-based-access-control/permissions-reference#security-administrator)¹ +- [Security Reader](/entra/identity/role-based-access-control/permissions-reference#security-reader) + +¹ The Global Administrator and Exchange Administrator roles provide the required permissions for any task in Exchange Online PowerShell. For example: + +- Recipient management. +- Security and protection features. For example, anti-spam, anti-malware, anti-phishing, and the associated reports. + +The Security Administrator role does not have the necessary permissions for those same tasks. + +² Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +For general instructions about assigning roles in Microsoft Entra ID, see [Assign Microsoft Entra roles to users](/entra/identity/role-based-access-control/manage-roles-portal). + +1. In Microsoft Entra admin center at , start typing **roles and administrators** in the **Search** box at the top of the page, and then select **Microsoft Entra roles and administrators** from the results in the **Services** section. + + ![Screenshot that shows Microsoft Entra roles and administrators in the Search results on the on the home page of the Azure portal.](media/exo-app-only-auth-find-roles-and-administrators.png) + + Or, to go directly to the **Microsoft Entra roles and administrators** page, use . + +2. On the **Roles and administrators** page, find and select one of the supported roles by _clicking on the name of the role_ (not the check box) in the results. For example, find and select the **Exchange administrator** role. + + ![Find and select a supported Exchange Online PowerShell role by clicking on the role name.](media/exo-app-only-auth-find-and-select-supported-role.png) + +3. On the **Assignments** page that opens, select **Add assignments**. + + ![Select Add assignments on the role assignments page for Exchange Online PowerShell.](media/exo-app-only-auth-role-assignments-click-add-assignments.png) + +4. In the **Add assignments** flyout that opens, find and select the managed identity you created or identified in [Step 1](#step-1-create-a-resource-with-system-assigned-managed-identity). + + When you're finished, select **Add**. + +5. Back on the **Assignments** page, verify that the role has been assigned to the managed identity. + +To assign a role to the managed identity in Microsoft Graph PowerShell, do the following steps: + +1. Run the following command to connect to Microsoft Graph PowerShell with the required permissions: + + ```powershell + Connect-MgGraph -Scopes RoleManagement.ReadWrite.Directory + ``` + + If a **Permissions requested** dialog opens, select **Consent on behalf of your organization**, and then click **Accept**. + +2. Use the following syntax to assign the required Microsoft Entra role to the managed identity: + + ```powershell + $RoleID = (Get-MgRoleManagementDirectoryRoleDefinition -Filter "DisplayName eq ''").Id + + New-MgRoleManagementDirectoryRoleAssignment -PrincipalId $MI_ID -RoleDefinitionId $RoleID -DirectoryScopeId "/" + ``` + + - \ is the name of the Microsoft Entra role as listed earlier in this section. + - `$MI_ID` is the Id (GUID) value of the managed identity that you stored in a variable in [Step 2](#step-2-store-the-system-assigned-managed-identity-in-a-variable). + + For example: + + ```powershell + $RoleID = (Get-MgRoleManagementDirectoryRoleDefinition -Filter "DisplayName eq 'Exchange Administrator'").Id + + New-MgRoleManagementDirectoryRoleAssignment -PrincipalId $MI_ID -RoleDefinitionId $RoleID -DirectoryScopeId "/" + ``` + +For detailed syntax and parameter information, see the following articles: + +- [Connect-MgGraph](/powershell/module/microsoft.graph.applications/new-mgserviceprincipalapproleassignment). +- [New-MgRoleManagementDirectoryRoleAssignment](/powershell/module/microsoft.graph.identity.governance/new-mgrolemanagementdirectoryroleassignment) + +## Create and configure a user-assigned managed identity + +The steps are: + +1. [(Optional) Create a user-assigned managed identity](#step-1-create-a-user-assigned-managed-identity) +2. [(Optional) Create a resource with user-assigned managed identity](#step-2-create-a-resource-with-user-assigned-managed-identity) +3. [Store the user-assigned managed identity in a variable](#step-3-store-the-user-assigned-managed-identity-in-a-variable) +4. [Add the Exchange Online PowerShell module to the managed identity](#step-4-add-the-exchange-online-powershell-module-to-the-managed-identity) +5. [Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online](#step-5-grant-the-exchangemanageasapp-api-permission-for-the-managed-identity-to-call-exchange-online) +6. [Assign Microsoft Entra roles to the managed identity](#step-6-assign-microsoft-entra-roles-to-the-managed-identity) + +After you complete the steps, you're ready to [Connect to Exchange Online PowerShell using user-assigned managed identity](#connect-to-exchange-online-powershell-using-user-assigned-managed-identity). + +### Step 1: Create a user-assigned managed identity + +If you already have an existing user-assigned managed identity that you're going to use, you can skip to the [next step](#step-2-create-a-resource-with-user-assigned-managed-identity) to create a resource with the user-assigned managed identity. + +Otherwise, create the user-assigned managed identity in the Azure portal by using the instructions at [Create a user-assigned managed identity](/entra/identity/managed-identities-azure-resources/how-manage-user-assigned-managed-identities?pivots=identity-mi-methods-azp#create-a-user-assigned-managed-identity). + +To create the user-assigned managed identity in [Azure PowerShell](/powershell/azure/what-is-azure-powershell), do the following steps: + +1. Connect to [Azure Az PowerShell](/powershell/azure/install-az-ps) by running the following command: + + ```powershell + Connect-AzAccount + ``` + +2. If necessary, create an Azure resource group to use with the user-assigned managed identity by running the following command: + + ```powershell + New-AzResourceGroup -Name "" -Location "" + ``` + + - \ is the unique name for the new resource group. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + New-AzResourceGroup -Name "ContosoRG2" -Location "West US" + ``` + + For complete instructions, see [Create resource groups](/azure/azure-resource-manager/management/manage-resource-groups-powershell#create-resource-groups). + +3. Use the following syntax to create a user-assigned managed identity: + + ```powershell + New-AzUserAssignedIdentity -Name "" -ResourceGroupName "" -Location "" + ``` + + - \ is the unique name for the user-assigned managed identity. + - \ is the name of the existing resource group that you want to use. Valid values are visible in the output of the command: `Get-AzResourceGroup`. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + New-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2" -Location "West US" + ``` + + For detailed syntax and parameter information, see [New-AzUserAssignedIdentity](/powershell/module/az.managedserviceidentity/new-azuserassignedidentity). + +### Step 2: Create a resource with user-assigned managed identity + +If you're going to use an existing resource that's already configured with user-assigned managed identity, you can skip to the [next step](#step-3-store-the-user-assigned-managed-identity-in-a-variable). The following resource types are supported: + +- Azure Automation accounts +- Azure Virtual Machines (VMs) + +#### Create Azure Automation accounts with user-assigned managed identities + +Create an Automation account that's configured for user-assigned managed identity by using the instructions at [Quickstart: Create an Automation account using the Azure portal](/azure/automation/quickstarts/create-azure-automation-account-portal). + +- Automation accounts are available on the **Automation accounts** page at . + +- Be sure to change the managed identity selection on the **[Advanced](/azure/automation/quickstarts/create-azure-automation-account-portal#advanced)** tab to **User assigned**. + +- To enable the user-assigned managed identity on an existing Automation account, see [Add user-assigned managed identity](/azure/automation/quickstarts/enable-managed-identity#add-user-assigned-managed-identity). + +To create the Automation account with user-assigned managed identity in [Azure PowerShell](/powershell/azure/what-is-azure-powershell), do the following steps: + +1. Connect to [Azure Az PowerShell](/powershell/azure/install-az-ps) by running the following command: + + ```powershell + Connect-AzAccount + ``` + +2. Use the following syntax to create an Automation account with user-assigned managed identity: + + ```powershell + $UAMI = (Get-AzUserAssignedIdentity -Name "" -ResourceGroupName "").Id + + New-AzAutomationAccount -Name "" -ResourceGroupName "" -Location "" -AssignUserIdentity $UAMI + ``` + + - \ is the name of the user-assigned managed identity that you want to use. + - \ is the name of the resource group that's assigned to the user-assigned managed identity. Valid values are visible in the output of the command: `Get-AzResourceGroup`. + - \ is the unique name for the new Automation account. + - \ is the name of the resource group that you want to use, which could be the same value as \. + - \ is a valid value from the command: `Get-AzLocation | Format-Table Name`. + + For example: + + ```powershell + $UAMI = (Get-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2").Id + + New-AzAutomationAccount -Name "ContosoAzAuto2" -ResourceGroupName "ContosoRG2" -Location "West US" -AssignUserIdentity $UAMI + ``` + + For detailed syntax and parameter information, see [New-AzAutomationAccount](/powershell/module/az.automation/new-azautomationaccount). + +#### Configure Azure VMs with user-assigned managed identities + +For instructions, see the following articles: + +- [User-assigned managed identity in the Azure portal](/entra/identity/managed-identities-azure-resources/qs-configure-portal-windows-vm#user-assigned-managed-identity) +- [User-assigned managed identity in PowerShell](/entra/identity/managed-identities-azure-resources/qs-configure-powershell-windows-vm#user-assigned-managed-identity) + +### Step 3: Store the user-assigned managed identity in a variable + +Use the following syntax in [Azure Az PowerShell](/powershell/azure/install-az-ps) to store the ClientId value of the user-assigned managed identity in variable that you'll use in the upcoming steps: + +```powershell +$MI_ID = (Get-AzUserAssignedIdentity -Name "" -ResourceGroupName "").ClientId +``` + +- \ is the name of the user-assigned managed identity. +- \ is the name of the resource group that's associated with the user-assigned managed identity. + +For example: + +```powershell +$MI_ID = (Get-AzUserAssignedIdentity -Name "ContosoMI1" -ResourceGroupName "ContosoRG2").ClientId +``` + +To verify that the variable was captured successfully, run the command `$MI_ID`. The output should be a GUID value (for example, bf6dcc76-4331-4942-8d50-87ea41d6e8a1). + +For detailed syntax and parameter information, see [Get-AzUserAssignedIdentity](/powershell/module/az.managedserviceidentity/get-azuserassignedidentity). + +### Step 4: Add the Exchange Online PowerShell module to the managed identity + +The steps for user-assigned managed identity are the same as in [System-assigned managed identity Step 3](#step-3-add-the-exchange-online-powershell-module-to-the-managed-identity). + +> [!NOTE] +> Be sure to use the correct values for the resource group name and automation account name! + +### Step 5: Grant the Exchange.ManageAsApp API permission for the managed identity to call Exchange Online + +The steps for user-assigned managed identity are the same as in [System-assigned managed identity Step 4](#step-4-grant-the-exchangemanageasapp-api-permission-for-the-managed-identity-to-call-exchange-online). + +Although the managed identity values were obtained differently for user-assigned vs. system-assigned, we're using the same variable name in the command (`$MI_ID`), so the command works for both types of managed identities. + +### Step 6: Assign Microsoft Entra roles to the managed identity + +The steps for user-assigned managed identity are basically the same as in [System-assigned managed identity Step 5](#step-5-assign-microsoft-entra-roles-to-the-managed-identity). + +In the Azure portal, be sure to select the [user-assigned managed identity](#step-2-create-a-resource-with-user-assigned-managed-identity) as the managed identity to assign the Microsoft Entra role to (not the automation account itself). + +The PowerShell command works for both user-assigned and system-assigned managed identities. Although the managed identity values were obtained differently for user-assigned vs. system-assigned, we're using the same variable name in the command (`$MI_ID`). diff --git a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md index 0a4a25abdb..75be6dcc6a 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-powershell.md @@ -1,179 +1,475 @@ --- title: Connect to Exchange Online PowerShell author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -ms.reviewer: navgupta -localization_priority: Priority +ms.reviewer: +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell with modern authentication and/or multi-factor authentication (MFA)." +description: "Learn how to use the Exchange Online PowerShell V3 module to connect to Exchange Online PowerShell with modern authentication and/or multi-factor authentication (MFA)." --- # Connect to Exchange Online PowerShell -The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) uses modern authentication and works with multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the EXO V2 module, see [About the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). +This article contains instructions for how to connect to Exchange Online PowerShell using the Exchange Online PowerShell module with or without multi-factor authentication (MFA). -**This article contains instructions for how to connect to Exchange Online PowerShell using the EXO V2 module with or without MFA.** +The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the Exchange Online PowerShell module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). -To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163), see [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.md). +To connect to Exchange Online PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md) and [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). -To use the older Exchange Online Remote PowerShell Module to connect to Exchange Online PowerShell using MFA, see [V1 module - Connect to Exchange Online PowerShell using MFA](v1-module-mfa-connect-to-exo-powershell.md). Note that this older version of the module will eventually be retired. +To connect to Exchange Online PowerShell from C#, see [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.md). ## What do you need to know before you begin? -- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). +- The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). > [!NOTE] - > The rest of the instructions in the article assume that you've already installed the module. + > Remote PowerShell connections are deprecated in Exchange Online PowerShell. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). + > + > REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). - After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](/exchange/permissions-exo/permissions-exo). To find the permissions that are required to run specific Exchange Online cmdlets, see [Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md). -- If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection (EOP), your EOP PowerShell connection instructions are the same as Exchange Online PowerShell as described in this article. - > [!TIP] > Having problems? Ask in the [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542) forum. -## Connect to Exchange Online PowerShell using modern authentication with or without MFA +## Step 1: Load the Exchange Online PowerShell module + +> [!NOTE] +> If the module is already installed, you can typically skip this step and run **Connect-ExchangeOnline** without manually loading the module first. + +After you've [installed the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: + +```powershell +Import-Module ExchangeOnlineManagement +``` -These connection instructions use modern authentication and work with or without multi-factor authentication (MFA). +## Step 2: Connect and authenticate -For other sign in methods that are available in PowerShell 7, see the [PowerShell 7 log in experiences](#powershell-7-log-in-experiences) section later in this topic. +> [!NOTE] +> Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. -1. In a PowerShell window, load the EXO V2 module by running the following command: +The command that you need to run uses the following syntax: - ```powershell - Import-Module ExchangeOnlineManagement +```powershell +Connect-ExchangeOnline -UserPrincipalName [-ExchangeEnvironmentName ] [-ShowBanner:$false] [-LoadCmdletHelp] [-DelegatedOrganization ] [-SkipLoadingFormatData] [-DisableWAM] ``` - **Notes**: +For detailed syntax and parameter information, see [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline). - - If you've already [installed the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module), the previous command will work as written. - - You might be able to skip this step and run **Connect-ExchangeOnline** without loading the module first. +- _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). -2. The command that you need to run uses the following syntax: +- When you use the _ExchangeEnvironmentName_ parameter, you don't need use the _ConnectionUri_ or _AzureADAuthorizationEndPointUrl_ parameters. Common values for the _ExchangeEnvironmentName_ parameter are described in the following table: - ```powershell - Connect-ExchangeOnline -UserPrincipalName [-ShowBanner:$false] [-ExchangeEnvironmentName ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] - ``` + |Environment|Value| + |---|---| + |Microsoft 365 or Microsoft 365 GCC|n/a\*| + |Microsoft 365 GCC High|`O365USGovGCCHigh`| + |Microsoft 365 DoD|`O365USGovDoD`| + |Office 365 Germany|`O365GermanyCloud`| + |Office 365 operated by 21Vianet|`O365China`| - - _\_ is your account in user principal name format (for example, `navin@contoso.com`). - - When you use the _ExchangeEnvironmentName_ parameter, you don't need use the _ConnectionUri_ or _AzureADAuthorizationEndPointUrl_ parameters. For more information, see the parameter descriptions in [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline). - - The _DelegatedOrganization_ parameter specifies the customer organization that you want to manage as an authorized Microsoft Partner. For more information, see [Partners](/office365/servicedescriptions/office-365-platform-service-description/partners). - - If you're behind a proxy server, run this command first: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. Then, use the _PSSessionOption_ parameter with the value `$ProxyOptions`. For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). - - You can often omit the _UserPrincipalName_ parameter in the next step to enter both the username and password after you run the **Connect-ExchangeOnline** command. If it doesn't work, then you need to use the _UserPrincipalName_ parameter. - - If you aren't using MFA, you can often use the _Credential_ parameter instead of the _UserPrincipalName_ parameter. First, run the command `$Credential = Get-Credential`, enter your username and password, and then use the variable name for the _Credential_ parameter (`-Credential $Credential`). If it doesn't work, then you need to use the _UserPrincipalName_ parameter. + \* The required value `O365Default` is also the default value, so you don't need to use the _ExchangeEnvironmentName_ parameter in Microsoft 365 or Microsoft 365 GCC environments. - **This example connects to Exchange Online PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**: +- In version 3.7.0 or later, command line help for Exchange Online PowerShell cmdlets is no longer loaded by default. Use the _LoadCmdletHelp_ switch so help for Exchange Online PowerShell cmdlets is available to the **Get-Help** cmdlet. - ```powershell - Connect-ExchangeOnline -UserPrincipalName navin@contoso.com - ``` +- The _DelegatedOrganization_ parameter specifies the customer organization that you want to manage as an authorized Microsoft Partner. For more information, see the [connection examples later in this article](#connect-to-exchange-online-powershell-in-customer-organizations). - **This example connects to Exchange Online PowerShell in an Office 365 Germany organization**: +- Depending on the nature of your organization, you might be able to omit the _UserPrincipalName_ parameter in the connection command. Instead, you enter the username and password or select stored credentials after you run the **Connect-ExchangeOnline** command. If it doesn't work, then you need to use the _UserPrincipalName_ parameter. - ```powershell - Connect-ExchangeOnline -UserPrincipalName lukas@fabrikam.de -ExchangeEnvironmentName O365GermanyCloud - ``` +- If you aren't using MFA, you should be able to use the _Credential_ parameter instead of the _UserPrincipalName_ parameter. First, run the command `$Credential = Get-Credential`, enter your username and password, and then use the variable name for the _Credential_ parameter (`-Credential $Credential`). If it doesn't work, then you need to use the _UserPrincipalName_ parameter. - **This example connects to Exchange Online PowerShell in a Microsoft GCC High organization**: +- Use the _SkipLoadingFormatData_ switch to avoid errors when connecting to Exchange Online PowerShell from within a Windows service. - ```powershell - Connect-ExchangeOnline -UserPrincipalName laura@blueyonderairlines.us -ExchangeEnvironmentName O365USGovGCCHigh - ``` +- Using the module in PowerShell 7 requires version 2.0.4 or later. - **This example connects to Exchange Online PowerShell in a Microsoft 365 DoD organization**: +- In version 3.7.2 or later, the _DisableWAM_ switch is available to disable Web Account Manager (WAM) if you get WAM-related connection errors. - ```powershell - Connect-ExchangeOnline -UserPrincipalName julia@adatum.mil -ExchangeEnvironmentName O365USGovDoD - ``` +The connection examples in the following sections use modern authentication, and are incapable of using Basic authentication. - **This example connects to Exchange Online PowerShell to manage another tenant**: +### Connect to Exchange Online PowerShell with an interactive login prompt - ```powershell - Connect-ExchangeOnline -UserPrincipalName navin@contoso.com -DelegatedOrganization adatum.onmicrosoft.com - ``` +1. The following examples work in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: + + - **This example connects to Exchange Online PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com + ``` + + - **This example connects to Exchange Online PowerShell in a Microsoft GCC High organization**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName laura@blueyonderairlines.us -ExchangeEnvironmentName O365USGovGCCHigh + ``` + + - **This example connects to Exchange Online PowerShell in a Microsoft 365 DoD organization**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName julia@adatum.mil -ExchangeEnvironmentName O365USGovDoD + ``` + + - **This example connects to Exchange Online PowerShell in an Office 365 Germany organization**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName lukas@fabrikam.de -ExchangeEnvironmentName O365GermanyCloud + ``` -3. In the sign-in window that opens, enter your password, and then click **Sign in**. +2. In the sign-in window that opens, enter your password, and then click **Sign in**. ![Enter your password in the Sign in to your account window.](media/connect-exo-password-prompt.png) -4. **MFA only**: A verification code is generated and delivered based on the response option that's configured for your account (for example, a text message or the Microsoft Authenticator app on your device). + > [!NOTE] + > In PowerShell 7, browser-based single sign-on (SSO) is used by default, so the sign-in prompt opens in your default web browser instead of a standalone dialog. + +3. **MFA only**: A verification code is generated and delivered based on the response option that's configured for your account (for example, a text message or the Microsoft Authenticator app on your device). In the verification window that opens, enter the verification code, and then click **Verify**. ![Enter your verification code in the Sign in to your account window.](media/connect-exo-mfa-verify-prompt.png) -For detailed syntax and parameter information, see [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline). +#### PowerShell 7 exclusive connection methods -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command. +- In PowerShell 7 for **accounts without MFA**, this example prompts for credentials within the PowerShell window: -```powershell -Disconnect-ExchangeOnline -``` + ```powershell + Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com -InlineCredential + ``` -## PowerShell 7 log in experiences +- In PowerShell 7 for accounts with or without MFA, this example uses another computer to authenticate and complete the connection. Typically, you use this method on computers that don't have web browsers (users are unable to enter their credentials in PowerShell 7): -This section describes the log in experiences that are available in version 2.0.4 or later of the EXO V2 module in PowerShell 7. + 1. Run the following command on the computer where you want to connect: -For more information about the operating systems that are supported by the EXO V2 module in PowerShell 7, see [Supported operating systems for the EXO V2 module](exchange-online-powershell-v2.md#supported-operating-systems-for-the-exo-v2-module). + ```powershell + Connect-ExchangeOnline -Device + ``` -For detailed syntax and parameter information, see [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline). + The connection command waits at following output: + + > To sign in, use a web browser to open the page and enter the code \ to authenticate. + + Note the \ code value. + + 2. On any other device with a web browser and internet access, open and enter the \ code value from the previous step. -### Interactive scripting using browser-based single sign-on + 3. Enter your credentials on the resulting pages. + + 4. In the confirmation prompt, click **Continue**. The next message should indicate success, and you can close the browser or tab. + + 5. The command from step 1 continues to connect you to Exchange Online PowerShell. + +### Connect to Exchange Online PowerShell without a login prompt (unattended scripts) + +For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). + +### Connect to Exchange Online PowerShell in customer organizations + +For more information about partners and customer organizations, see the following topics: + +- [What is the Cloud Solution Provider (CSP) program?](/partner-center/csp-overview). +- [Introduction to granular delegated admin privileges (GDAP)](/partner-center/gdap-introduction) + +This example connects to customer organizations in the following scenarios: + +- Connect to a customer organization using a CSP account. +- Connect to a customer organization using a GDAP. +- Connect to a customer organization as a guest user. + + ```powershell + Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com -DelegatedOrganization adatum.onmicrosoft.com + ``` -Browser-based single sign-on (SSO) is the default log in method in PowerShell 7. The **Connect-ExchangeOnline** command opens the Azure AD login page in the default browser. After you enter your credentials, older Exchange Online cmdlets and EXO V2 module cmdlets are available in the resulting PowerShell session. +### Connect to Exchange Online PowerShell using managed identity -If you use the _UserPrincipalName_ parameter in the command, the UPN value is used on the login page in the browser. +For more information, see [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). + +- System-assigned managed identity: + + ```powershell + Connect-ExchangeOnline -ManagedIdentity -Organization "cohovinyard.onmicrosoft.com" + ``` + +- User-assigned assigned managed identity: + + ```powershell + Connect-ExchangeOnline -ManagedIdentity -Organization "constoso.onmicrosoft.com" -ManagedIdentityAccountId + ``` + +## Step 3: Disconnect when you're finished + +Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: ```powershell -Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com +Disconnect-ExchangeOnline ``` -### Device-based log in - -Use device-based log in when no browser is available (and therefore, you can't see the login page): +To silently disconnect without a confirmation prompt, run the following command: ```powershell -Connect-ExchangeOnline -Device +Disconnect-ExchangeOnline -Confirm:$false ``` -The command returns a URL and unique code that's tied to the session. You need to open the URL in a browser on any computer, and then enter the unique code. After you complete the login in the web browser, the session in the Powershell 7 window is authenticated via the regular Azure AD authentication flow, and the Exchange Online cmdlets are imported after few seconds. +> [!NOTE] +> The disconnect command will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. -### Inline credentials +## How do you know you've connected successfully? -You can enter your credentials directly in the PowerShell window without the need to go to the browser for SSO. +If you don't receive any errors, you've connected successfully. A quick test is to run an Exchange Online PowerShell cmdlet, for example, **Get-AcceptedDomain**, and see the results. -> [!NOTE] -> This method does not work with accounts that use multi-factor authentication. +If you receive errors, check the following requirements: + +- A common problem is an incorrect password. Run the connection steps again and pay close attention to the username and password that you use. + +- The account that you use to connect to must be enabled for PowerShell access. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). + +- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. + +- If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a non-federated account in Microsoft 365 to connect to Exchange Online PowerShell. + +- REST-based connections to Exchange Online PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For example, you might see the following error: + + > The term 'Update-ModuleManifest' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. + + For more information about the PowerShellGet and PackageManagement module requirements, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). -This method is an improvement on the _Credential_ parameter, because you don't need to store the credentials locally in a script, and you can enter the credentials directly in an interactive PowerShell session. +- After you connect, you might received an error that looks like this: + + > Could not load file or assembly 'System.IdentityModel.Tokens.Jwt,Version=\, Culture=neutral, PublicKeyToken=\'. Could not find or load a specific file. + + This error happens when the Exchange Online PowerShell module conflicts with another module that's imported into the runspace. Try connecting in a new Windows PowerShell window before importing other modules. + +## Appendix: Comparison of old and new connection methods + +This section attempts to compare older connection methods that have been replaced by the Exchange Online PowerShell module. The Basic authentication and OAuth token procedures are included for historical reference only and are no longer supported. + +### Connect without multi-factor authentication + +- **Exchange Online PowerShell module with interactive credential prompt**: ```powershell - Connect-ExchangeOnline -InlineCredential + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com ``` -## How do you know this worked? +- **Exchange Online PowerShell module without interactive credential prompt**: -The Exchange Online cmdlets are imported into your local PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online PowerShell cmdlet, for example, **Get-Mailbox**, and see the results. + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force -If you receive errors, check the following requirements: + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) -- A common problem is an incorrect password. Run the three steps again and pay close attention to the username and password that you use. + Connect-ExchangeOnline -Credential $o365cred + ``` -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Exchange Online. +- **Basic authentication**: -- The account that you use to connect to must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) -- If your organization uses federated authentication, and your identity provider (IDP) and/or security token service (STS) isn't publicly available, you can't use a federated account to connect to Exchange Online PowerShell. Instead, create and use a non-federated account in Microsoft 365 to connect to Exchange Online PowerShell. + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/ -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?BasicAuthToOAuthConversion=true -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect with multi-factor authentication + +- **Exchange Online PowerShell module with interactive credential prompt**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com + ``` + +- **Basic authentication**: Not available. + +- **New-PSSession with OAuth token**: Not available. + +### Connect to a customer organization with a CSP account + +- **Exchange Online PowerShell module**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com -DelegatedOrganization delegated.onmicrosoft.com + ``` + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/? DelegatedOrg=delegated.onmicrosoft.com&BasicAuthToOAuthConversion=true&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect to a customer organization using GDAP + +- **Exchange Online PowerShell module**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com -DelegatedOrganization delegated.onmicrosoft.com + ``` + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&BasicAuthToOAuthConversion=true&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect to a customer organization as a guest user + +- **Exchange Online PowerShell module**: + + ```powershell + Connect-ExchangeOnline -UserPrincipalName admin@contoso.onmicrosoft.com -DelegatedOrganization delegated.onmicrosoft.com + ``` + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?DelegatedOrg=delegated.onmicrosoft.com&BasicAuthToOAuthConversion=true&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@delegated.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect to run unattended scripts + +- **Exchange Online PowerShell module**: + + - **Certificate thumbprint**: + + > [!NOTE] + > The CertificateThumbprint parameter is supported only in Microsoft Windows. + + ```powershell + Connect-ExchangeOnline -CertificateThumbPrint "012THISISADEMOTHUMBPRINT" -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contoso.onmicrosoft.com" + ``` + + - **Certificate object**: + + ```powershell + Connect-ExchangeOnline -Certificate <%X509Certificate2Object%> -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contoso.onmicrosoft.com" + ``` + + - **Certificate file**: + + ```powershell + Connect-ExchangeOnline -CertificateFilePath "C:\Users\navin\Desktop\automation-cert.pfx" -CertificatePassword (ConvertTo-SecureString -String "" -AsPlainText -Force) -AppID "36ee4c6c-0812-40a2-b820-b22ebd02bce3" -Organization "contoso.onmicrosoft.com" + ``` + + For more information, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). + +- **Basic authentication**: + + ```powershell + $secpasswd = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $secpasswd) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/ -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +- **New-PSSession with OAuth token**: + + ```powershell + $oauthTokenAsPassword = ConvertTo-SecureString '' -AsPlainText -Force + + $o365cred = New-Object System.Management.Automation.PSCredential ("admin@contoso.onmicrosoft.com", $oauthTokenAsPassword) + + $Session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/PowerShell-LiveID/?BasicAuthToOAuthConversion=true&email=SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}@contoso.onmicrosoft.com -Credential $o365cred -Authentication Basic -AllowRedirection + + Import-PSSession $Session + ``` + +### Connect using managed identity + +- **Exchange Online PowerShell module**: + + - **System-assigned managed identity**: + + ```powershell + Connect-ExchangeOnline -ManagedIdentity -Organization "contoso.onmicrosoft.com" + ``` + + - **User-assigned managed identity**: + + ```powershell + Connect-ExchangeOnline -ManagedIdentity -Organization "contoso.onmicrosoft.com" -ManagedIdentityAccountId + ``` + + For more information, see [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). + +- **Basic authentication**: Not available. + +- **New-PSSession with OAuth token**: Not available. diff --git a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md index d5fb53d893..7e28d7e8a7 100644 --- a/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-online-protection-powershell.md @@ -1,156 +1,111 @@ --- title: Connect to Exchange Online Protection PowerShell author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 8/21/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -ms.reviewer: navgupta -localization_priority: Priority +ms.reviewer: +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V2 module to connect to standalone Exchange Online Protection PowerShell with modern authentication and/or multi-factor authentication (MFA)." +description: "Learn how to use the Exchange Online PowerShell V3 module to connect to standalone Exchange Online Protection PowerShell with modern authentication and/or multi-factor authentication (MFA)." --- # Connect to Exchange Online Protection PowerShell -The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) uses modern authentication and works with multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the EXO V2 module, see [About the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). +This article contains instructions for how to connect to Exchange Online Protection PowerShell using the Exchange Online PowerShell module with or without using multi-factor authentication (MFA). -**This article contains instructions for how to connect to Exchange Online Protection PowerShell using the EXO V2 module with or without using MFA.** +The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). -To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163), see [Basic auth - Connect to Exchange Online Protection PowerShell](basic-auth-connect-to-eop-powershell.md). +For more information about Exchange Online Protection PowerShell, see [Exchange Online Protection PowerShell](exchange-online-protection-powershell.md). -## What do you need to know before you begin? - -- **The procedures in this article are only for Microsoft 365 organizations that don't have Exchange Online mailboxes**. For example, you have a standalone EOP subscription that protects your on-premises email environment. If your Microsoft 365 subscription includes Exchange Online mailboxes, you can't connect to EOP PowerShell; instead, you [connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). +> [!NOTE] +> As of June 2020, the instructions for connecting to standalone Exchange Online Protection PowerShell and Exchange Online PowerShell are basically the same. If you use the **Connect-IPPSSession** cmdlet with the _ConnectionUri_ parameter value `https://ps.protection.outlook.com/powershell-liveid/`, you're redirected to the same `https://outlook.office365.com/powershell-liveid/` endpoint that's used by **Connect-ExchangeOnline** for Exchange Online PowerShell connections. +> +> Remote PowerShell connections in Exchange Online PowerShell are deprecated. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). +> +> REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). - If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for EOP, your EOP PowerShell connection instructions are the same as Exchange Online PowerShell. Use the Exchange Online PowerShell connection instructions in [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) instead of the instructions in this article. +## What do you need to know before you begin? -- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). The rest of the instructions in the article assume that you've already installed the module. +- The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in standalone EOP](/microsoft-365/security/office-365-security/feature-permissions-in-eop). +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in standalone EOP](/exchange/standalone-eop/manage-admin-role-group-permissions-in-eop). > [!TIP] > Having problems? Ask for help in the [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351) forum. -## Connect to Exchange Online Protection PowerShell using MFA and modern authentication - -If your account uses multi-factor authentication, use the steps in this section. Otherwise, skip to the [Connect to Exchange Online Protection PowerShell using modern authentication](#connect-to-exchange-online-protection-powershell-using-modern-authentication) section. - -1. In a Windows PowerShell window, load the EXO V2 module by running the following command: - - ```powershell - Import-Module ExchangeOnlineManagement - ``` - - **Note**: If you've already [installed the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module), the previous command will work as written. - -2. The command that you need to run uses the following syntax: +## Connect to Exchange Online Protection PowerShell using modern authentication with or without MFA - ```powershell - Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-AzureADAuthorizationEndPointUri ] [-PSSessionOption $ProxyOptions] - ``` +These connection instructions use modern authentication and work with or without multi-factor authentication (MFA). - - _\_ is your account in user principal name format (for example, `navin@contoso.com`). - - The required _ConnectionUri_ and _AzureADAuthorizationEndPointUrl_ values depend on the nature of your Microsoft 365 organization. For more information, see the parameter descriptions in [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - - If you're behind a proxy server, run this command first: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. Then, use the _PSSessionOption_ parameter with the value `$ProxyOptions`. For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). - - **This example connects to Exchange Online Protection PowerShell in a Microsoft 365 organization**: - - ```powershell - Connect-IPPSSession -UserPrincipalName navin@contoso.com -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ - ``` - - **This example connects to Exchange Online Protection PowerShell in an Office 365 Germany organization**: - - ```powershell - Connect-IPPSSession -UserPrincipalName lukas@fabrikam.com -ConnectionUri https://ps.protection.outlook.de/powershell-liveid/ -AzureADAuthorizationEndPointUri https://login.microsoftonline.de/common - ``` - -For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-exchangeonline). +## Step 1: Load the Exchange Online PowerShell module > [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command. +> If the module is already installed, you can typically skip this step and run **Connect-ExchangeOnline** without manually loading the module first. + +After you've [installed the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: ```powershell -Disconnect-ExchangeOnline +Import-Module ExchangeOnlineManagement ``` -## Connect to Exchange Online Protection PowerShell using modern authentication - -If your account doesn't use multi-factor authentication, use the steps in this section. +## Step 2: Connect and authenticate -1. In a Windows PowerShell window, load the EXO V2 module by running the following command: - - ```powershell - Import-Module ExchangeOnlineManagement - ``` - - **Note**: If you've already [installed the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module), the previous command will work as written. - -2. Run the following command: +> [!NOTE] +> Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. - > [!NOTE] - > You can skip this step and omit the _Credential_ parameter in the next step to be prompted to enter the username and password after you run the **Connect-IPPSSession** command. If you omit the _Credential_ parameter and include the _UserPrincipalName_ parameter in the next step, you're only prompted to enter the password after you run the **Connect-IPPSSession** command. +The command that you need to run uses the following syntax: - ```powershell - $UserCredential = Get-Credential - ``` +```powershell +Connect-ExchangeOnline -UserPrincipalName [-ShowBanner:$false] +``` - In the **Windows PowerShell Credential Request** dialog box that appears, type your work or school account and password, and then click **OK**. +For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). -3. The last command that you need to run uses the following syntax: +- _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). - ```powershell - Connect-IPPSSession [-Credential $UserCredential] -ConnectionUri [-PSSessionOption $ProxyOptions] - ``` +- With the EXO V3 module (v3.0.0 or later) and the [demise of Basic authentication (remote PowerShell) connections to Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432), you're using REST API cmdlets only. For more information, see [REST API connections in the EXO V3 module](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module). - - The required _ConnectionUri_ value depends on the nature of your Microsoft 365 organization. For more information, see the parameter description in [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - - If you're behind a proxy server, store the output of the [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption) cmdlet in a variable (for example, `$ProxyOptions = New-PSSessionOption -ProxyAccessType [-ProxyAuthentication ] [-ProxyCredential ]`). Then, use the variable (`$ProxyOptions`) as the value for the _PSSessionOption_ parameter. +### Connect to Exchange Online Protection PowerShell with an interactive login prompt - **This example connects to Exchange Online Protection PowerShell in a Microsoft 365 organization**: +This example works in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: - ```powershell - Connect-IPPSSession -Credential $UserCredential -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ - ``` +```powershell +Connect-ExchangeOnline -UserPrincipalName navin@contoso.onmicrosoft.com +``` - **This example connects to Exchange Online Protection PowerShell in an Office 365 Germany organization**: +## Step 3: Disconnect when you're finished - ```powershell - Connect-IPPSSession -Credential $UserCredential -ConnectionUri https://ps.protection.outlook.de/powershell-liveid/ - ``` +Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: -For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-exchangeonline). +```powershell +Disconnect-ExchangeOnline +``` -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: +To silently disconnect without a confirmation prompt, run the following command: ```powershell -Disconnect-ExchangeOnline +Disconnect-ExchangeOnline -Confirm:$false ``` -## How do you know this worked? +## How do you know you've connected successfully? -The Exchange Online Protection Protection cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online Protection cmdlet, for example, **Get-TransportRule**, and see the results. +The Exchange Online Protection Protection cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you've connected successfully. A quick test is to run an Exchange Online Protection cmdlet, for example, **Get-AcceptedDomain**, and see the results. If you receive errors, check the following requirements: -- A common problem is an incorrect password. Run the three steps again and pay close attention to the username and password that you use. - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Exchange Online Protection. +- A common problem is an incorrect password. Run the connection steps again and pay close attention to the username and password that you use. - TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. -- The account that you use to connect to Exchange Online Protection PowerShell must be represented as a [mail user in EOP](/microsoft-365/security/office-365-security/manage-mail-users-in-eop) (created manually or by directory synchronization). If the account is not visible in the Exchange admin center (EAC) as a mail user at **Recipients** \> **Contacts**, you'll receive the following error when you try to connect: - - > Import-PSSession : Running the Get-Command command in a remote session reported the following error: Processing data for a remote command failed with the following error message: The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. - - You might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - > The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. + > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Exchange Online Protection PowerShell endpoint. diff --git a/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md b/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md index 7faab2ddf7..a43bdfc46f 100644 --- a/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md +++ b/exchange/docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md @@ -2,13 +2,13 @@ title: "Connect to Exchange servers using remote PowerShell" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 9/7/2023 ms.audience: ITPro audience: ITPro ms.topic: article ms.service: exchange-powershell -localization_priority: Priority +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: 0b5987c3-8836-456d-99f7-abc2ffb57300 @@ -17,13 +17,13 @@ description: "Use Windows PowerShell on a local computer to connect to an Exchan # Connect to Exchange servers using remote PowerShell -If you don't have the Exchange management tools installed on your local computer, you can use Windows PowerShell to create a remote PowerShell session to an Exchange server. It's a simple three-step process, where you enter your credentials, provide the required connection settings, and then import the Exchange cmdlets into your local Windows PowerShell session so that you can use them. +If you don't have the Exchange management tools installed on your local computer, you can use Windows PowerShell to create a remote PowerShell session to an Exchange server. It's a simple three-step process, where you enter your credentials, provide the required connection settings, and then import the Exchange cmdlets into your local Windows PowerShell session. > [!NOTE] > > - We recommend that you use the Exchange Management Shell on any computer that you use to extensively administer Exchange servers. You get the Exchange Management Shell by installing the Exchange management tools. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](open-the-exchange-management-shell.md). For more information about the Exchange Management Shell, see [Exchange Server PowerShell (Exchange Management Shell)](exchange-management-shell.md). > -> - The **Get-ExchangeCertificate** cmdlet does not fully support remote PowerShell. We recommend that you use the Exchange Management Shell instead to get all the properties of this cmdlet. +> - The **Get-ExchangeCertificate** cmdlet does not fully support remote PowerShell. We recommend that you use the Exchange Management Shell instead to see all properties of certificate objects. ## What do you need to know before you begin? @@ -32,7 +32,7 @@ If you don't have the Exchange management tools installed on your local computer - After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Exchange Server permissions](/exchange/permissions/permissions). - You can use the following versions of Windows: - + - Windows 11 - Windows 10 - Windows 8.1 - Windows Server 2019 @@ -43,7 +43,7 @@ If you don't have the Exchange management tools installed on your local computer \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). -- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: +- Windows PowerShell needs to be configured to run scripts, and by default, it isn't. You get the following error when you try to connect: > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. @@ -66,7 +66,7 @@ If you don't have the Exchange management tools installed on your local computer $UserCredential = Get-Credential ``` - In the **Windows PowerShell Credential Request** dialog box that opens, enter your user principal name (UPN) (for example, `chris@contoso.com`) and password, and then click **OK**. + In the **Windows PowerShell Credential Request** dialog box that opens, enter your user principal name (UPN) (for example, `chris@contoso.com`) and password, and then select **OK**. 2. Replace `` with the fully qualified domain name of your Exchange server (for example, `mailbox01.contoso.com`) and run the following command: @@ -89,7 +89,7 @@ If you don't have the Exchange management tools installed on your local computer Remove-PSSession $Session ``` -## How do you know this worked? +## How do you know that you've successfully connected? After Step 3, the Exchange cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange cmdlet (for example, **Get-Mailbox**) and review the results. diff --git a/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md new file mode 100644 index 0000000000..f34a86b8d1 --- /dev/null +++ b/exchange/docs-conceptual/connect-to-exo-powershell-c-sharp.md @@ -0,0 +1,347 @@ +--- +title: Use C# to connect to Exchange Online PowerShell +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 8/21/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +ms.localizationpriority: high +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn about using the Exchange Online PowerShell V3 module and C# to connect to Exchange Online." +--- + +# Use C# to connect to Exchange Online PowerShell + +The code samples in this article use the [Exchange Online PowerShell V3 module](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module) module to connect to Exchange Online from C#. + +To install the Exchange Online PowerShell module, see [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). + +> [!TIP] +> REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). +> +> If you get errors when you try to connect, use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet. + +## Sample 1: Create a single connection using a PowerShell runspace + +```csharp +using System.Collections.ObjectModel; + +using System.Management.Automation; + +using System.Management.Automation.Runspaces; + +using System.Security; + +void SingleConnectionToExchangeOnline() + +{ + + // Setup the Initial Session State of each runspace in the pool + + // Import the ExchangeOnlineManagement module. + + // Set the Execution Policy of the runspace. + + InitialSessionState iss = InitialSessionState.CreateDefault(); + + iss.ImportPSModule(new string[] { "ExchangeOnlineManagement" }); + + iss.ExecutionPolicy = Microsoft.PowerShell.ExecutionPolicy.RemoteSigned; + + iss.ThrowOnRunspaceOpenError = true; + + Runspace runspace = RunspaceFactory.CreateRunspace(iss); + + runspace.Open(); + + // Run the Connect-ExchangeOnline command in the runspace to create a connection with EXO. + + PowerShell ps = PowerShell.Create(runspace); + + ps.AddCommand("Connect-ExchangeOnline"); + + ps.AddParameters(new Dictionary + + { + + ["Organization"] = "contoso.onmicrosoft.com", + + ["CertificateFilePath"] = "C:\\Users\\Certificates\\mycert.pfx", + + ["CertificatePassword"] = GetPassword(), + + ["AppID"] = "a37927a4-1a1a-4162-aa29-e346d5324590" + + }); + + // Execute the script synchronously. + + Collection connectionResult = ps.Invoke(); + + // Clear the connection commands before running cmdlets. + + ps.Commands.Clear(); + + // Create a new command to execute an Exchange Online cmdlet. + + ps.AddCommand("Get-Mailbox"); + + ps.AddParameter("Identity", "ContosoUser1"); + + Collection results = ps.Invoke(); + + // Check if there were any errors. + + if (!ps.HadErrors) + + { + + // Write the results to console. + + foreach (PSObject result in results) + + { + + Console.WriteLine(result.ToString()); + + } + + } + + else + + { + + // Write the errors to console by accessing the error stream of the Powershell object. + + foreach (ErrorRecord error in ps.Streams.Error) + + { + + Console.WriteLine(error.ToString()); + + } + + } + +} + +SecureString GetPassword() + +{ + + // Return the Password as a SecureString + +} +``` + +## Sample 2: Create a multiple connections using PowerShell runspace pools + +Use this code sample to run multiple Exchange Online PowerShell cmdlets in parallel. + +```csharp +PowerShell CreateConnectionCommand(RunspacePool pool) + +{ + + PowerShell ps = PowerShell.Create(); + + ps.RunspacePool = pool; + + ps.AddCommand("Connect-ExchangeOnline"); + + ps.AddParameters(new Dictionary + + { + + ["Organization"] = "contoso.onmicrosoft.com", + + ["CertificateFilePath"] = "C:\\Users\\Certificates\\mycert.pfx", + + ["CertificatePassword"] = GetPassword(), + + ["AppID"] = "a37927a4-1a1a-4162-aa29-e346d5324590" + + }); + + return ps; + +} + +void ParallelConnectionsToExchangeOnline() + +{ + + // Setup the Initial Session State of each runspace in the pool + + // Import the ExchangeOnlineManagement module. + + // Set the Execution Policy of the runspace. + + InitialSessionState iss = InitialSessionState.CreateDefault(); + + iss.ImportPSModule(new string[] { "ExchangeOnlineManagement" }); + + iss.ExecutionPolicy = Microsoft.PowerShell.ExecutionPolicy.RemoteSigned; + + iss.ThrowOnRunspaceOpenError = true; + + // Create a RunspacePool initialized with the Initial Session State. + + using (RunspacePool pool = RunspaceFactory.CreateRunspacePool(iss)) + + { + + // Configure the number of runspaces to maintain in the RunspacePool. + + pool.SetMaxRunspaces(3); + + pool.SetMinRunspaces(3); + + // Set the ThreadOptions to reuse the same threads for the runspaces so that + + // the Exchange Online cmdlets will be available after running Connect-ExchangeOnline in each runspace. + + pool.ThreadOptions = PSThreadOptions.ReuseThread; + + pool.Open(); + + // Run the Connect-ExchangeOnline cmdlet in all the runspaces in the pool + + // so that any cmdlets can be run in them after that. + + PowerShell ps1 = CreateConnectionCommand(pool); + + PowerShell ps2 = CreateConnectionCommand(pool); + + PowerShell ps3 = CreateConnectionCommand(pool); + + // Execute each of the 3 Connect-ExchangeOnline commands asynchronously. + + IAsyncResult job1 = ps1.BeginInvoke(); + + IAsyncResult job2 = ps2.BeginInvoke(); + + IAsyncResult job3 = ps3.BeginInvoke(); + + // Get the results of the commands. + + PSDataCollection connectionResult = ps1.EndInvoke(job1); + + PSDataCollection connectionResult2 = ps2.EndInvoke(job2); + + PSDataCollection connectionResult3 = ps3.EndInvoke(job3); + + // Execute two Exchange-Online commands in parallel using the runspacepool. + + // All of them have an active connection to Exchange Online. + + // NOTE : Cmdlets that update the same object or can cause conflicting + // results should not be run in parallel as they can lead to an undefined + // outcome. + + PowerShell commandPS1 = PowerShell.Create(); + + commandPS1.RunspacePool = pool; + + commandPS1.AddCommand("Get-Mailbox"); + + commandPS1.AddParameter("Identity", "ContosoUser1"); + + PowerShell commandPS2 = PowerShell.Create(); + + commandPS2.RunspacePool = pool; + + commandPS2.AddCommand("Get-Mailbox"); + + commandPS2.AddParameter("Identity", "ContosoUser2"); + + IAsyncResult commandJob1 = commandPS1.BeginInvoke(); + + IAsyncResult commandJob2 = commandPS2.BeginInvoke(); + + // Wait for the commands to finish and return the results. + + PSDataCollection command1Result = commandPS1.EndInvoke(commandJob1); + + PSDataCollection command2Result = commandPS2.EndInvoke(commandJob2); + + // Check if there were any errors. + + if (!commandPS1.HadErrors) + + { + + // Write the results to console. + + foreach (PSObject result in command1Result) + + { + + Console.WriteLine(result.ToString()); + + } + + } + + else + + { + + // Write the errors to console by accessing the error stream of the Powershell object. + + foreach (ErrorRecord error in commandPS1.Streams.Error) + + { + + Console.WriteLine(error.ToString()); + + } + + } + + // Check if there were any errors. + + if (!commandPS2.HadErrors) + + { + + // Write the results to console. + + foreach (PSObject result in command2Result) + + { + + Console.WriteLine(result.ToString()); + + } + + } + + else + + { + + // Write the errors to console by accessing the error stream of the Powershell object. + + foreach (ErrorRecord error in commandPS2.Streams.Error) + + { + + Console.WriteLine(error.ToString()); + + } + + } + + } + +} +``` diff --git a/exchange/docs-conceptual/connect-to-scc-powershell.md b/exchange/docs-conceptual/connect-to-scc-powershell.md index 8d1700598c..b35779fdaf 100644 --- a/exchange/docs-conceptual/connect-to-scc-powershell.md +++ b/exchange/docs-conceptual/connect-to-scc-powershell.md @@ -1,174 +1,187 @@ --- -title: Connect to Security & Compliance Center PowerShell using the EXO V2 module +title: Connect to Security & Compliance PowerShell author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -ms.reviewer: navgupta -localization_priority: Priority +ms.reviewer: +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn how to use the Exchange Online PowerShell V2 module to connect to Security & Compliance Center PowerShell with modern authentication and/or multi-factor authentication (MFA)." +description: "Learn how to use the Exchange Online PowerShell V3 module to connect to Security & Compliance PowerShell with modern authentication and/or multi-factor authentication (MFA)." --- -# Connect to Security & Compliance Center PowerShell +# Connect to Security & Compliance PowerShell -The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) uses modern authentication and works with multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the EXO V2 module, see [About the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). +This article contains instructions for how to connect to Security & Compliance PowerShell using the Exchange Online PowerShell module with or without multi-factor authentication (MFA). -**This article contains instructions for how to connect to Security & Compliance Center PowerShell using the EXO V2 module with or without MFA.** +The Exchange Online PowerShell module uses modern authentication for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. For more information about the Exchange Online PowerShell module, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). -To use the older, less secure remote PowerShell connection instructions that [will eventually be deprecated](https://techcommunity.microsoft.com/t5/exchange-team-blog/basic-authentication-and-exchange-online-july-update/ba-p/1530163), see [Basic auth - Connect to Security & Compliance Center PowerShell](basic-auth-connect-to-scc-powershell.md). - -To use the older Exchange Online Remote PowerShell Module to connect to Security & Compliance Center PowerShell using MFA, see [V1 module - Connect to Security & Compliance Center PowerShell using MFA](v1-module-mfa-connect-to-scc-powershell.md). Note that this older version of the module will eventually be retired. +To connect to Security & Compliance PowerShell for automation, see [App-only authentication for unattended scripts](app-only-auth-powershell-v2.md). ## What do you need to know before you begin? -- The requirements for installing and using the EXO V2 module are described in [Install and maintain the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module). The rest of the instructions in the article assume that you've already installed the module. +- The requirements for installing and using the module are described in [Install and maintain the Exchange Online PowerShell module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module). -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) and [Permissions in the Microsoft 365 security center](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). + > [!NOTE] + > Remote PowerShell connections are deprecated in Security & Compliance PowerShell. For more information, see [Deprecation of Remote PowerShell (RPS) Protocol in Security & Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). + > + > REST API connections in the Exchange Online PowerShell V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). -## Connect to Security & Compliance PowerShell using MFA and modern authentication +- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft Defender portal](/defender-office-365/mdo-portal-permissions) and [Permissions in the Microsoft Purview compliance portal](/purview/purview-compliance-portal-permissions). -If your account uses multi-factor authentication, use the steps in this section. Otherwise, skip to the [Connect to Security & Compliance Center PowerShell using modern authentication](#connect-to-security--compliance-center-powershell-using-modern-authentication) section. +## Step 1: Load the Exchange Online PowerShell module -1. In a Windows PowerShell window, load the EXO V2 module by running the following command: +> [!NOTE] +> If the module is already installed, you can typically skip this step and run **Connect-IPPSSession** without manually loading the module first. - ```powershell - Import-Module ExchangeOnlineManagement - ``` +After you've [installed the module](exchange-online-powershell-v2.md#install-and-maintain-the-exchange-online-powershell-module), open a PowerShell window and load the module by running the following command: - **Note**: If you've already [installed the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module), the previous command will work as written. +```powershell +Import-Module ExchangeOnlineManagement +``` -2. The last command that you need to run uses the following syntax: +## Step 2: Connect and authenticate - ```powershell - Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-PSSessionOption $ProxyOptions] - ``` +> [!NOTE] +> Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. - - _\_ is your account in user principal name format (for example, `navin@contoso.com`). - - The required _ConnectionUri_ value depends on the nature of your Microsoft 365 organization. For more information, see the parameter description in [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - - When you use the _UserPrincipalName_ parameter, you don't need to use the _AzureADAuthorizationEndpointUri_ parameter in environments that would otherwise require it. - - If you're behind a proxy server, run this command first: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. Then, use the _PSSessionOption_ parameter with the value `$ProxyOptions`. For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). +The command that you need to run uses the following syntax: - **This example connects to Security & Compliance Center PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**. +```powershell +Connect-IPPSSession -UserPrincipalName [-ConnectionUri ] [-AzureADAuthorizationEndpointUri ] [-DelegatedOrganization ] [-PSSessionOption $ProxyOptions] +``` - ```powershell - Connect-IPPSSession -UserPrincipalName navin@contoso.com - ``` +For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - **This example connects to Security & Compliance Center PowerShell in an Office 365 Germany organization**. +- _\_ is your account in user principal name format (for example, `navin@contoso.onmicrosoft.com`). - ```powershell - Connect-IPPSSession -UserPrincipalName lukas@fabrikam.de -ConnectionUri https://ps.compliance.protection.outlook.de/PowerShell-LiveID - ``` +- The required _ConnectionUri_ and _AzureADAuthorizationEndpointUri_ values depend on the nature of your Microsoft 365 organization. Common values are described in the following list: + - **Microsoft 365 or Microsoft 365 GCC**: + - _ConnectionUri_: None. The required value `https://ps.compliance.protection.outlook.com/powershell-liveid/` is also the default value, so you don't need to use the _ConnectionUri_ parameter in Microsoft 365 or Microsoft 365 GCC environments. + - _AzureADAuthorizationEndpointUri_: None. The required value `https://login.microsoftonline.com/common` is also the default value, so you don't need to use the _AzureADAuthorizationEndpointUri_ parameter in Microsoft 365 or Microsoft 365 GCC environments. + - **Microsoft 365 GCC High**: + - _ConnectionUri_: `https://ps.compliance.protection.office365.us/powershell-liveid/` + - _AzureADAuthorizationEndpointUri_: `https://login.microsoftonline.us/common` + - **Microsoft 365 DoD**: + - _ConnectionUri_: `https://l5.ps.compliance.protection.office365.us/powershell-liveid/` + - _AzureADAuthorizationEndpointUri_: `https://login.microsoftonline.us/common` + - **Office 365 operated by 21Vianet**: + - _ConnectionUri_: `https://ps.compliance.protection.partner.outlook.cn/powershell-liveid` + - _AzureADAuthorizationEndpointUri_: `https://login.chinacloudapi.cn/common` - **This example connects to Security & Compliance Center PowerShell in a Microsoft GCC High organization**. +- If you're behind a proxy server, you can use the _PSSessionOption_ parameter in the connection command. First, run this command: `$ProxyOptions = New-PSSessionOption -ProxyAccessType `, where \ is `IEConfig`, `WinHttpConfig`, or `AutoDetect`. Then, use the value `$ProxyOptions` for the _PSSessionOption_ parameter. For more information, see [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption). - ```powershell - Connect-IPPSSession -UserPrincipalName -ConnectionUri https://ps.compliance.protection.office365.us/powershell-liveid/ - ``` +- Depending on the nature of your organization, you might be able to omit the _UserPrincipalName_ parameter in the next step. Instead, you enter the username and password or select stored credentials after you run the **Connect-IPPSSession** command. If it doesn't work, then you need to use the _UserPrincipalName_ parameter. - **This example connects to Security & Compliance Center PowerShell in a Microsoft 365 DoD organization**. +- If you aren't using MFA, you should be able to use the _Credential_ parameter instead of the _UserPrincipalName_ parameter. First, run the command `$Credential = Get-Credential`, enter your username and password, and then use the variable name for the _Credential_ parameter (`-Credential $Credential`). If it doesn't work, then you need to use the _UserPrincipalName_ parameter. - ```powershell - Connect-IPPSSession -UserPrincipalName -ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ - ``` +### Connect to Security & Compliance PowerShell with an interactive login prompt -For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). +1. The following examples work in Windows PowerShell 5.1 and PowerShell 7 for accounts with or without MFA: -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command. + - **This example connects to Security & Compliance PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**: -```powershell -Disconnect-ExchangeOnline -``` + ```powershell + Connect-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com + ``` -## Connect to Security & Compliance Center PowerShell using modern authentication + - **This example connects to Security & Compliance PowerShell in a Microsoft GCC High organization**: -If your account doesn't use multi-factor authentication, use the steps in this section. + ```powershell + Connect-IPPSSession -UserPrincipalName chris@govt.us -ConnectionUri https://ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common + ``` -1. In a Windows PowerShell window, load the EXO V2 module by running the following command: + - **This example connects to Security & Compliance PowerShell in a Microsoft 365 DoD organization**: - ```powershell - Import-Module ExchangeOnlineManagement - ``` + ```powershell + Connect-IPPSSession -UserPrincipalName michelle@govt.mil -ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common + ``` - **Note**: If you've already [installed the EXO V2 module](exchange-online-powershell-v2.md#install-and-maintain-the-exo-v2-module), the previous command will work as written. + - **This example connects to Security & Compliance PowerShell in an Office 365 operated by 21Vianet organization**: -2. Run the following command: + ```powershell + Connect-IPPSSession -UserPrincipalName li@fabrikam.cn -ConnectionUri https://ps.compliance.protection.partner.outlook.cn/powershell-liveid -AzureADAuthorizationEndpointUri https://login.chinacloudapi.cn/common + ``` - > [!NOTE] - > You can skip this step and omit the _Credential_ parameter in the next step to be prompted to enter the username and password after you run the **Connect-IPPSSession** command. If you omit the _Credential_ parameter and include the _UserPrincipalName_ parameter in the next step, you're only prompted to enter the password after you run the **Connect-IPPSSession** command. +2. In the sign-in window that opens, enter your password, and then click **Sign in**. - ```powershell - $UserCredential = Get-Credential - ``` + ![Enter your password in the Sign in to your account window.](media/connect-exo-password-prompt.png) - In the **Windows PowerShell Credential Request** dialog box that appears, type your work or school account and password, and then click **OK**. + > [!NOTE] + > In PowerShell 7, browser-based single sign-on (SSO) is used by default, so the sign in prompt opens in your default web browser instead of a standalone dialog. - **Note**: After the **Connect-IPPSSession** command is complete, the password key in the `$UserCredential` is emptied. +3. **MFA only**: A verification code is generated and delivered based on the response option that's configured for your account (for example, a text message or the Microsoft Authenticator app on your device). -3. The command that you need to run uses the following syntax: + In the verification window that opens, enter the verification code, and then click **Verify**. - ```powershell - Connect-IPPSSession [-Credential $UserCredential] [-ConnectionUri ] [-AzureADAuthorizationEndpointUri ] [-PSSessionOption $ProxyOptions] - ``` + ![Enter your verification code in the Sign in to your account window.](media/connect-exo-mfa-verify-prompt.png) - - The required _ConnectionUri_ and _AzureADAuthorizationEndPointUrl_ values depend on the nature of your Microsoft 365 organization. For more information, see the parameter descriptions in [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). - - If you're behind a proxy server, store the output of the [New-PSSessionOption](/powershell/module/microsoft.powershell.core/new-pssessionoption) cmdlet in a variable (for example, `$ProxyOptions = New-PSSessionOption -ProxyAccessType [-ProxyAuthentication ] [-ProxyCredential ]`). Then, use the variable (`$ProxyOptions`) as the value for the _PSSessionOption_ parameter. +### Connect to Security & Compliance PowerShell without a login prompt (unattended scripts) - **This example connects to Security & Compliance Center PowerShell in a Microsoft 365 or Microsoft 365 GCC organization**. +For complete instructions, see [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md). - ```powershell - Connect-IPPSSession -Credential $UserCredential - ``` +### Connect to Security & Compliance PowerShell in customer organizations - **This example connects to Security & Compliance Center PowerShell in an Office 365 Germany organization**. +The procedures in this section require version 3.0.0 or later of the module. - ```powershell - Connect-IPPSSession -Credential $UserCredential -ConnectionUri https://ps.compliance.protection.outlook.de/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.de/common - ``` +In Security & Compliance PowerShell, you need to use the _AzureADAuthorizationEndpointUri_ with the _DelegatedOrganization_ parameter. - **This example connects to Security & Compliance Center PowerShell in a Microsoft GCC High organization**. +For more information, about partners and customer organizations, see the following topics: - ```powershell - Connect-IPPSSession -Credential $UserCredential -ConnectionUri https://ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common - ``` +- [What is the Cloud Solution Provider (CSP) program?](/partner-center/csp-overview). +- [Introduction to granular delegated admin privileges (GDAP)](/partner-center/gdap-introduction) - **This example connects to Security & Compliance Center PowerShell in a Microsoft 365 DoD organization**. +This example connects to customer organizations in the following scenarios: - ```powershell - Connect-IPPSSession -Credential $UserCredential -ConnectionUri https://l5.ps.compliance.protection.office365.us/powershell-liveid/ -AzureADAuthorizationEndpointUri https://login.microsoftonline.us/common - ``` +- Connect to a customer organization using a CSP account. +- Connect to a customer organization using a GDAP. +- Connect to a customer organization as a guest user. -For detailed syntax and parameter information, see [Connect-IPPSSession](/powershell/module/exchange/connect-ippssession). + ```powershell + Connect-IPPSSession -UserPrincipalName navin@contoso.onmicrosoft.com -DelegatedOrganization adatum.onmicrosoft.com -AzureADAuthorizationEndpointUri https://login.microsoftonline.com/adatum.onmicrosoft.com + ``` -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Windows PowerShell window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect the remote PowerShell session, run the following command: +## Step 3: Disconnect when you're finished + +Be sure to disconnect the session when you're finished. If you close the PowerShell window without disconnecting the session, you could use up all the sessions available to you, and you need to wait for the sessions to expire. To disconnect the session, run the following command: ```powershell Disconnect-ExchangeOnline ``` -## How do you know this worked? +To silently disconnect without a confirmation prompt, run the following command: + +```powershell +Disconnect-ExchangeOnline -Confirm:$false +``` + +> [!NOTE] +> The disconnect command will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. + +## How do you know you've connected successfully? -The Security & Compliance Center PowerShell cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run a Security & Compliance Center cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. +The Security & Compliance PowerShell cmdlets are imported into your local Windows PowerShell session and tracked by a progress bar. If you don't receive any errors, you've connected successfully. A quick test is to run a Security & Compliance PowerShell cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. If you receive errors, check the following requirements: - A common problem is an incorrect password. Run the three steps again and pay close attention to the username and password that you use. -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Security & Compliance Center PowerShell. - -- The account that you use to connect must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). +- The account that you use to connect must be enabled for PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive internet access policy. +- REST-based connections to Security & Compliance PowerShell require the PowerShellGet module, and by dependency, the PackageManagement module, so you'll receive errors if you try to connect without having them installed. For example, you might see the following error: + + > The term 'Update-ModuleManifest' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. + + For more information about the PowerShellGet and PackageManagement module requirements, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + - You might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: > The request for the Windows Remote Shell with ShellId \ failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation. diff --git a/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md b/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md index f7419cf8f1..eafad0e59b 100644 --- a/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md +++ b/exchange/docs-conceptual/control-remote-powershell-access-to-exchange-servers.md @@ -2,20 +2,20 @@ title: "Control remote PowerShell access to Exchange servers" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 9/7/2023 ms.audience: ITPro audience: ITPro ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 064e3bb0-38bf-495e-9994-784f823b88dd description: "Administrators can learn how to block or allow users' remote PowerShell access to Exchange servers." --- # Control remote PowerShell access to Exchange servers -Remote PowerShell in Microsoft Exchange allows you to manage your Exchange organization from a remote computer that's on your internal network or from the Internet. You can disable or enable a user's ability to connect to an Exchange server using remote PowerShell. For more information about remote PowerShell, see [Exchange Server PowerShell (Exchange Management Shell)](exchange-management-shell.md). +Remote PowerShell in Microsoft Exchange allows you to manage your Exchange organization from a remote computer that's on your internal network or from the internet. You can disable or enable a user's ability to connect to an Exchange server using remote PowerShell and the Exchange Management Shell. For more information about remote PowerShell, see [Exchange Server PowerShell (Exchange Management Shell)](exchange-management-shell.md). For additional management tasks related to remote PowerShell, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). @@ -23,17 +23,50 @@ For additional management tasks related to remote PowerShell, see [Connect to Ex - Estimated time to complete each procedure: less than 5 minutes -- You can only use PowerShell to perform this procedure. To learn how to open the Exchange Management Shell in your on-premises Exchange organization, see [Open the Exchange Management Shell](open-the-exchange-management-shell.md). - - By default, all user accounts have access to remote PowerShell. However, to actually use remote PowerShell to connect to an Exchange server, the user needs to be a member of a management role group, or be directly assigned a management role that enables the user to run Exchange cmdlets. For more information about role groups and management roles, see [Exchange Server permissions](/Exchange/permissions/permissions). -- For detailed information about OPath filter syntax in Exchange, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). + > [!IMPORTANT] + > In your haste to quickly and globally disable remote PowerShell access in your organization, beware of commands like `Get-User | Set-User -RemotePowerShellEnabled $false` without considering administrator accounts, service accounts, or health monitoring mailboxes that need remote PowerShell access. Use the procedures in this article to selectively remove remote PowerShell access, or preserve access for those who need it by using the following syntax in your global removal command: `Get-User | Where-Object {$_.UserPrincipalName -ne 'admin1@contoso.com' -and $_.UserPrincipalName -ne 'admin2@contoso.com'...} | Set-User -RemotePowerShellEnabled $false`. + > + > If you accidentally lock yourself out of remote PowerShell access, you'll need to use the otherwise highly discouraged method of directly loading the Exchange Management Shell snap-in (`Add-PSSnapIn Microsoft.Exchange.Management.PowerShell.SnapIn`) to give yourself access. Minimize the time and changes you're using with this method. Fix one account and open the Exchange Management Shell to make any additional changes. + +- You can only use PowerShell to perform these procedures. To learn how to open the Exchange Management Shell in your on-premises Exchange organization, see [Open the Exchange Management Shell](open-the-exchange-management-shell.md). + +- For detailed information about OPATH filter syntax in Exchange, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). - You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Remote PowerShell" entry in the [Exchange infrastructure and PowerShell permissions](/Exchange/permissions/feature-permissions/infrastructure-permissions) article. +- If you're using third-party tools to customize email addresses of users, you need to disable email address policies on the affected users before you do the procedures in this article. If you don't, the **Set-User** commands change the email addresses of the users to match the applicable email address policy. To disable email address policies on users, set the value of the EmailAddressPolicyEnabled parameter to $false on the [Set-Mailbox](/powershell/module/exchange/set-mailbox) cmdlet. + > [!TIP] > Having problems? Ask for help in the [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) forums. +## View the remote PowerShell access for users + +To view the remote PowerShell access status for a specific user, replace \ with the name or user principal name (UPN) of the user, and then run the following command: + +```powershell +Get-User -Identity "" | Format-List RemotePowerShellEnabled +``` + +To display the remote PowerShell access status for all users, run the following command: + +```powershell +Get-User -ResultSize unlimited | Format-Table Name,DisplayName,RemotePowerShellEnabled -AutoSize +``` + +To display all users who don't have access to remote PowerShell, run the following command: + +```powershell +Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $false' +``` + +To display all users who have access to remote PowerShell, run the following command: + +```powershell +Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $true' +``` + ## Use the Exchange Management Shell to enable or disable remote PowerShell access for a user This example disables remote PowerShell access for the user named Therese Lindqvist. @@ -62,20 +95,16 @@ To disable access to remote PowerShell for any number of users based on an exist ```powershell $ = -ResultSize unlimited -Filter -``` -```powershell -$ | foreach {Set-User -RemotePowerShellEnabled $false} +$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} ``` This example removes access to remote PowerShell for all users whose **Title** attribute contains the value "Sales Associate". ```powershell $DSA = Get-User -ResultSize unlimited -Filter "(RecipientType -eq 'UserMailbox') -and (Title -like '*Sales Associate*')" -``` -```powershell -$DSA | foreach {Set-User -RemotePowerShellEnabled $false} +$DSA | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} ``` ### Use a list of specific users @@ -84,10 +113,8 @@ To disable access to remote PowerShell for a list of specific users, use the fol ```powershell $ = Get-Content -``` -```powershell -$ | foreach {Set-User -RemotePowerShellEnabled $false +$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} ``` This example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their user principal name (UPN). The text file must contain one UPN on each line like this: @@ -98,40 +125,6 @@ After you populate the text file with the user accounts you want to update, run ```powershell $NPS = Get-Content "C:\My Documents\NoPowerShell.txt" -``` - -```powershell -$NPS | foreach {Set-User -RemotePowerShellEnabled $false} -``` - -## View the remote PowerShell access for users -To view the remote PowerShell access status for a specific user, use the following syntax: - -```powershell -Get-User -Identity | Format-List RemotePowerShellEnabled -``` - -This example displays the remote PowerShell access status of the user named Sarah Jones. - -```powershell -Get-User -Identity "Sarah Jones" | Format-List RemotePowerShellEnabled -``` - -To display the remote PowerShell access status for all users, run the following command: - -```powershell -Get-User -ResultSize unlimited | Format-Table -Auto Name,DisplayName,RemotePowerShellEnabled -``` - -To display only those users who don't have access to remote PowerShell, run the following command: - -```powershell -Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $false' -``` - -To display only those users who have access to remote PowerShell, run the following command: - -```powershell -Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $true' +$NPS | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} ``` diff --git a/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md b/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md index 77a063af4f..79a641ef08 100644 --- a/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md +++ b/exchange/docs-conceptual/disable-access-to-exchange-online-powershell.md @@ -2,57 +2,67 @@ title: "Enable or disable access to Exchange Online PowerShell" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 12/11/2024 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f969816a-2607-4655-9d47-9e8767fb5633 search.appverid: MET150 -description: "Admins can learn how to enable or disable access to Exchange Online PowerShell for users in their organization" +description: "Admins can learn how to disable or enable access to Exchange Online PowerShell for users in their organization" --- # Enable or disable access to Exchange Online PowerShell -Exchange Online PowerShell enables you to manage your Exchange Online organization from the command line. By default, all accounts you create in Microsoft 365 are allowed to use Exchange Online PowerShell. Administrators can use Exchange Online PowerShell to enable or disable a user's ability to connect to Exchange Online PowerShell. Note that access to Exchange Online PowerShell doesn't give users extra administrative powers in your organization. A user's capabilities in Exchange Online PowerShell are still defined by role based access control (RBAC) and the roles that are assigned to them. +Exchange Online PowerShell is the administrative interface that enables admins to manage the Exchange Online part of a Microsoft 365 organization from the command line (including many security features in Exchange Online Protection and Microsoft Defender for Office 365). + +By default, all accounts in Microsoft 365 are allowed to use Exchange Online PowerShell. This access doesn't give users administrative capabilities. They're still limited by [role based access control (RBAC)](/exchange/permissions-exo/permissions-exo). For example, they can configure some settings on their own mailbox and manage distribution groups that they own, but not much else. + +Admins can use the procedures in this article to disable or enable a user's ability to connect to Exchange Online PowerShell. ## What do you need to know before you begin? - Estimated time to complete each procedure: less than 5 minutes -- Microsoft 365 global admins have access to Exchange Online PowerShell, and can use the procedures in this article to configure Exchange Online PowerShell access for other users. For more information about permissions in Exchange Online, see [Feature Permissions in Exchange Online](/exchange/permissions-exo/feature-permissions). +- The procedures in this article are available only in Exchange Online PowerShell. To connect to Exchange Online PowerShell, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). -- You can only use Exchange Online PowerShell to perform this procedure. To connect to Exchange Online PowerShell, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). +- You need to be assigned permissions before you can do the procedures in this article. You have the following options: + - [Exchange Online RBAC](/exchange/permissions-exo/permissions-exo): Membership in the **Organization Management** or **Recipient Management** role groups. + - [Microsoft Entra RBAC](/microsoft-365/admin/add-users/about-admin-roles): Membership in the **Exchange Administrator** or **Global Administrator**\* roles gives users the required permissions *and* permissions for other features in Microsoft 365. -- For detailed information about OPath filter syntax in Exchange Online, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). + > [!IMPORTANT] + > In your haste to quickly and globally disable PowerShell access in your cloud-based organization, beware of commands like `Get-User | Set-User -EXOModuleEnabled $false` without considering admin accounts. Use the procedures in this article to **selectively** remove PowerShell access, or **preserve access for those who need it** by using the following syntax in your global removal command: `Get-User | Where-Object {$_.UserPrincipalName -ne 'admin1@contoso.onmicrosoft.com' -and $_.UserPrincipalName -ne 'admin2@contoso.onmicrosoft.com'...} | Set-User -EXOModuleEnabled $false`. + > + > If you accidentally lock yourself out of PowerShell access, create a new admin account in the Microsoft 365 admin center, and then use that account to give yourself PowerShell access using the procedures in this article. + > + > \* Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. -- You can also use Client Access Rules to block PowerShell access to Exchange Online. For details, see [Client Access Rules in Exchange Online](/Exchange/clients-and-mobile-in-exchange-online/client-access-rules/client-access-rules). +- For detailed information about OPATH filter syntax in Exchange Online, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). > [!TIP] > Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). ## Enable or disable access to Exchange Online PowerShell for a user -This example disables access to Exchange Online PowerShell for the user david@contoso.com. +This example disables access to Exchange Online PowerShell for the user `david@contoso.onmicrosoft.com`. ```powershell -Set-User -Identity david@contoso.com -RemotePowerShellEnabled $false +Set-User -Identity david@contoso.onmicrosoft.com -EXOModuleEnabled $false ``` -This example enables access to Exchange Online PowerShell for the user david@contoso.com. +This example enables access to Exchange Online PowerShell for the user `chris@contoso.onmicrosoft.com`. ```powershell -Set-User -Identity david@contoso.com -RemotePowerShellEnabled $true +Set-User -Identity chris@contoso.onmicrosoft.com -EXOModuleEnabled $true ``` ## Disable access to Exchange Online PowerShell for many users To prevent access to Exchange Online PowerShell for a specific group of existing users, you have the following options: -- **Filter users based on an existing attribute**: This method assumes that the target user accounts all share a unique filterable attribute. Some attributes, such as Title, Department, address information, and telephone number, are visible only when you use the **Get-User** cmdlet. Other attributes, such as CustomAttribute1-15, are visible only when you use the **Get-Mailbox** cmdlet. - +- **Filter users based on an existing attribute**: This method assumes that the target user accounts all share a unique filterable attribute. Some attributes (for example, Title, Department, address information, and telephone number) are available only from the **Get-User** cmdlet. Other attributes (for example, CustomAttribute1 to CustomAttribute15) are available only from the **Get-Mailbox** cmdlet. - **Use a list of specific users**: After you generate the list of specific users, you can use that list to disable their access to Exchange Online PowerShell. ### Filter users based on an existing attribute @@ -61,20 +71,16 @@ To disable access to Exchange Online PowerShell for any number of users based on ```powershell $ = -ResultSize unlimited -Filter -``` -```powershell -$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +$ | foreach {Set-User -Identity $_.WindowsEmailAddress -EXOModuleEnabled $false} ``` This example removes access to Exchange Online PowerShell for all users whose **Title** attribute contains the value "Sales Associate". ```powershell $DSA = Get-User -ResultSize unlimited -Filter "(RecipientType -eq 'UserMailbox') -and (Title -like 'Sales Associate*')" -``` -```powershell -$DSA | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +$DSA | foreach {Set-User -Identity $_.WindowsEmailAddress -EXOModuleEnabled $false} ``` ### Use a list of specific users @@ -83,53 +89,46 @@ To disable access to Exchange Online PowerShell for a list of specific users, us ```powershell $ = Get-Content -``` -```powershell -$ | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +$ | foreach {Set-User -Identity $_ -EXOModuleEnabled $false} ``` The following example uses the text file C:\My Documents\NoPowerShell.txt to identify the users by their accounts. The text file must contain one account on each line as follows: -> akol@contoso.com
tjohnston@contoso.com
kakers@contoso.com +> `akol@contoso.onmicrosoft.com`
`tjohnston@contoso.onmicrosoft.com`
`kakers@contoso.onmicrosoft.com` After you populate the text file with the user accounts you want to update, run the following commands: ```powershell -$NPS = Get-Content "C:\My Documents\NoPowerShell.txt" -``` +$NoPS = Get-Content "C:\My Documents\NoPowerShell.txt" -```powershell -$NPS | foreach {Set-User -Identity $_ -RemotePowerShellEnabled $false} +$NoPS | foreach {Set-User -Identity $_ -EXOModuleEnabled $false} ``` -## View the Exchange Online PowerShell access for users - -To view the Exchange Online PowerShell access status for a specific user, use the following syntax: +## View the Exchange Online PowerShell access status for users -```powershell -Get-User -Identity | Format-List RemotePowerShellEnabled -``` +> [!TIP] +> The newer `EXOModuleEnabled` property isn't available to use with the *Filter* parameter on the **Get-User** cmdlet, but the values of the `EXOModuleEnabled` property and the older `RemotePowerShellEnabled` property are always the same, so use the `RemotePowerShellEnabled` property with the *Filter* parameter on the **Get-User** cmdlet. -This example displays the Exchange Online PowerShell access status of the user named Sarah Jones. +To view the PowerShell access status for a specific user, replace \ with the name or user principal name (UPN) of the user, and run the following command: ```powershell -Get-User -Identity "Sarah Jones" | Format-List RemotePowerShellEnabled +Get-User -Identity "" | Format-List EXOModuleEnabled ``` To display the Exchange Online PowerShell access status for all users, run the following command: ```powershell -Get-User -ResultSize unlimited | Format-Table -Auto Name,DisplayName,RemotePowerShellEnabled +Get-User -ResultSize unlimited | Format-Table -Auto DisplayName,EXOModuleEnabled ``` -To display only those users who don't have access to Exchange Online PowerShell, run the following command: +To display all users who don't have access to Exchange Online PowerShell, run the following command: ```powershell Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $false' ``` -To display only those users who have access to Exchange Online PowerShell, run the following command: +To display all users who have access to Exchange Online PowerShell, run the following command: ```powershell Get-User -ResultSize unlimited -Filter 'RemotePowerShellEnabled -eq $true' diff --git a/exchange/docs-conceptual/exchange-cmdlet-syntax.md b/exchange/docs-conceptual/exchange-cmdlet-syntax.md index ea1cb20a0c..2d91c08839 100644 --- a/exchange/docs-conceptual/exchange-cmdlet-syntax.md +++ b/exchange/docs-conceptual/exchange-cmdlet-syntax.md @@ -2,15 +2,15 @@ title: "Exchange cmdlet syntax" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 9/7/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-online -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 85ffe9c8-7f03-4877-8e55-3cbd40228d84 -description: "Learn about the structure and syntax of cmdlets in Exchange PowerShell, Exchange Online PowerShell, standalone Exchange Online Protection (EOP) PowerShell, and Security & Compliance Center PowerShell." +description: "Learn about the structure and syntax of cmdlets in Exchange PowerShell, Exchange Online PowerShell, standalone Exchange Online Protection (EOP) PowerShell, and Security & Compliance PowerShell." --- # Exchange cmdlet syntax @@ -27,31 +27,26 @@ This article explains these conventions, and also the syntax that's required to Exchange PowerShell help follows conventions that indicate what's required or optional, and how to enter parameters and values when you run a command. These command conventions are listed in the following table. -
- -**** - |Symbol|Description| |---|---| |`-`|A hyphen indicates a parameter. For example, `-Identity`.| |`< >`|Angle brackets indicate the possible values for a parameter. For example, `-Location ` or -Enabled \<$true \| $false\>.| -|`[ ]`|Square brackets indicate optional parameters and their values. For example, `[-WhatIf]` or `[-ResultSize ]`.

Parameter-value pairs that aren't enclosed in square brackets are required. For example, `-Password `.

If the parameter name itself is enclosed in square brackets, that indicates the parameter is a _positional_ parameter (you can use the parameter value without specifying the parameter), and positional parameters can be required or optional.

For example, `Get-Mailbox [[-Identity] ]` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and optional (because the whole parameter-value pair is enclosed in square brackets), so you can use `Get-Mailbox -Identity ` or `Get-Mailbox `. Similarly, `Set-Mailbox [-Identity] ` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and required (because the whole parameter-value pair is not enclosed in square brackets), so you can use `Set-Mailbox -Identity ` or `Set-Mailbox `.| +|`[ ]`|Square brackets indicate optional parameters and their values. For example, `[-WhatIf]` or `[-ResultSize ]`.

Parameter-value pairs that aren't enclosed in square brackets are required. For example, `-Password `.

Square brackets around the parameter name itself indicates a _positional_ parameter (you can use the parameter value without specifying the parameter name), and positional parameters can be required or optional.

For example, `Get-Mailbox [[-Identity] ]` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and optional (because the whole parameter-value pair is enclosed in square brackets), so you can use `Get-Mailbox -Identity ` or `Get-Mailbox `. Similarly, `Set-Mailbox [-Identity] ` means the _Identity_ parameter is positional (because it's enclosed in square brackets) and required (because the whole parameter-value pair isn't enclosed in square brackets), so you can use `Set-Mailbox -Identity ` or `Set-Mailbox `.| |`|`|Pipe symbols in parameter values indicate a choice between values. For example, -Enabled \<$true \| $false\> indicates the _Enabled_ parameter can have the value `$true` or `$false`.| -| -These command conventions help you understand how a command is constructed. With the exception of the hyphen that indicates a parameter, you don't use these symbols as they're described in the table when you run cmdlets in Exchange PowerShell. +These command conventions help you understand how a command is constructed. Except for the hyphen that indicates a parameter, you don't use these symbols as they're described in the table when you run cmdlets in Exchange PowerShell. ## Parameter sets in Exchange PowerShell -Parameter sets are groups of parameters that can be used with each other in the same command. Although parameter sets typically share some parameters, each parameter set contains at least one parameter that isn't available in the other parameter sets, and can't be used with some of the parameters in different parameter sets. +Parameter sets are groups of parameters that can be used with each other in the same command. Each parameter set contains at least one parameter that isn't available in the other parameter sets, but parameter sets typically share some parameters.s. -Many cmdlets have only one parameter set, which means that all available parameters can be used with each other. Other cmdlets have several parameter sets, which indicates some parameters perform functions that are incompatible with other parameters. For example, suppose the following parameter sets are available on the **New-SystemMessage** cmdlet: +Many cmdlets have only one parameter set, which means that all parameters can be used with each other. Other cmdlets have several parameter sets, which means some parameters can't be used with other parameters. For example, suppose the following parameter sets are available on the **New-SystemMessage** cmdlet: -`New-SystemMessage -DsnCode -Internal -Language -Text [-Confirm] [-DomainController ] [-WhatIf] ` +`New-SystemMessage -DsnCode -Internal -Language -Text [-Confirm] [-DomainController ] [-WhatIf] ` -`New-SystemMessage -Language -QuotaMessageType -Text [-Confirm] [-DomainController ] [-WhatIf] ` +`New-SystemMessage -QuotaMessageType -Language -Text [-Confirm] [-DomainController ] [-WhatIf] ` -This cmdlet has two separate parameter sets. Based on the entries, you can use these parameters together in the same command: +The following parameters are available in the first parameter set, so you can use them in the same command: - _DsnCode_ - _Internal_ @@ -61,21 +56,29 @@ This cmdlet has two separate parameter sets. Based on the entries, you can use t - _DomainController_ - _WhatIf_ -And you can use these parameters together in the same command: +The following parameters are available in the second parameter set, so you can use them in the same command: -- _Language_ - _QuotaMessageType_ +- _Language_ - _Text_ - _Confirm_ - _DomainController_ - _WhatIf_ -But you can't use these parameters together in the same command: +The parameters _DsnCode_ and _Internal_ are available only in the first parameter set. The parameter _QuotaMessageType_ is available only in the second parameter set. So, you can't use the following parameters in the same command: - _DsnCode_ and _QuotaMessageType_. - _Internal_ and _QuotaMessageType_. -The `` entry indicates the cmdlet supports the basic Windows PowerShell parameters that are available on virtually any cmdlet (for example, _Debug_). You can use common parameters with parameters from any parameter set. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). +The following parameters are available in both parameter sets, so you can use them in any **New-SystemMessage** command: + +- _Language_ +- _Text_ +- _Confirm_ +- _DomainController_ +- _WhatIf_ + +The `` entry indicates the cmdlet supports the basic Windows PowerShell parameters that are available on virtually any cmdlet (for example, _Verbose_). You can use common parameters with parameters from any parameter set. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216). ## Quotation marks in Exchange PowerShell @@ -85,15 +88,19 @@ In Exchange PowerShell, you use single quotation marks ( ' ) or double quotation - `Get-ReceiveConnector -Identity 'Contoso Receive Connector'` -If you don't enclose the value `Contoso Receive Connector` in quotes, Exchange PowerShell tries to treat each word as a new argument, and the command will fail. In this example, you'll receive an error that looks like this: +In the previous examples, if you don't enclose the value in single or double quotation marks, the command fails because PowerShell treats each word as a new argument (it thinks `Contoso` is the value of the _Identity_ parameter, and `Receive` is the value of an unspecified positional parameter). In this example, the error looks like this: > A positional parameter cannot be found that accepts argument 'Receive' -If the value contains variables, you need choose carefully between single quotes and double quotes. For example, suppose you have a variable named `$Server` that has the value `Mailbox01`. +For plain text values, single quotation marks vs. double quotation marks don't really matter. But, the choice is important when variables are involved: -- **Double quotation marks**: Variables are substituted with their values. For example, if the $Server variable has the value Mailbox01, the input **"$Server Example"** results in the output `Mailbox01 Example`. +- **Double quotation marks**: Variables are substituted with their actual values. +- **Single quotation marks**: Variables are treated literally. -- **Single quotation marks**: Variables are treated literally. The input **'$Server Example'** results in the output `$Server Example`. +For example, `$Server = Mailbox01` results in the following output based on which quotation marks you use: + +- **"$Server Example"** results in `Mailbox01 Example`. +- **'$Server Example'** results in `$Server Example`. For more information about variables, see [about_Variables](/powershell/module/microsoft.powershell.core/about/about_variables) and [about_Automatic_Variables](/powershell/module/microsoft.powershell.core/about/about_automatic_variables). @@ -101,7 +108,7 @@ For more information about variables, see [about_Variables](/powershell/module/m In any programming language, an _escape character_ is used to identify special characters literally, and not by their normal function in that language. In Exchange PowerShell, when you enclose a text string in double quotation marks, the escape character is the back quotation mark escape character ( ` ). -For example, if you want the output `The price is $23`, enter the value **"The price is \`$23"**. The escape character is required on the dollar sign character ( $ ) because $ defines variables in PowerShell. +For example, if you want the output `The price is $23`, enter the value **"The price is \`$23"**. The escape character is required on the dollar sign character ( $ ) because $ defines variables in PowerShell. If you enclose the string in single quotation marks, the only special character you need to worry about is the single quotation mark character itself, which requires two single quotation marks to escape ( `''` ). @@ -111,23 +118,19 @@ If you enclose the string in single quotation marks, the only special character The following table shows the valid operators that you can use in an Exchange command. Some of these symbols were also described in the earlier [Command conventions in Exchange PowerShell](#command-conventions-in-exchange-powershell) section. However, these symbols have different meanings when they're used on the command line as operators. For example, the minus sign that's used to indicate a parameter can also be used in a command as a mathematical operator. -
- -**** - |Operator|Description| |---|---| -|`=`|The equal sign is used as an assignment character. The value on the right side of the equal sign is assigned to the variable on the left side of the equal sign. The following characters are also assignment characters:

  • `+=`: Add the value on the right side of the equal sign to the current value that's contained in the variable on the left side of the equal sign.
  • `-=`: Subtract the value on the right side of the equal sign from the current value that's contained in the variable on the left side of the equal sign.
  • `*=`: Multiply the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
  • `/=`: Divide the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
  • `%=`: Modify the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
| -|`:`|A colon can be used to separate a parameter's name from the parameter's value. For example, `-Enabled:$True`. Using a colon is optional with all parameter types except switch parameters. For more information about switch parameters, see [about_Parameters](/powershell/module/microsoft.powershell.core/about/about_parameters).| -|`!`|The exclamation point is a logical NOT operator. When it is used with the equal ( = ) sign, the combined pair (`!=`) means "not equal to."| -|`[ ]`|Brackets are used to specify the index value of an array position. Index values are offsets that start at zero. For example, `$Red[9]` refers to the tenth index position in the array, `$Red`.

Brackets can also be used to assign a type to a variable (for example, `$A=[XML] "value"`). The following variable types are available: `Array`, `Bool`, `Byte`, `Char`, `Char[]`, `Decimal`, `Double`, `Float`, `Int`, `Int[]`, `Long`, `Long[]`, `RegEx`, `Single`, `ScriptBlock`, `String`, `Type`, and `XML.`| -|`{ }`|Braces are used to include an expression in a command. For example, Get-Process \| Where {$\_.HandleCount -gt 400}| -|`|`|The pipe symbol is used when one cmdlet pipes a result to another cmdlet. For example, Get-Mailbox -Server SRV1 \| Set-Mailbox -ProhibitSendQuota 2GB.| -|`>`|The right-angle bracket is used to send the output of a command to a file, and the contents of the file are overwritten. For example, `Get-TransportRulePredicate > "C:\My Documents\Output.txt"`.| -|`>>`|Double right-angle brackets are used to append the output of a command to an existing file. If the file doesn't exist, a new file is created. For example, `Get-TransportRulePredicate >> "C:\My Documents\Output.txt"`.| -|`"`|Double quotation marks are used to enclose text strings that contains spaces.| -|`$`|A dollar sign indicates a variable. For example, `$Blue = 10` assigns the value `10` to the variable `$Blue`.| -|`@`|The @ symbol references an associative array. For more information, see [about_Arrays](/powershell/module/microsoft.powershell.core/about/about_arrays).| +|`=`|The equal sign is an assignment character. The value on the right side of the equal sign is assigned to the variable on the left side of the equal sign (for example, `$x= Get-Mailbox`). You can also use other characters with the equal sign:

  • `+=`: Add the value on the right side of the equal sign to the current value that's contained in the variable on the left side of the equal sign.
  • `-=`: Subtract the value on the right side of the equal sign from the current value that's contained in the variable on the left side of the equal sign.
  • `*=`: Multiply the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
  • `/=`: Divide the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
  • `%=`: Modify the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
| +|`:`|Use a colon to separate a parameter's name from the parameter's value. For example, `-Enabled:$True`. A colon separator works and is optional on virtually all parameter-value pairs. A colon separator is required on switch parameters. For more information about switch parameters, see [about_Parameters](/powershell/module/microsoft.powershell.core/about/about_parameters).| +|`!`|The exclamation point is the logical NOT operator. The combined pair `!=` means "not equal to."| +|`[ ]`|Brackets specify the index value of an array position. Index values are offsets that always start at zero. For example, in the array named `$Red`, the value of the tenth position in the array is `$Red[9]`.

Brackets can also assign a type to a variable. For example, to identify the variable named `$A` as XML, use `$A=[XML] "value"`. The following variable types are available: `Array`, `Bool`, `Byte`, `Char`, `Char[]`, `Decimal`, `Double`, `Float`, `Int`, `Int[]`, `Long`, `Long[]`, `RegEx`, `Single`, `ScriptBlock`, `String`, `Type`, and `XML.`| +|`{ }`|Use braces to include an expression in a command. For example, `Get-Process | Where {$_.HandleCount -gt 400}`| +|`|`|Use the pipe symbol to pipe the output of one command to another command. For example, `Get-Mailbox -Server SRV1 | Set-Mailbox -ProhibitSendQuota 2GB`.| +|`>`|Use the right-angle bracket to send the output of a command to a file. If the file already exists, the contents are overwritten. For example, `Get-TransportRule > "C:\My Documents\TransportRules.txt"`.| +|`>>`|Use double right-angle brackets to append the output of a command to an existing file. If the file doesn't exist, a new file is created. For example, `Get-TransportRule >> "C:\My Documents\TransportRules.txt"`.| +|`"`|Use double quotation marks to enclose text strings that contain spaces. As previously described, variables are replaced with their actual values.| +|`$`|The dollar sign indicates a variable. For example, to create a variable named `$Blue` with the value 10, use `$Blue = 10`. After you store the variable, you can use it as the value of a parameter.| +|`@`|The at symbol references an associative array. For more information, see [about_Arrays](/powershell/module/microsoft.powershell.core/about/about_arrays).| |`$( )`|A dollar sign with parentheses indicates command substitution. You can use command substitution when you want to use the output of one command as an argument in another command. For example, `Get-ChildItem $(Read-Host -Prompt "Enter FileName: ")`.| |`..`|Double-periods indicate a value range. For example, if an array contains several indexes, you can return the values of all indexes between the second and fifth indexes by running the command: `$Blue[2..5]`.| |`+`|The plus sign operator adds two values together. For example, `6 + 6` equals `12`.| @@ -136,4 +139,3 @@ The following table shows the valid operators that you can use in an Exchange co |`/`|A forward slash divides one value by another. For example, `6 / 6` equals `1`.| |`%`|The percent sign has the following uses:
  • In a numerical evaluation, it returns the remainder from a division operator. For example, `6 % 4` equals `2`.
  • In a [pipeline](/powershell/module/microsoft.powershell.core/about/about_pipelines), it's shorthand for the **ForEach-Object** cmdlet. For example, `Import-Csv C:\MyFile.csv | ForEach-Object {Set-Mailbox $_.Identity -Name $_.Name}` is the same as `Import-Csv C:\MyFile.csv | % {Set-Mailbox $_.Identity -Name $_.Name}`.
| |`?`|The question mark character is shorthand for the **Where-Object** cmdlet. For example, `Get-Alias | Where-Object {$_.Definition -eq "Clear-Host"}` is the same as `Get-Alias | ? {$_.Definition -eq "Clear-Host"}`.| -| diff --git a/exchange/docs-conceptual/exchange-management-shell.md b/exchange/docs-conceptual/exchange-management-shell.md index 4e2ff0b852..f10d3cc542 100644 --- a/exchange/docs-conceptual/exchange-management-shell.md +++ b/exchange/docs-conceptual/exchange-management-shell.md @@ -2,40 +2,46 @@ title: "Exchange Server PowerShell (Exchange Management Shell)" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 9/1/2023 ms.audience: ITPro audience: ITPro ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 925ad66f-2f05-4269-9923-c353d9c19312 description: "Learn about Exchange Server PowerShell, also known as the Exchange Management Shell. This article describes how PowerShell works on Exchange servers, and provides links to other articles that can help you learn how to use the Exchange Management Shell." --- # Exchange Server PowerShell (Exchange Management Shell) -The Exchange Management Shell is built on Windows PowerShell technology and provides a powerful command-line interface that enables the automation of Exchange administration tasks. You can use the Exchange Management Shell to manage every aspect of Exchange. For example, you can create email accounts, create Send connectors and Receive connectors, configure mailbox database properties, and manage distribution groups. You can use the Exchange Management Shell to perform every task that's available in the Exchange graphical management tools, plus things that you can't do there (for example, bulk operations). In fact, when you do something in the Exchange admin center (EAC), the Exchange Control Panel (ECP), or the Exchange Management Console (EMC), it's the Exchange Management Shell that does the work behind the scenes. +The Exchange Management Shell is built on Windows PowerShell technology and provides a powerful command-line interface that enables the automation of Exchange administration tasks. You can use the Exchange Management Shell to manage every aspect of Exchange. For example, you can create email accounts, create Send connectors and Receive connectors, configure mailbox database properties, and manage distribution groups. -The Exchange Management Shell also provides a robust and flexible scripting platform. Visual Basic scripts that required many lines of code can be replaced by Exchange Management Shell commands that use as little as one line of code. The Exchange Management Shell provides this flexibility because it uses an object model that's based on the Microsoft .NET Framework. This object model enables Exchange cmdlets to apply the output from one command to subsequent commands. +You can use the Exchange Management Shell to perform every task that's available in the Exchange graphical management tools, plus things that you can't do there (for example, bulk operations). In fact, when you do something in the Exchange admin center (EAC), the Exchange Control Panel (ECP), or the Exchange Management Console (EMC), it's the Exchange Management Shell that does the work behind the scenes. + +The Exchange Management Shell also provides a robust and flexible scripting platform. You can often replace long, complex Visual Basic scripts with Exchange Management Shell commands that use as little as one line of code. The Exchange Management Shell offers this flexibility because it uses an object model that's based on the Microsoft .NET Framework. This object model enables Exchange cmdlets to apply the output from one command to subsequent commands. To start using the Exchange Management Shell immediately, see the [Exchange Management Shell documentation](#exchange-management-shell-documentation) section later in this article. +> [!NOTE] +> There is no Microsoft-provided module in the PowerShell Gallery for Exchange Server PowerShell. Instead, to use PowerShell in Exchange Server, you have the following options: +> +> - Open the Exchange Management Shell on an Exchange server or that you've installed locally on your own computer using a **Management tools** only installation of Exchange server. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](open-the-exchange-management-shell.md). +> - Open a remote PowerShell session from Windows PowerShell on your local computer. For more information, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). + ## How the Exchange Management Shell works on all Exchange server roles except Edge Transport Whether you use the Exchange Management Shell on a local Exchange server or on an Exchange server that's located across the country, remote PowerShell does the work. -When you click the Exchange Management Shell shortcut on an Exchange server, the local instance of Windows PowerShell performs the following steps: - -1. Connect to the closest Exchange server (most often, the local Exchange server) using a required Windows PowerShell component called Windows Remote Management (WinRM). +When you select the Exchange Management Shell shortcut on an Exchange server, the local instance of Windows PowerShell takes the following steps: -2. Perform authentication checks. - -3. Create a remote PowerShell session for you to use. +1. Connects to the closest Exchange server (typically, the local Exchange server) using a required Windows PowerShell component called Windows Remote Management (WinRM). +2. Performs authentication checks. +3. Creates a remote PowerShell session for you to use. You only get access to the Exchange cmdlets and parameters that are associated with the Exchange management role groups and management roles you're assigned. For more information about how Exchange uses role groups and roles to manage who can do what tasks, see [Exchange Server permissions](/Exchange/permissions/permissions). -A benefit of remote PowerShell is that you can use Windows PowerShell on a local computer to connect to a remote Exchange server, and import the Exchange cmdlets in the Windows PowerShell session so you can administer Exchange. The only requirements for the computer are: +A benefit of remote PowerShell is that you can use Windows PowerShell on a local computer to connect to an Exchange server remotely by importing the Exchange cmdlets into the PowerShell session. The only requirements for the computer are: - A supported operating system for Exchange Server. - A supported version of the .NET Framework. @@ -48,15 +54,15 @@ For details, see the following articles: - [Exchange 2013 system requirements](/exchange/exchange-2013-system-requirements-exchange-2013-help) - [Exchange 2010 system requirements](/previous-versions/office/exchange-server-2010/aa996719(v=exchg.141)) -However, we recommend that you install the Exchange management tools (which includes the Exchange Management Shell) on any computer that you use to extensively manage Exchange Server. Without the Exchange management tools installed, you need to connect to the remote Exchange server manually, and you don't have access to the additional capabilities that the Exchange management tools provide. +However, we recommend that you install the Exchange management tools (which includes the Exchange Management Shell) on any computer that you use to frequently manage Exchange Server. Without the Exchange management tools installed, you need to manually connect to the remote Exchange server, and you don't have access to the additional capabilities that the Exchange management tools provide. For more information about connecting to Exchange servers without the Exchange management tools installed, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). -## How Exchange Management Shell works on Edge Transport servers +## How the Exchange Management Shell works on Edge Transport servers On Edge Transport servers, the Exchange Management Shell works differently. You typically deploy Edge Transport servers in your perimeter network, either as stand-alone servers or as members of a perimeter Active Directory domain. -When you click the Exchange Management Shell shortcut on an Exchange Edge Transport server, the local instance of Windows PowerShell creates a local PowerShell session for you to use. +When you select the Exchange Management Shell shortcut on an Exchange Edge Transport server, the local instance of Windows PowerShell creates a local PowerShell session for you to use. Edge Transport servers don't use management roles or management role groups to control permissions. The local Administrators group controls who can configure the Exchange features on the local server. @@ -66,8 +72,6 @@ For more information about Edge Transport servers, see [Edge Transport Servers]( The following table provides links to articles that can help you learn about and use the Exchange Management Shell. -**** - |Article|Description| |---|---| |[Open the Exchange Management Shell](open-the-exchange-management-shell.md)|Find and open the Exchange Management Shell on an Exchange server or a computer that has the Exchange management tools installed.| @@ -76,5 +80,3 @@ The following table provides links to articles that can help you learn about and |[Find the permissions required to run any Exchange cmdlet](find-exchange-cmdlet-permissions.md)|Find the permissions you need to run a specific cmdlet, or one or more parameters on the cmdlet.| |[Exchange cmdlet syntax](exchange-cmdlet-syntax.md)|Learn about the structure and syntax of cmdlets in Exchange PowerShell.| |[Recipient filters in Exchange Management Shell commands](recipient-filters.md)|Learn about recipient filters in the Exchange Management Shell.| -|[Use Update-ExchangeHelp to update Exchange PowerShell help articles on Exchange servers](use-update-exchangehelp.md)|Learn how to use Update-ExchangeHelp to update help for Exchange cmdlet reference articles on Exchange servers.| -| diff --git a/exchange/docs-conceptual/exchange-online-powershell-v2.md b/exchange/docs-conceptual/exchange-online-powershell-v2.md index 71ee52689f..5849e19153 100644 --- a/exchange/docs-conceptual/exchange-online-powershell-v2.md +++ b/exchange/docs-conceptual/exchange-online-powershell-v2.md @@ -1,60 +1,152 @@ --- -title: About the Exchange Online PowerShell V2 module +title: About the Exchange Online PowerShell V3 module ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -ms.reviewer: navgupta -localization_priority: Priority +ms.reviewer: +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Admins can learn about the installation, maintenance, and design of the Exchange Online PowerShell V2 module that they use to connect to all Exchange-related PowerShell environments in Microsoft 365." +keywords: Exchange Online PowerShell V2 module, Exchange Online PowerShell V3 module, EXO V2 module, EXO V3 module +description: "Admins can learn about the installation, maintenance, and design of the Exchange Online PowerShell V3 module that they use to connect to all Exchange-related PowerShell environments in Microsoft 365." --- -# About the Exchange Online PowerShell V2 module +# About the Exchange Online PowerShell module -The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) uses modern authentication and works with multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. +The Exchange Online PowerShell module uses modern authentication and works with or without multi-factor authentication (MFA) for connecting to all Exchange-related PowerShell environments in Microsoft 365: Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. -For connection instructions using the EXO V2 module, see the following articles: +For connection instructions using the module, see the following articles: - [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md) -- [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md) +- [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md) - [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md) +- [App-only authentication for unattended scripts in Exchange Online PowerShell and Security & Compliance PowerShell](app-only-auth-powershell-v2.md) +- [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md) +- [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.md) The rest of this article explains how the module works, how to install and maintain the module, and the optimized Exchange Online cmdlets that are available in the module. -## Report bugs and issues for the EXO V2 module +> [!TIP] +> Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). -When you report an issue at `exocmdletpreview[at]service[dot]microsoft[dot]com`, be sure to include the log files in your email message. To generate the log files, replace \ with the output folder you want, and run the following command: +## REST API connections in the EXO V3 module -```powershell -Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath -LogLevel All -``` +Exchange Online PowerShell and Security & Compliance PowerShell now use REST API connections for all cmdlets: -> [!NOTE] -> The latest version of EXO V2 module and frequent use of the **Connect-ExchangeOnline** and **Disconnect-ExchangeOnline** cmdlets in a single PowerShell session or script might lead to a memory leak. The best way to avoid this issue is to use the _CommandName_ parameter on the **Connect-ExchangeOnline** cmdlet to limit the cmdlets that are used in the session. +- **Exchange Online PowerShell**: EXO V3 module v3.0.0 or later. +- **Security & Compliance PowerShell**: EXO V3 module v3.2.0 or later. + +REST API connections require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](#powershellget-for-rest-api-connections-in-windows). + +Cmdlets in REST API connections have the following advantages over their historical counterparts: + +- **More secure**: Built-in support for modern authentication and no dependence on the remote PowerShell session. PowerShell on your client computer doesn't need [Basic authentication in WinRM](#turn-on-basic-authentication-in-winrm). +- **More reliable**: Transient failures use built-in retries, so failures or delays are minimized. For example: + - Failures due to network delays. + - Delays due to large queries that take a long time to complete. +- **Better performance**: REST API connections avoid setting up a PowerShell runspace. + +The benefits of cmdlets in REST API connections are described in the following table: + +| |Remote PowerShell cmdlets|Get-EXO\* cmdlets|REST API cmdlets| +|---|---|---|---| +|**Security**|Least secure|Highly secure|Highly secure| +|**Performance**|Low performance|High performance|Medium performance| +|**Reliability**|Least reliable|Highly reliable|Highly reliable| +|**Functionality**|All parameters and output properties available|Limited parameters and output properties available|All parameters and output properties available| + +REST API cmdlets have the same cmdlet names and work just like their remote PowerShell equivalents, so you don't need to update cmdlet names or parameters in older scripts. + +> [!TIP] +> The [Invoke-Command](/powershell/module/microsoft.powershell.core/invoke-command) cmdlet doesn't work in REST API connections. For alternatives, see [Workarounds for Invoke-Command scenarios in REST API connections](invoke-command-workarounds-rest-api.md). + +Basic authentication (remote PowerShell) connections are deprecated in Exchange Online PowerShell and Security & Compliance PowerShell. For more information, see [here](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692) and [here](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). + +A few cmdlets in Exchange Online PowerShell have been updated with the experimental _UseCustomRouting_ switch in REST API connections. This switch routes the command directly to the required Mailbox server, and might improve overall performance. Use the _UseCustomRouting_ switch experimentally. + +- When you use the _UseCustomRouting_ switch, you can use only the following values for identity of the mailbox: + - User principal name (UPN) + - Email address + - Mailbox GUID + +- The _UseCustomRouting_ switch is available only on the following Exchange Online PowerShell cmdlets in REST API connections: + - **Get-Clutter** + - **Get-FocusedInbox** + - **Get-InboxRule** + - **Get-MailboxAutoReplyConfiguration** + - **Get-MailboxCalendarFolder** + - **Get-MailboxFolderPermission** + - **Get-MailboxFolderStatistics** + - **Get-MailboxMessageConfiguration** + - **Get-MailboxPermission** + - **Get-MailboxRegionalConfiguration** + - **Get-MailboxStatistics** + - **Get-MobileDeviceStatistics** + - **Get-UserPhoto** + - **Remove-CalendarEvents** + - **Set-Clutter** + - **Set-FocusedInbox** + - **Set-MailboxRegionalConfiguration** + - **Set-UserPhoto** + +- Use the [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet to get information about REST API connections to Exchange Online PowerShell and Security & Compliance PowerShell. This cmdlet is required because the [Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession) cmdlet in Windows PowerShell doesn't return information for REST API connections. + + Scenarios where you can use **Get-ConnectionInformation** are described in the following table: + + |Scenario|Expected output| + |---|---| + |Run after **Connect-ExchangeOnline** or **Connect-IPPSSession** commands for REST API connections.|Returns one connection information object.| + |Run after multiple **Connect-ExchangeOnline** or **Connect-IPPSSession** commands for REST API connections.|Returns a collection of connection information objects.| + +- Use the _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet to avoid loading format data and to run **Connect-ExchangeOnline** commands faster. + +- Cmdlets backed by the REST API have a 15-minute timeout, which can affect bulk operations. For example, the following **Update-DistributionGroupMember** command to update 10,000 members of a distribution group might time out: + + ```powershell + $Members = @("member1","member2",...,"member10000") + + Update-DistributionGroupMember -Identity DG01 -Members $Members + ``` + + Instead, use the **Update-DistributionGroupMember** command to update fewer members, and then add the remaining members individually using an **Add-DistributionGroupMember** command. For example: + + ```powershell + Update-DistributionGroupMember -Identity DG01 -Members $Members[0..4999] -## How the EXO V2 module works + $Remaining = $Members[-5000..-1] -The module contains a small set of exclusive Exchange Online PowerShell cmdlets that are optimized for bulk data retrieval scenarios (think: thousands and thousands of objects). When you first open the module, you'll only see these exclusive cmdlets. After you [connect to your Exchange Online organization](connect-to-exchange-online-powershell.md), you'll see all of the familiar cmdlets that are available in Exchange Online PowerShell. + foreach ($Member in $Remaining) -The module use modern authentication for all cmdlets. You can't use Basic authentication in the EXO V2 module; however, you still need to enable the Basic authentication setting in WinRM as explained [later in this article](#prerequisites-for-the-exo-v2-module). + { + Add-DistributionGroupMember -Identity DG01 -Member $Member + } + ``` -The Exchange Online cmdlets in the EXO V2 module are meant to replace their older, less efficient equivalents, but the equivalent cmdlets are still available (after you connect). +For more information about what's new in the EXO V3 module, see the [Release notes](#release-notes) section later in this article. -The improved Exchange Online PowerShell cmdlets that are only available in the EXO V2 module are listed in the following table: +## Report bugs and issues for Preview versions of the Exchange Online PowerShell module -
+> [!TIP] +> For General Availability (GA) versions of the module, don't use the following email address to report issues. Messages about GA versions of the module won't be answered. Instead, open a support ticket. -**** +For **Preview versions of the module**, use `exocmdletpreview[at]service[dot]microsoft[dot]com` to report any issues that you might encounter. Be sure to include the log files in your email message. To generate the log files, replace \ with an output folder, and then run the following command: -|EXO V2 module cmdlet|Older related cmdlet| +```powershell +Connect-ExchangeOnline -EnableErrorReporting -LogDirectoryPath -LogLevel All +``` + +## Cmdlets in the Exchange Online PowerShell module + +The EXO module contains nine exclusive **Get-EXO\*** cmdlets that are optimized for speed in bulk data retrieval scenarios (thousands and thousands of objects) in Exchange Online PowerShell. The improved cmdlets in the module are listed in the following table: + +|EXO module cmdlet|Older related cmdlet| |---|---| |[Get-EXOMailbox](/powershell/module/exchange/get-exomailbox)|[Get-Mailbox](/powershell/module/exchange/get-mailbox)| |[Get-EXORecipient](/powershell/module/exchange/get-exorecipient)|[Get-Recipient](/powershell/module/exchange/get-recipient)| @@ -65,146 +157,218 @@ The improved Exchange Online PowerShell cmdlets that are only available in the E |[Get-EXOMailboxFolderStatistics](/powershell/module/exchange/get-exomailboxfolderstatistics)|[Get-MailboxFolderStatistics](/powershell/module/exchange/get-mailboxfolderstatistics)| |[Get-EXOMailboxFolderPermission](/powershell/module/exchange/get-exomailboxfolderpermission)|[Get-MailboxFolderPermission](/powershell/module/exchange/get-mailboxfolderpermission)| |[Get-EXOMobileDeviceStatistics](/powershell/module/exchange/get-exomobiledevicestatistics)|[Get-MobileDeviceStatistics](/powershell/module/exchange/get-mobiledevicestatistics)| -| - -The connection-related cmdlets that are available in the EXO V2 module are listed in the following table: -
- -**** +> [!TIP] +> If you open multiple connections to Exchange Online PowerShell in the same window, the **Get-EXO\*** cmdlets are always associated with the last (most recent) Exchange Online PowerShell connection. Run the following command to find the REST API session where the **Get-EXO\*** cmdlets are run: `Get-ConnectionInformation | Where-Object {$_.ConnectionUsedForInbuiltCmdlets -eq $true}`. -|EXO V2 module cmdlet|Older related cmdlet| -|---|---| -|[Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline)|[Connect-EXOPSSession](v1-module-mfa-connect-to-exo-powershell.md)

or

[New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession)| -|[Connect-IPPSSession](/powershell/module/exchange/connect-ippssession)|[Connect-IPPSSession](v1-module-mfa-connect-to-scc-powershell.md)| -|[Disconnect-ExchangeOnline](/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession)| -| +The connection-related cmdlets in the module are listed in the following table: -Miscellaneous Exchange Online cmdlets that happen to be in the EXO V2 module are listed in the following table: +|EXO module cmdlet|Older related cmdlet|Comments| +|---|---|---| +|[Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline)|**Connect-EXOPSSession** in V1 of the module
or
[New-PSSession](/powershell/module/microsoft.powershell.core/new-pssession)|| +|[Connect-IPPSSession](/powershell/module/exchange/connect-ippssession)|**Connect-IPPSSession** in V1 of the module|| +|[Disconnect-ExchangeOnline](/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](/powershell/module/microsoft.powershell.core/remove-pssession)|| +|[Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation)|[Get-PSSession](/powershell/module/microsoft.powershell.core/get-pssession)|Available in v3.0.0 or later.| -
+> [!TIP] +> Frequent use of the **Connect-ExchangeOnline** and **Disconnect-ExchangeOnline** cmdlets in a single PowerShell session or script might lead to a memory leak. The best way to avoid this issue is to use the _CommandName_ parameter on the **Connect-ExchangeOnline** cmdlet to limit the cmdlets that are used in the session. -**** +Miscellaneous Exchange Online cmdlets that happen to be in the module are listed in the following table: -|EXO V2 module cmdlet|Comments| +|Cmdlet|Comments| |---|---| +|[Get-DefaultTenantBriefingConfig](/powershell/module/exchange/get-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| +|[Set-DefaultTenantBriefingConfig](/powershell/module/exchange/set-defaulttenantbriefingconfig)|Available in v3.2.0 or later.| +|[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| +|[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0 or later.| |[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| |[Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig)|Available in v2.0.4 or later.| |[Get-UserBriefingConfig](/powershell/module/exchange/get-userbriefingconfig)|Replaced by [Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig).| |[Set-UserBriefingConfig](/powershell/module/exchange/set-userbriefingconfig)|Replaced by [Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig).| -|[Get-VivaInsightsSettings](/powershell/module/exchange/get-vivainsightssettings)|Available in v2.0.5-Preview2 or later.| -|[Set-VivaInsightsSettings](/powershell/module/exchange/set-vivainsightssettings)|Available in v2.0.5-Preview2 or later.| -| +|[Get-VivaInsightsSettings](/powershell/module/exchange/get-vivainsightssettings)|Available in v2.0.5 or later.| +|[Set-VivaInsightsSettings](/powershell/module/exchange/set-vivainsightssettings)|Available in v2.0.5 or later.| +|[Get-VivaModuleFeature](/powershell/module/exchange/get-vivamodulefeature)|Available in v3.2.0 or later.| +|[Get-VivaModuleFeatureEnablement](/powershell/module/exchange/get-vivamodulefeatureenablement)|Available in v3.2.0 or later.| +|[Add-VivaModuleFeaturePolicy](/powershell/module/exchange/add-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Get-VivaModuleFeaturePolicy](/powershell/module/exchange/get-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Remove-VivaModuleFeaturePolicy](/powershell/module/exchange/remove-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Update-VivaModuleFeaturePolicy](/powershell/module/exchange/update-vivamodulefeaturepolicy)|Available in v3.2.0 or later.| +|[Add-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/add-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Get-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/get-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| +|[Remove-VivaOrgInsightsDelegatedRole](/powershell/module/exchange/remove-vivaorginsightsdelegatedrole)|Available in v3.7.0-Preview1 or later.| -## Install and maintain the EXO V2 module +## Install and maintain the Exchange Online PowerShell module -You can download the EXO V2 module from the PowerShell gallery at . +You download the module from the PowerShell gallery at . -The procedures in this section explain how to install, update, and uninstall the EXO V2 module. +The procedures in this section explain how to install, update, and uninstall the module. -### Supported operating systems for the EXO V2 module +### Supported operating systems for the Exchange Online PowerShell module -The latest version of the EXO V2 module is officially supported in PowerShell 7 on Windows, Linux, and Apple macOS. +The latest versions of the module are officially supported in PowerShell 7 on Windows, Linux, and Apple macOS. -Specifically, version **2.0.4 or later** of the EXO V2 module is supported in **PowerShell 7.0.3 or later**. +Specifically, version **2.0.4 or later** is supported in **PowerShell 7.0.3 or later**. For more information about PowerShell 7, see [Announcing PowerShell 7.0](https://devblogs.microsoft.com/powershell/announcing-PowerShell-7-0/). #### Apple macOS -The EXO V2 module is supported in the following versions of macOS: +The module is supported in the following versions of macOS: - macOS 11 Big Sur or later - macOS 10.15 Catalina - macOS 10.14 Mojave -For instructions on installing PowerShell 7 on macOS, see [Installing PowerShell on macOS](/powershell/scripting/install/installing-powershell-core-on-macos?view=powershell-7.1&preserve-view=true). +For instructions on installing PowerShell 7 on macOS, see [Installing PowerShell on macOS](/powershell/scripting/install/installing-powershell-core-on-macos). -#### Linux +As described in the installation article, you need to install OpenSSL, which is required for WSMan. -The EXO V2 module is officially supported in the following distributions of Linux: +After you install PowerShell 7 and OpenSSL, do the following steps: -- Ubuntu 18.04/20.04 +1. Run PowerShell as superuser: `sudo pwsh` +2. In the PowerShell superuser session, run the following commands: + + ```powershell + Install-Module -Name PSWSMan + + Install-WSMan + ``` -If you have trouble using the EXO V2 module on other distributions of Linux, send email to the following address: `exocmdletpreview[at]service[dot]microsoft[dot]com`. The email address is purposefully obfuscated to avoid spam. + If prompted, accept PSGallery as the source for the cmdlets. + +Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exchange-online-powershell-module) and [install the Exchange Online PowerShell module](#install-the-exchange-online-powershell-module). + +#### Linux + +The module is officially supported in the following distributions of Linux: + +- Ubuntu 24.04 LTS +- Ubuntu 20.04 LTS +- Ubuntu 18.04 LTS For instructions on installing PowerShell 7 on Linux, see [Installing PowerShell on Linux](/powershell/scripting/install/installing-powershell-core-on-linux?view=powershell-7.1&preserve-view=true). +After you install PowerShell 7, do the following steps: + +1. Run PowerShell as superuser: `sudo pwsh` +2. In the PowerShell superuser session, run the following commands: + + ```powershell + Install-Module -Name PSWSMan + + Install-WSMan + ``` + + If prompted, accept PSGallery as the source for the cmdlets. + +Now you can do the [regular PowerShell prerequisites](#prerequisites-for-the-exchange-online-powershell-module) and [install the Exchange Online PowerShell module](#install-the-exchange-online-powershell-module). + +> [!NOTE] +> If you connect to Exchange Online PowerShell from a network that's behind a proxy server, the EXO V2 module (version v2.0.5 or earlier) doesn't work in Linux. You need to use the EXO V3 module (v3.0.0 or later) in Linux to connect from a network that's behind a proxy server. + #### Windows -All versions of the EXO V2 module are supported in Windows PowerShell 5.1. PowerShell 7 on Windows requires version 2.0.4 or later of the EXO V2 module. +All versions of the module are supported in Windows PowerShell 5.1. -The EXO V2 module is supported in the following versions of Windows: +PowerShell 7 on Windows requires version 2.0.4 or later. -- Windows 10 -- Windows 8.14 -- Windows Server 2019 -- Windows Server 2016 -- Windows Server 2012 or Windows Server 2012 R24 -- Windows 7 Service Pack 1 (SP1)1,2,3 -- Windows Server 2008 R2 SP11,2,3 +Version 2.0.5 or later of the module requires the Microsoft .NET Framework 4.7.2 or later to connect. Otherwise, you get a `System.Runtime.InteropServices.OSPlatform` error. This requirement shouldn't be an issue in current versions of Windows. For more information about versions of Windows that support the .NET Framework 4.7.2, see [this article](/dotnet/framework/migration-guide/versions-and-dependencies#net-framework-472). -1 This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. +Windows PowerShell requirements and module support **in older versions of Windows** are described in the following list: -2 This version of Windows doesn't support version 2.0.4 or later of the EXO V2 module. Only version 2.0.3 or earlier is supported. +- Windows 8.1¹ +- Windows Server 2012 or Windows Server 2012 R2¹ +- Windows 7 Service Pack 1 (SP1)² ³ ⁴ +- Windows Server 2008 R2 SP1² ³ ⁴ -3 Windows PowerShell 5.1 on this version of Windows requires the Microsoft .NET Framework 4.5 or later and the Windows Management Framework 5.1. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). +- ¹ PowerShell 7 on this version of Windows requires the [Windows 10 Universal C Runtime (CRT)](https://www.microsoft.com/download/details.aspx?id=50410). +- ² Support for this version of Windows has ended, and is now supported only in Azure virtual machines. +- ³ This version of Windows supports only v2.0.3 or earlier versions of the module. +- ⁴ Windows PowerShell 5.1 on this version of Windows requires the .NET Framework 4.5 or later and the Windows Management Framework 5.1. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). -4 PowerShell 7 on this version of Windows requires the [Windows 10 Universal C Runtime (CRT)](https://www.microsoft.com/download/details.aspx?id=50410). +### Prerequisites for the Exchange Online PowerShell module -### Prerequisites for the EXO V2 module +#### Set the PowerShell execution policy to RemoteSigned -> [!NOTE] -> The settings described in this section are required in all versions of PowerShell on all operating systems. +> [!TIP] +> The settings in this section apply to all versions of PowerShell on all operating systems. -- PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect: +PowerShell needs to be configured to run scripts, and by default, it isn't. You get the following error when you try to connect: - > Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. +> Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files. - To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated PowerShell window (a PowerShell window you open by selecting **Run as administrator**): +To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated PowerShell window (a PowerShell window you open by selecting **Run as administrator**): - ```powershell - Set-ExecutionPolicy RemoteSigned - ``` +```powershell +Set-ExecutionPolicy RemoteSigned +``` - For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). +For more information about execution policies, see [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. +#### Turn on Basic authentication in WinRM - **Note**: You must temporarily enable WinRM to run the following commands. You can enable WinRM by running the command: `winrm quickconfig`. +> [!IMPORTANT] +> REST API connections don't require Basic authentication in WinRM as described in this section. As described [earlier in this article](#rest-api-connections-in-the-exo-v3-module), Basic authentication (remote PowerShell) access to Exchange Online PowerShell and Security & Compliance PowerShell are deprecated. The information in this section is maintained for historical purposes. - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in PowerShell): +For remote PowerShell connections that don't use the REST API (which are now impossible), WinRM needs to allow Basic authentication. **We don't send the username and password combination**. The Basic authentication **header** is required to send the session's OAuth token, because the client-side implementation of WinRM doesn't support OAuth. - ```dos - winrm get winrm/config/client/auth - ``` +To verify that Basic authentication is enabled for WinRM, run the following command in a **Command Prompt** or **Windows PowerShell**: + +> [!NOTE] +> The following commands require that WinRM is enabled. To enable WinRM, run the following command: `winrm quickconfig`. + +```DOS +winrm get winrm/config/client/auth +``` + +If you don't see the value `Basic = true`, you need to run **one** of the following commands to enable Basic authentication for WinRM: - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in PowerShell) to enable Basic authentication for WinRM: +- **In a Command Prompt**: - ```dos + ```DOS winrm set winrm/config/client/auth @{Basic="true"} ``` - **Note**: If you'd rather run the command in PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. +- **In Windows PowerShell**: + + ```powershell + winrm set winrm/config/client/auth '@{Basic="true"}' + ``` + +- **In Windows PowerShell to modify the registry**: + + ```PowerShell + Set-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows\WinRM\Client' -Name 'AllowBasic' -Type DWord -Value '1' + ``` + +If Basic authentication for WinRM is disabled, you get one of the following errors when you try to connect using a Basic authentication (remote PowerShell) connection: + +> The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. +> +> Create Powershell Session is failed using OAuth. - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: +### PowerShellGet for REST API connections in Windows - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. +[REST API connections](#rest-api-connections-in-the-exo-v3-module) in Windows require the PowerShellGet module, and by dependency, the PackageManagement module. Consideration for these modules is more for PowerShell 5.1 than PowerShell 7, but all versions of PowerShell benefit from having the latest versions of the modules installed. For installation and update instructions, see [Installing PowerShellGet on Windows](/powershell/scripting/gallery/installing-psget). > [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). +> Beta versions of the PackageManagement or PowerShellGet modules might cause connection issues. If you have connection issues, verify that you don't have Beta versions of the modules installed by running the following command: `Get-InstalledModule PackageManagement -AllVersions; Get-InstalledModule PowerShellGet -AllVersions`. -### Install the EXO V2 module +If you don't have PowerShellGet installed when you try to create a REST API connection, you get the following error when you try to connect: -To install the EXO V2 module for the first time, complete the following steps: +> Cannot find a cmdlet Update-Manifest + +### Install the Exchange Online PowerShell module + +To install the module for the first time, complete the following steps: 1. Install or update the PowerShellGet module as described in [Installing PowerShellGet](/powershell/scripting/gallery/installing-psget). 2. Close and re-open the Windows PowerShell window. -3. Now you can use the **Install-Module** cmdlet to install the EXO V2 module from the PowerShell Gallery. Typically, you'll want the latest public version of the module, but you can also install a Preview version if one is available. +3. Now you can use the **Install-Module** cmdlet to install the module from the PowerShell Gallery. Typically, you want the latest public version of the module, but you can also install a Preview version if any are available. - - To install **the latest public version** of the module, run **one** of the the following commands: + - To install **the latest public version** of the module, run **one** of the following commands: - In an elevated PowerShell window (all users): @@ -218,7 +382,27 @@ To install the EXO V2 module for the first time, complete the following steps: Install-Module -Name ExchangeOnlineManagement -Scope CurrentUser ``` - - To install **a Preview version** of the module, replace \ with the necessary value, and run **one** of the following commands: + - To see **the available Preview versions** of the module, run the following command: + + ```powershell + Find-Module ExchangeOnlineManagement -AllVersions -AllowPrerelease + ``` + + - To install **the latest available Preview version** of the module, run **one** of the following commands: + + - In an elevated PowerShell window (all users): + + ```powershell + Install-Module -Name ExchangeOnlineManagement -AllowPrerelease + ``` + + - Only for the current user account: + + ```powershell + Install-Module -Name ExchangeOnlineManagement -Scope CurrentUser -AllowPrerelease + ``` + + - To install **a specific Preview version** of the module, replace \ with the necessary value, and run **one** of the following commands: - In an elevated PowerShell window (all users): @@ -236,19 +420,21 @@ To install the EXO V2 module for the first time, complete the following steps: For detailed syntax and parameter information, see [Install-Module](/powershell/module/powershellget/install-module). -### Update the EXO V2 module +### Update the Exchange Online PowerShell module -If the module is already installed on your computer, you can run the following commands to see the version that's currently installed and update it to the latest version from the PowerShell Gallery: +If the module is already installed on your computer, you can use the procedures in this section to update the module. -1. To see the version of the module that's currently installed, run the following commands: +1. To see the version of the module that's currently installed and where it's installed, run the following command: ```powershell - Import-Module ExchangeOnlineManagement; Get-Module ExchangeOnlineManagement + Get-InstalledModule ExchangeOnlineManagement | Format-List Name,Version,InstalledLocation ``` -2. You can use the **Update-Module** cmdlet to update the EXO V2 module from the PowerShell Gallery. Typically, you'll want the latest public version of the module, but you can also upgrade to a Preview version if one is available. + If the module is installed in C:\Program Files\WindowsPowerShell\Modules\, it's installed for all users. If the module is installed in your Documents folder, it's installed only for the current user account. - - To upgrade to **the latest public version** of the module, run **one** of the following commands based on how you originally installed the module (in an elevated PowerShell window vs. `Scope CurrentUser`): +2. You can use the **Update-Module** cmdlet to update the module from the PowerShell Gallery. Typically, you want the latest public version of the module, but you can also upgrade to a Preview version if any are available. + + - To upgrade to **the latest public version** of the module, run **one** of the following commands based on how you originally installed the module (all users vs. only for the current user account): - In an elevated PowerShell window (all users): @@ -262,19 +448,41 @@ If the module is already installed on your computer, you can run the following c Update-Module -Name ExchangeOnlineManagement -Scope CurrentUser ``` - - To upgrade to **a Preview version** of the module, replace \ with the necessary value, and run **one** of the following commands based on how you originally installed the module (in an elevated PowerShell window vs. `Scope CurrentUser`): + - To upgrade to **a Preview version** of the module, you can upgrade to the latest available Preview version, or you can use the _RequiredVersion_ parameter to upgrade to a specific Preview version. - - In an elevated PowerShell window (all users): + - To see **the available Preview versions** of the module, run the following command: ```powershell - Update-Module -Name ExchangeOnlineManagement -RequiredVersion -AllowPrerelease + Find-Module ExchangeOnlineManagement -AllVersions -AllowPrerelease ``` - - Only for the current user account: + - To upgrade to **the latest available Preview version** of the module, run **one** of the following commands: - ```powershell - Update-Module -Name ExchangeOnlineManagement -RequiredVersion -AllowPrerelease -Scope CurrentUser - ``` + - In an elevated PowerShell window (all users): + + ```powershell + Update-Module -Name ExchangeOnlineManagement -AllowPrerelease + ``` + + - Only for the current user account: + + ```powershell + Update-Module -Name ExchangeOnlineManagement -Scope CurrentUser -AllowPrerelease + ``` + + - To upgrade to **a specific Preview version** of the module, replace \ with the necessary value, and run **one** of the following commands: + + - In an elevated PowerShell window (all users): + + ```powershell + Update-Module -Name ExchangeOnlineManagement -RequiredVersion -AllowPrerelease + ``` + + - Only for the current user account: + + ```powershell + Update-Module -Name ExchangeOnlineManagement -Scope CurrentUser -RequiredVersion -AllowPrerelease + ``` When you're finished, enter **Y** to accept the license agreement. @@ -286,14 +494,28 @@ If the module is already installed on your computer, you can run the following c For detailed syntax and parameter information, see [Update-Module](/powershell/module/powershellget/update-module). -### Troubleshoot installing the EXO V2 module +### Troubleshoot installing the Exchange Online PowerShell module + +- You receive one of the following errors: + + > The specified module 'ExchangeOnlineManagement' with PowerShellGetFormatVersion '\' isn't supported by the current version of PowerShellGet. Get the latest version of the PowerShellGet module to install this module, 'ExchangeOnlineManagement'. -- If you receive the following error: + > WARNING: Unable to download from URI 'https://go.microsoft.com/fwlink/?LinkID=627338&clcid=0x409' to ''. - > The specified module 'ExchangeOnlineManagement' with PowerShellGetFormatVersion '\' is not supported by the current version of PowerShellGet. Get the latest version of the PowerShellGet module to install this module, 'ExchangeOnlineManagement'. + > WARNING: Unable to download the list of available providers. Check your internet connection. Update your installation of the PowerShellGet module to the latest version as described in [Installing PowerShellGet](/powershell/scripting/gallery/installing-psget). Be sure to close and re-open the PowerShell window before you attempt to update the ExchangeOnlineManagement module again. +- You receive the following error: + + > No match was found for the specified search criteria and module name 'ExchangeOnlineManagement'. Try running `Get-PSRepository` to see all available registered module repositories. + + The default repository for PowerShell modules isn't set to PSGallery. To fix this error, run the following command: + + ```powershell + Register-PSRepository -Default + ``` + - As of April 2020, the PowerShell Gallery only supports connections using TLS 1.2 or later. For more information, see [PowerShell Gallery TLS Support](https://devblogs.microsoft.com/powershell/powershell-gallery-tls-support/). To check your current settings in the Microsoft .NET Framework, run the following command in Windows PowerShell: @@ -302,13 +524,13 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m [Net.ServicePointManager]::SecurityProtocol ``` - As described in the PowerShell Gallery TLS Support article, to *temporarily* change the security protocol to TLS 1.2 to install the PowerShellGet or ExchangeOnlineManagement modules, run the following command in Windows PowerShell *before* you install the module: + As described in the PowerShell Gallery TLS Support article, to _temporarily_ change the security protocol to TLS 1.2 to install the PowerShellGet or ExchangeOnlineManagement modules, run the following command in Windows PowerShell _before_ you install the module: ```powershell - [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 + [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 ``` - To *permanently* enable strong cryptography in the Microsoft .NET Framework version 4.x or later, run one of the following commands based on your Windows architecture: + To _permanently_ enable strong cryptography in the Microsoft .NET Framework version 4.x or later, run one of the following commands based on your Windows architecture: - x64: @@ -316,7 +538,7 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m Set-ItemProperty -Path 'HKLM:\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Type DWord -Value '1' ``` - - x86 + - x86: ```powershell Set-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\.NETFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Type DWord -Value '1' @@ -324,17 +546,20 @@ For detailed syntax and parameter information, see [Update-Module](/powershell/m For more information, see [SchUseStrongCrypto](/dotnet/framework/network-programming/tls#schusestrongcrypto). -### Uninstall the EXO V2 module +### Uninstall the Exchange Online PowerShell module -To uninstall the module, run **one** of the following commands based on how you originally installed the module (in an elevated PowerShell window vs. `Scope CurrentUser`): +To see the version of the module that's currently installed and where it's installed, run the following command: -- In an elevated PowerShell window (all users): + ```powershell + Get-InstalledModule ExchangeOnlineManagement | Format-List Name,Version,InstalledLocation + ``` - ```powershell - Uninstall-Module -Name ExchangeOnlineManagement - ``` + If the module is installed in C:\Program Files\WindowsPowerShell\Modules\, it was installed for all users. If the module is installed in your Documents folder, it was installed only for the current user account. -- Only for the current user account: +To uninstall the module, run the following command in one of the following environments based on how you originally installed the module (all users vs. only for the current user account): + +- In an elevated PowerShell window (all users). +- In a normal PowerShell window (only for the current user account). ```powershell Uninstall-Module -Name ExchangeOnlineManagement @@ -342,70 +567,149 @@ To uninstall the module, run **one** of the following commands based on how you For detailed syntax and parameter information, see [Uninstall-Module](/powershell/module/powershellget/uninstall-module). -## Properties and property sets in the EXO V2 module +## Properties and property sets in the Exchange Online PowerShell module -Traditional Exchange Online cmdlets return all possible object properties in their output, including many properties that are often blank or aren't interesting in many scenarios. This behavior causes degraded performance (more server computation and added network load). You rarely (if ever) need the full complement of properties in the cmdlet output. +Traditional Exchange Online cmdlets return all possible object properties, including many blank or uninteresting properties. This behavior causes degraded performance (more server computation and added network load). You rarely (if ever) need the full complement of properties in the cmdlet output. -The **Get-EXO\*** cmdlets in the module have categorized output properties. Instead of giving all properties equal importance and returning them in all scenarios, we've categorized specific related properties into property sets. Simply put, these property sets are buckets of two or more related properties on the cmdlet. +The **Get-EXO\*** cmdlets in the module have categorized output properties. Instead of giving all properties equal importance and returning them in all scenarios, we categorized specific related properties into _property sets_. These property sets are buckets of two or more related properties on the cmdlet. -In the biggest and most used **Get-EXO\*** cmdlets: +The biggest and most used **Get-EXO\*** cmdlets use property sets: - [Get-EXOCasMailbox](/powershell/module/exchange/get-exocasmailbox) - [Get-EXOMailbox](/powershell/module/exchange/get-exomailbox) - [Get-EXOMailboxStatistics](/powershell/module/exchange/get-exomailboxstatistics) - [Get-EXORecipient](/powershell/module/exchange/get-exorecipient) -Property sets are controlled by the following parameters: +In those cmdlets, property sets are controlled by the following parameters: -- *PropertySets*: This parameter accepts one or more available property set names separated by commas. The available property sets are described in [Property sets in Exchange Online PowerShell V2 cmdlets](cmdlet-property-sets.md). -- *Properties*: This parameter accepts one or more property names separated by commas. +- _PropertySets_: This parameter accepts one or more available property set names separated by commas. The available property sets are described in [Property sets in Exchange Online PowerShell module cmdlets](cmdlet-property-sets.md). +- _Properties_: This parameter accepts one or more property names separated by commas. -You can use the *PropertySets* and *Properties* parameters together in the same command. +You can use the _PropertySets_ and _Properties_ parameters together in the same command. -We've also included a Minimum property set that includes a bare minimum set of required properties for the cmdlet output (for example, identity properties). The properties in the Minimum property sets are also described in [Property sets in Exchange Online PowerShell V2 cmdlets](cmdlet-property-sets.md). +We also included a Minimum property set that includes a bare minimum set of required properties for the cmdlet output (for example, identity properties). The properties in the Minimum property sets are also described in [Property sets in Exchange Online PowerShell module cmdlets](cmdlet-property-sets.md). -- If you don't use the *PropertySets* or *Properties* parameters, you automatically get the properties in the Minimum property set. -- If you use the *PropertySets* or *Properties* parameters, you get the specified properties **and** the properties in the Minimum property set. +- If you don't use the _PropertySets_ or _Properties_ parameters, you automatically get the properties in the Minimum property set. +- If you use the _PropertySets_ or _Properties_ parameters, you get the specified properties **and** the properties in the Minimum property set. -Either way, the cmdlet output will contain far fewer properties, and the time it takes to return those results will be much faster. +Either way, the cmdlet output contains far fewer properties, and the results are returned much faster. -For example, after you [connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md), the following example returns only the properties in the Minimum property set for the first ten mailboxes. +For example, after you [connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md), the following example returns only the properties in the Minimum property set for the first 10 mailboxes. ```powershell Get-EXOMailbox -ResultSize 10 ``` -In contrast, the output of the same **Get-Mailbox** command would return at least 230 properties for each of the first ten mailboxes. +In contrast, the output of the same **Get-Mailbox** command would return at least 230 properties for each of the first 10 mailboxes. > [!NOTE] > Although the _PropertySets_ parameter accepts the value All, we highly discourage using this value to retrieve all properties, because it slows down the command and reduces reliability. Always use the _PropertySets_ and _Properties_ parameters to retrieve the minimum number of properties that are required for your scenario. -For more information about filtering in the EXO V2 module, see [Filters in the Exchange Online V2 module](filters-v2.md). +For more information about filtering in the module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). ## Release notes -Unless otherwise noted, the current release of the EXO V2 module contains all features of previous releases. +Unless otherwise noted, the current release of the Exchange Online PowerShell module contains all features of previous releases. + +### Current release + +#### Version 3.7.2 + +- The _DisableWAM_ switch is available on the **Connect-ExchangeOnline** cmdlet to disable Web Account Manager (WAM) if you get WAM-related connection errors. + +### Previous releases + +#### Version 3.7.1 + +- Added a new property named `ExoExchangeSecurityDescriptor` to the output of **Get-EXOMailbox** that's similar to the `ExchangeSecurityDescriptor` property in the output of **Get-Mailbox**. +- Added new cmdlets to support the Viva Org Insights Delegation feature: + - **Add-VivaOrgInsightsDelegatedRole** + - **Get-VivaOrgInsightsDelegatedRole** + - **Remove-VivaOrgInsightsDelegatedRole** + +#### Version 3.7.0 + +- Integrated Web Account Manager (WAM) in authentication flows to enhance security. +- Command line help for Exchange Online PowerShell cmdlets is no longer loaded by default. Use the _LoadCmdletHelp_ switch in the **Connect-ExchangeOnline** command so help for Exchange Online PowerShell cmdlets is available to the **Get-Help** cmdlet. +- Fixed connection issues with app only authentication in Security & Compliance PowerShell. + +#### Version 3.6.0 -### Current release: Version 2.0.5 +- **Get-VivaModuleFeature** now returns information about the kinds of identities that the feature supports creating policies for (for example, users, groups, or the entire tenant). +- Cmdlets for Viva feature access management now handle continuous access evaluation (CAE) claim challenges. +- Added fix for compatibility issue with the Microsoft.Graph module. -- New **Get-OwnerlessGroupPolicy** and **Set-OwnerlessGroupPolicy** cmdlet to manage ownerless Microsoft 365 groups. +#### Version 3.5.1 + +- Bug fixes in **Get-EXOMailboxPermission** and **Get-EXOMailbox**. +- The module has been upgraded to run on .NET 8, replacing the previous version based on .NET 6. +- Enhancements in **Add-VivaModuleFeaturePolicy**. + +#### Version 3.5.0 + +- New **Get-VivaFeatureCategory** cmdlet. +- Added support for policy operations at the category level in Viva Feature Access Management (VFAM). +- New IsFeatureEnabledByDefault property in the output of **Get-VivaModuleFeaturePolicy**. The value of this property shows the default enablement state for users in the tenant when no tenant or user/group policies were created. + +#### Version 3.4.0 + +- Bug fixes in **Connect-ExchangeOnline**, **Get-EXORecipientPermission**, and **Get-EXOMailboxFolderPermission**. +- The _SigningCertificate_ parameter in **Connect-ExchangeOnline** now supports [Constrained Language Mode (CLM)](/powershell/module/microsoft.powershell.core/about/about_language_modes#constrainedlanguage-mode). + +#### Version 3.3.0 + +- _SkipLoadingCmdletHelp_ parameter on **Connect-ExchangeOnline** to support skip loading cmdlet help files. +- Global variable `EXO_LastExecutionStatus` is available to check the status of the last cmdlet that was run. +- Bug fixes in **Connect-ExchangeOnline** and **Connect-IPPSSession**. +- _IsUserControlEnabled_ parameter on **Add-VivaModuleFeaturePolicy** and **Update-VivaModuleFeaturePolicy** to support the enablement of user controls by policy for features that are onboarded to Viva feature access management. + +#### Version 3.2.0 + +- New cmdlets: + - **Get-DefaultTenantBriefingConfig** and **Set-DefaultTenantBriefingConfig**. + - **Get-DefaultTenantMyAnalyticsFeatureConfig** and **Set-DefaultTenantMyAnalyticsFeatureConfig**. + - **Get-VivaModuleFeature**, **Get-VivaModuleFeatureEnablement**, **Add-VivaModuleFeaturePolicy**, **Get-VivaModuleFeaturePolicy**, **Remove-VivaModuleFeaturePolicy**, and **Update-VivaModuleFeaturePolicy**. +- REST API connection support for Security & Compliance PowerShell. +- _ConnectionId_ parameter on **Get-ConnectionInformation** and **Disconnect-ExchangeOnline**: + - Get connection information for specific REST API connections. + - Selective disconnect for REST API connections. +- _SigningCertificate_ parameter on **Connect-ExchangeOnline** allows you to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that **Connect-ExchangeOnline** creates with a client certificate to use in all PowerShell execution policies. +- Bug fixes in **Connect-ExchangeOnline**. + +#### Version 3.1.0 + +- _AccessToken_ parameter available in **Connect-ExchangeOnline**. +- Bug fixes in **Connect-ExchangeOnline** and **Get-ConnectionInformation**. +- Bug fix in **Connect-IPPSSession** for connecting to Security & Compliance PowerShell using _CertificateThumbprint_. + +#### Version 3.0.0 (Preview versions known as v2.0.6-PreviewX) + +- Features already described in the [REST API connections in the EXO V3 module](#rest-api-connections-in-the-exo-v3-module) section: + - [Certificate based authentication](app-only-auth-powershell-v2.md) for Security & Compliance PowerShell (version 2.0.6-Preview5 or later). + - The [Get-ConnectionInformation](/powershell/module/exchange/get-connectioninformation) cmdlet for REST-based connections (version 2.0.6-Preview7 or later). + - The _SkipLoadingFormatData_ switch on the **Connect-ExchangeOnline** cmdlet for REST-based connections (version 2.0.6-Preview8 or later). +- The _DelegatedOrganization_ parameter works in the **Connect-IPPSSession** cmdlet as long as you also use the _AzureADAuthorizationEndpointUri_ parameter in the command. +- Certain cmdlets that used to prompt for confirmation in specific scenarios no longer do so. By default, the cmdlet runs to completion. +- The format of the error returned from failed cmdlet execution is slightly modified. The exception now contains more data (for example, the exception type), and the `FullyQualifiedErrorId` doesn't contain the `FailureCategory`. The format of the error is subject to further modification. + +#### Version 2.0.5 + +- New **Get-OwnerlessGroupPolicy** and **Set-OwnerlessGroupPolicy** cmdlets to manage ownerless Microsoft 365 groups. > [!NOTE] > Although the _cmdlets_ are available in the module, the _feature_ is only available to members of a Private Preview. - New **Get-VivaInsightsSettings** and **Set-VivaInsightsSettings** cmdlets to control user access to Headspace features in Viva Insights. -### Previous releases - #### Version 2.0.4 -- PowerShell 7 is officially supported in Windows, Linux, and Apple macOS as described in the [Prerequisites for the EXO V2 module](#prerequisites-for-the-exo-v2-module) section in this article. +- PowerShell 7 is officially supported in Windows, Linux, and Apple macOS as described in the [Prerequisites for the Exchange Online PowerShell module](#prerequisites-for-the-exchange-online-powershell-module) section in this article. -- The EXO V2 module in PowerShell 7 supports browser-based single sign-on (SSO) and other sign in methods. For more information, see [PowerShell 7 log in experiences](connect-to-exchange-online-powershell.md#powershell-7-log-in-experiences). +- The module in PowerShell 7 supports browser-based single sign-on (SSO) and other sign in methods. For more information, see [PowerShell 7 exclusive connection methods](connect-to-exchange-online-powershell.md#powershell-7-exclusive-connection-methods). -- The **Get-UserAnalyticsConfig** and **Set-UserAnalyticsConfig** cmdlets have been replaced by the **Get-MyAnalyticsConfig** and **Set-MyAnalyticsConfig**.Additionally, you can configure access at feature level. For more information, see [Configure MyAnalytics](/workplace-analytics/myanalytics/setup/configure-myanalytics). +- The **Get-UserAnalyticsConfig** and **Set-UserAnalyticsConfig** cmdlets were replaced by the **Get-MyAnalyticsConfig** and **Set-MyAnalyticsConfig**. Additionally, you can configure access at feature level. For more information, see [Configure MyAnalytics](/workplace-analytics/myanalytics/setup/configure-myanalytics). -- Real-time policy and security enforcement in all user based authentication. Continuous Access Evaluation (CAE) has been enabled in EXO V2 Module. Read more about CAE [here](https://techcommunity.microsoft.com/t5/azure-active-directory-identity/moving-towards-real-time-policy-and-security-enforcement/ba-p/1276933). +- Real-time policy and security enforcement in all user based authentication. Continuous Access Evaluation (CAE) is enabled in the module. Read more about CAE [here](https://techcommunity.microsoft.com/t5/azure-active-directory-identity/moving-towards-real-time-policy-and-security-enforcement/ba-p/1276933). - The _LastUserActionTime_ and _LastInteractionTime_ properties are now available in the output of the **Get-EXOMailboxStatistics** cmdlet. @@ -417,19 +721,19 @@ Unless otherwise noted, the current release of the EXO V2 module contains all fe - Remote in the Azure Key Value (the _Certificate_) parameter. This option enhances security by fetching the certificate only at runtime. - Local in the CurrentUser or LocalMachine certificate store (the _CertificateThumbprint_ parameter). - Local in an exported certificate file (the _CertificateFilePath_ and _CertificatePassword_ parameters). - For more information, see the parameter descriptions in [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline) and [App-only authentication for unattended scripts in the EXO V2 module](app-only-auth-powershell-v2.md). -- Connect to Exchange Online PowerShell and Security Compliance Center PowerShell simultaneously in a single PowerShell window. + For more information, see the parameter descriptions in [Connect-ExchangeOnline](/powershell/module/exchange/connect-exchangeonline) and [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). +- Connect to Exchange Online PowerShell and Security & Compliance PowerShell simultaneously in a single PowerShell window. - The new _CommandName_ parameter allows you to specify and restrict the Exchange Online PowerShell cmdlets that are imported in a session. This option reduces the memory footprint for high usage PowerShell applications. - **Get-EXOMailboxFolderPermission** now supports ExternalDirectoryObjectID in the _Identity_ parameter. -- Optimized latency of the first V2 cmdlet call. Lab results show the first call latency has been reduced from 8 seconds to approximately 1 second. Actual results will depend on the cmdlet result size and the tenant environment. +- Optimized latency of the first V2 cmdlet call. Lab results show the first call latency has been reduced from 8 seconds to approximately 1 second. Actual results depend on the cmdlet result size and the tenant environment. #### Version 1.0.1 -- General Availability (GA) version of the EXO V2 module. It is stable and ready for use in production environments. +- General Availability (GA) version of the EXO V2 module. It's stable and ready for use in production environments. - **Get-EXOMobileDeviceStatistics** cmdlet now supports the _Identity_ parameter. - Improved reliability of session auto-reconnect in certain cases where a script was running for ~50 minutes and threw a "Cmdlet not found" error due to a bug in auto-reconnect logic. - Fixed data-type issues of two commonly used "User" and "MailboxFolderUser" attributes for easy migration of scripts. -- Enhanced support for filters as it now supports four more operators: EndsWith, Contains, Not and NotLike support. Check [Filters in the EXO V2 module](filters-v2.md) for attributes that aren't supported in filters. +- Enhanced support for filters as it now supports four more operators: EndsWith, Contains, Not and NotLike support. Check [Filters in the Exchange Online PowerShell module](filters-v2.md) for attributes that aren't supported in filters. #### Version 0.4578.0 @@ -438,45 +742,45 @@ Unless otherwise noted, the current release of the EXO V2 module contains all fe - You can now use `FolderId` as an identity parameter in **Get-EXOMailboxFolderPermission**. You can get the `FolderId` value using **Get-MailboxFolder**. For example: `Get-MailboxFolderPermission -Identity :` `Get-MailboxFolderPermission -Identity :\` -- Improved reliability of **Get-EXOMailboxStatistics** as certain request routing errors which led to failures have been resolved. -- Optimized memory usage when a session is created by re-using any existing module with a new session instead of creating a new one every time session is imported. +- Improved reliability of **Get-EXOMailboxStatistics** as certain request routing errors that led to failures have been resolved. +- Optimized memory usage when a session is created by re-using any existing module with a new session instead of creating a new one every time a session is imported. #### Version 0.4368.1 -- Added support for Security & Compliance Center PowerShell cmdlets using the **Connect-IPPSSession** cmdlet. +- Added support for Security & Compliance PowerShell cmdlets using the **Connect-IPPSSession** cmdlet. - Hiding the announcement banner is available using the _ShowBanner_ switch (`-ShowBanner:$false`). - Terminate cmdlet execution on client exception. -- Remote PowerShell contained various complex data types which were intentionally not supported in EXO cmdlets to improve performance. Differences in non-complex data types between remote PowerShell cmdlets and V2 cmdlets have been resolved to allow seamless migration of management scripts. +- Remote PowerShell contained various complex data types that were intentionally not supported in EXO cmdlets to improve performance. Differences in non-complex data types between remote PowerShell cmdlets and V2 cmdlets have been resolved to allow seamless migration of management scripts. #### Version 0.3582.0 -- Support for prefix during session creation. - - You can create only 1 session at a time that contains prefixed cmdlets. - - Note that the EXO V2 cmdlets will not be prefixed as they already have the prefix EXO, so don't use `EXO` as a prefix. -- Use EXO V2 cmdlets even if WinRM Basic Auth is disabled on client machine. Note that remote PowerShell cmdlets require WinRM Basic Auth, and they won't be available if it's disabled. -- Identity parameter for V2 cmdlets now supports Name and Alias as well. Note that using Alias or Name slows down the performance of V2 cmdlets, so we don't recommend using them. -- Fixed issue where the data type of attributes returned by V2 cmdlet was different from remote PowerShell cmdlets. We still have few attributes which have differing data types, and we plan to handle them in coming months. -- Fixed bug: Frequent sessions reconnects issue when Connect-ExchangeOnline was invoked with Credentials or UserPrincipalName +- Support for prefix during session creation: + - You can create only one session at a time that contains prefixed cmdlets. + - EXO V2 cmdlets aren't prefixed because they already have the prefix EXO, so don't use `EXO` as a prefix. +- Use EXO V2 cmdlets even if WinRM Basic Auth is disabled on client machine. Remote PowerShell connections require WinRM Basic Auth, and remote PowerShell cmdlets aren't available if Basic Auth is disabled in WinRM. +- Identity parameter for V2 cmdlets now supports Name and Alias. Using Alias or Name slows down the performance of V2 cmdlets, so we don't recommend using them. +- Fixed issue where the data type of attributes returned by V2 cmdlet was different from remote PowerShell cmdlets. We still have few attributes with differing data types, and we plan to handle them in coming months. +- Fixed bug: Frequent sessions reconnect issue when Connect-ExchangeOnline was invoked with Credentials or UserPrincipalName #### Version 0.3555.1 - Fixed a bug where piped cmdlets were failing with the following error due to an authentication issue: - > Cannot invoke the pipeline because the runspace is not in the Opened state. Current state of the runspace is 'Closed'. + > Cannot invoke the pipeline because the runspace isn't in the Opened state. Current state of the runspace is 'Closed'. #### Version 0.3527.4 - Updated Get-Help content. -- Fixed an issue in **Get-Help** where the *-Online* parameter was redirecting to a non-existent page with error code 400. +- Fixed an issue in **Get-Help** where the _Online_ parameter was redirecting to a nonexistent page with error code 400. #### Version 0.3527.3 - Added support for managing Exchange for a different tenant using delegation flow. -- Works in tandem with other PowerShell modules in a single PS window. +- Works in tandem with other PowerShell modules in a single PowerShell window. - Added support for positional parameters. - Date Time field now supports client locale. - Bug fix: PSCredential empty when passed during Connect-ExchangeOnline. - Bug fix: Client module error when filter contained $null. - Sessions created internal to EXO V2 Module now have names (naming pattern: ExchangeOnlineInternalSession_%SomeNumber%). -- Bug fix: Remote PowerShell cmdlets intermittently failing due to time the difference between token expiry and the PSSession going idle. +- Bug fix: Remote PowerShell cmdlets intermittently failing due to time the difference between token expiry and the Session going idle. - Major security update. - Bug fixes and enhancements. diff --git a/exchange/docs-conceptual/exchange-online-powershell.md b/exchange/docs-conceptual/exchange-online-powershell.md index fe375e0897..348084ae8d 100644 --- a/exchange/docs-conceptual/exchange-online-powershell.md +++ b/exchange/docs-conceptual/exchange-online-powershell.md @@ -2,25 +2,38 @@ title: "Exchange Online PowerShell" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: 2/20/2018 +manager: deniseb +ms.date: 05/07/2025 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1cb603b0-2961-4afe-b879-b048fe0f64a2 search.appverid: MET150 -description: "Learn about using PowerShell in Exchange Online" +description: "Learn about articles that are available for using PowerShell in Exchange Online." --- # Exchange Online PowerShell -Exchange Online PowerShell is the administrative interface that enables you to manage your Microsoft Exchange Online organization from the command line. For example, you can use Exchange Online PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following articles provide information about using Exchange Online PowerShell: +Exchange Online PowerShell is the administrative interface that enables you to manage the Exchange Online part of your Microsoft 365 organization from the command line (including many security features in Exchange Online Protection and Microsoft Defender for Office 365). For example, you can use Exchange Online PowerShell to configure mail flow rules (also known as transport rules) and connectors. The following articles provide information about using Exchange Online PowerShell: -- To create a remote PowerShell session to your Exchange Online organization that supports both modern authentication and multi-factor authentication (MFA), see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). +- To learn about the ExchangeOnlineManagement module that's required to connect to Exchange Online PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). -- To prevent or allow PowerShell access to your Exchange Online organization, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). + > [!TIP] + > Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). + + To learn about what's new in the Exchange Online PowerShell module, see [What's new in the Exchange Online PowerShell module](whats-new-in-the-exo-module.md). + +- To connect to Exchange Online PowerShell, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). + + To learn about different methods to connect to Exchange Online PowerShell, see the following articles: + + - [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). + - [Use Azure managed identities to connect to Exchange Online PowerShell](connect-exo-powershell-managed-identity.md). + - [Use C# to connect to Exchange Online PowerShell](connect-to-exo-powershell-c-sharp.md) + +- To block or allow access to Exchange Online PowerShell in your organization, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - To learn about the structure and layout of the cmdlet reference articles in Exchange Online PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). @@ -28,6 +41,6 @@ Exchange Online PowerShell is the administrative interface that enables you to m - To learn about recipient filters in Exchange Online PowerShell, see [Recipient filters in Exchange Management Shell and Exchange Online PowerShell commands](recipient-filters.md). -- To learn about authentication in Exchange Online PowerShell for unattended scripts using AzureAD applications and self-signed certificates, see [App-only authentication for unattended scripts in the EXO V2 module](app-only-auth-powershell-v2.md). +- To learn about recipient filters for the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell, see [Filters in the Exchange Online PowerShell module](filters-v2.md). -- To learn about property sets in EXO V2 module cmdlets, see [Property sets in Exchange Online PowerShell V2 cmdlets](cmdlet-property-sets.md). +- To learn about property sets in the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module, see [Property sets in Exchange Online PowerShell module cmdlets](cmdlet-property-sets.md). diff --git a/exchange/docs-conceptual/exchange-online-protection-powershell.md b/exchange/docs-conceptual/exchange-online-protection-powershell.md index 956ac1a57b..93e9dd4bf7 100644 --- a/exchange/docs-conceptual/exchange-online-protection-powershell.md +++ b/exchange/docs-conceptual/exchange-online-protection-powershell.md @@ -2,28 +2,38 @@ title: "Exchange Online Protection PowerShell" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: 2/20/2018 +manager: deniseb +ms.date: 9/1/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f7918a88-774a-405e-945b-bc2f5ee9f748 -description: "Learn about using PowerShell in Exchange Online Protection" +description: "Learn about the articles that are available for using PowerShell in Exchange Online Protection (EOP) only organizations without cloud mailboxes." --- # Exchange Online Protection PowerShell -Exchange Online Protection PowerShell is the administrative interface that enables you to manage your standalone Exchange Online Protection (EOP) organization from the command line. For example, you can use Exchange Online Protection PowerShell to configure mail flow rules (also known as transport rules) and connectors. +Exchange Online Protection PowerShell is the administrative interface that enables you to manage security features in Exchange Online Protection (EOP) organizations from the command line. For example, you can use Exchange Online Protection PowerShell to configure anti-spam policies, mail flow rules (also known as transport rules) and connectors. -> [!NOTE] -> Exchange Online Protection PowerShell is only used in *standalone* EOP organizations. For example, your Microsoft 365 subscription only includes EOP (no Exchange mailboxes), and you use it to protect your on-premises email environment. If you have a Microsoft 365 subscription that includes Exchange Online mailboxes (E3, E5, etc.), you can't use Exchange Online Protection PowerShell; the same features are available in [Exchange Online PowerShell](exchange-online-powershell.md). +> [!TIP] +> Microsoft 365 organizations with cloud mailboxes (Microsoft 365 A3/E3/G3, A5/E5/G5, Microsoft 365 Business Premium, etc.) use [Exchange Online PowerShell](exchange-online-powershell.md) to manage these same features. + +Exchange Online Protection PowerShell includes the following environments: + +- **Standalone EOP organizations**: Your Microsoft 365 subscription includes no Exchange Online mailboxes, because you use EOP to protect your on-premises email environment. +- **Exchange Enterprise CAL with Services**: The licenses for your on-premises Exchange organization include Exchange Enterprise CAL with Services (EOP is one of the services). The following articles provide information about using Exchange Online Protection PowerShell: -- To create a remote PowerShell session to your standalone Exchange Online Protection organization that supports both modern authentication and multi-factor authentication (MFA), see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). +- To learn about the ExchangeOnlineManagement module that's required to connect to standalone Exchange Online Protection PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). -- To learn about the structure and layout of the cmdlet reference articles in Exchange Online Protection PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). + > [!TIP] + > Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). -- For a sample script that lets admins who manage multiple organizations apply configuration settings to all of their organizations, see [Sample script for applying EOP settings to multiple tenants](/microsoft-365/security/office-365-security/sample-script-for-applying-eop-settings-to-multiple-tenants). + To learn about what's new in the Exchange Online PowerShell module, see [What's new in the Exchange Online PowerShell module](whats-new-in-the-exo-module.md). + +- To connect to Exchange Online Protection PowerShell, see [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). + +- To learn about the structure and layout of the cmdlet reference articles in Exchange Online Protection PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). diff --git a/exchange/docs-conceptual/filter-properties.md b/exchange/docs-conceptual/filter-properties.md index 350d8481ed..acd6c6bdeb 100644 --- a/exchange/docs-conceptual/filter-properties.md +++ b/exchange/docs-conceptual/filter-properties.md @@ -2,13 +2,13 @@ title: "Filterable properties for the Filter parameter" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 1/9/2024 ms.audience: ITPro audience: ITPro ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b02b0005-2fb6-4bc2-8815-305259fa5432 description: "Learn about the filterable properties for the Filter parameter in Exchange Server and Exchange Online." --- @@ -34,276 +34,2149 @@ You use the _Filter_ parameter to create OPATH filters based on the properties o - [Get-User](/powershell/module/exchange/get-user) - [Get-UnifiedGroup](/powershell/module/exchange/get-unifiedgroup) -For more information about recipients filters in Exchange PowerShell, see [Recipient filters in Exchange PowerShell commands](recipient-filters.md). +For more information about _recipient_ filters in Exchange PowerShell, see [Recipient filters in Exchange PowerShell commands](recipient-filters.md). > [!NOTE] > The _Filter_ parameter is also available on other cmdlets (for example, **Get-MailboxStatistics**, **Get-Queue**, and **Get-Message**). However, the property values that are accepted by the _Filter_ parameter on these cmdlets aren't similar to the user and group properties that are described in this article. -## Filterable properties - -The properties that have been _confirmed_ to work with the _Filter_ parameter in user and group cmdlets are described in the following table. +The properties that have been _confirmed_ to work with the _Filter_ parameter in user and group cmdlets are described in this article. **Notes**: - The list might include: - - - Properties that are only used in one type of environment: Microsoft 365, on-premises Exchange, or hybrid. The property might exist on recipient objects in all environments, but the value is only meaningful (a value other than blank or `None`) in one type of environment. - + - Properties that are used only in one type of environment: Microsoft 365, on-premises Exchange, or hybrid. The property might exist on recipient objects in all environments, but the value is meaningful (a value other than blank or `None`) only in one type of environment. - Properties that are present, but correspond to features that are no longer used. -- Not all recipient properties have a corresponding Active Directory property. The LDAP display name value in the table is "n/a" for these properties, which indicates that the property is calculated (likely by Exchange). +- Not all recipient properties have a corresponding Active Directory property. The LDAP display name value is "n/a" for these properties, which indicates that the property is calculated (likely by Exchange). -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. For more information, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although the _Filter_ parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. For more information, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). - Text string properties that accept wildcard characters require the `-like` operator (for example, `"Property -like 'abc*'"`). - To look for blank or non-blank property values, use the value `$null` (for example, `'Property -eq $null'` or `'Property -ne $null'`). -- For filtering considerations for connections using the Exchange Online PowerShell v2 module, see [Filters in the EXO V2 module](filters-v2.md). - -
- -**** - -|Property name|LDAP display name|Available on cmdlets|Value|Comments| -|---|---|---|---|---| -|_AcceptMessagesOnlyFrom_|_authOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_AcceptMessagesOnlyFromDLMembers_|_dLMemSubmitPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"`. or `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`.
To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ActiveSyncAllowedDeviceIDs_|_msExchMobileAllowedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`|A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`.
After you have the device ID value, you can use it in the filter. For example, `Get-CasMailbox -Filter "(ActiveSyncAllowedDeviceIDs -like 'text1*') -or (ActiveSyncAllowedDeviceIDs -eq 'text2'"`.| -|_ActiveSyncBlockedDeviceIDs_|_msExchMobileBlockedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`|A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`.
After you have the device ID value, you can use it in a filter. For example, `Get-CasMailbox -Filter "(ActiveSyncBlockedDeviceIDs -like 'text1*') -or (ActiveSyncBlockedDeviceIDs -eq 'text2'"`.| -|_ActiveSyncEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CasMailbox -Filter 'ActiveSyncEnable -eq $false'`.| -|_ActiveSyncMailboxPolicy_|_msExchMobileMailboxPolicyLink_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the ActiveSync mailbox policy. For example, `Get-CASMailbox -Filter "ActiveSyncMailboxPolicy -eq 'CN=Default,CN=Mobile Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of ActiveSync mailbox policies by running this command: `Get-MobileDeviceMailboxPolicy | Format-List Name,DistinguishedName`.
**Note**: For the default assignment of the default ActiveSync mailbox policy (named Default) to a mailbox, the value of the **ActiveSyncMailboxPolicy** property is blank (`$null`).| -|_ActiveSyncSuppressReadReceipt_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CasMailbox -Filter 'ActiveSyncSuppressReadReceipt -eq $true'`.| -|_AddressBookPolicy_|_msExchAddressBookPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the address book policy. For example, `Get-Mailbox -Filter "AddressBookPolicy -eq 'CN=Contoso ABP,CN=AddressBook Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of address book policies by running this command: `Get-AddressBookPolicy | Format-List Name,DistinguishedName`.| -|_AddressListMembership_|_showInAddressBook_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the address list. For example, `Get-MailContact -Filter "AddressListMembership -eq 'CN=All Contacts,CN=All Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of address lists by running this command: `Get-AddressList | Format-List Name,DistinguishedName`.| -|_AdminDisplayName_|_adminDisplayName_|**Get-SecurityPrincipal**|String (wildcards accepted) or `$null`|For example, `Get-SecurityPrincipal -Filter 'AdminDisplayName -ne $null' | Format-Table -Auto Name,AdminDisplayName`.| -|_AdministrativeUnits_|_msExchAdministrativeUnitLink_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-User -Filter 'AdministrativeUnits -ne $null'`.| -|_AggregatedMailboxGuids_|_msExchAlternateMailboxes_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'AggregatedMailboxGuids -ne $null'`.| -|_Alias_|_mailNickname_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "Alias -like 'smith*'"`.| -|_AllowUMCallsFromNonUsers_|_msExchUMListInDirectorySearch_|**Get-Contact**
**Get-LinkedUser**
**Get-UMMailbox**
**Get-User**|`None` (0) or `SearchEnabled` (1)|For example, `Get-User -Filter "AllowUMCallsFromNonUsers -ne 'SearchEnabled'"`.| -|_ArbitrationMailbox_|_msExchArbitrationMailbox_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the arbitration mailbox. For example, `Get-DistributionGroup -Filter "ArbitrationMailbox -eq 'CN=SystemMailbox"1f05a927-2e8f-4cbb-9039-2cfb8b95e486",CN=Users,DC=contoso,DC=com'"`.
You can find the distinguished names of arbitration mailboxes by running this command: `Get-Mailbox -Arbitration | Format-List Name,DistinguishedName`.| -|_ArchiveDatabase_|_msExchArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the archive mailbox database. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_ArchiveDomain_|_msExchArchiveAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This property is used in on-premises Exchange environments to identify the Exchange Online organization that holds the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveDomain -like 'contoso.onmicrosoft.com*'"`.| -|_ArchiveGuid_|_msExchArchiveGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the GUID of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`.
You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`.| -|_ArchiveName_|_msExchArchiveName_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This filter requires the name of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveName -like 'In-Place Archive*'"`.
You can find the names of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveName`.| -|_ArchiveQuota_|_msExchArchiveQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveQuota -gt '85GB'"`.| -|_ArchiveRelease_|_msExchArchiveRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.|For example, `Get-Recipient -Filter 'ArchiveRelease -ne $null'`.| -|_ArchiveState_|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).|For example, `Get-Recipient -Filter "ArchiveState -eq 'HostedProvisioned'"`.| -|_ArchiveStatus_|_msExchArchiveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0) or `Active` (1).|For example, `Get-Recipient -Filter "ArchiveStatus -eq 'Active'"`.| -|_ArchiveWarningQuota_|_msExchArchiveWarnQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveWarningQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveWarningQuota -gt '85GB'"`.| -|_AssistantName_|_msExchAssistantName_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "AssistantName -like 'Julia*'"`.| -|_AuditEnabled_|_msExchMailboxAuditEnable_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'AuditEnabled -eq $true'`.| -|_AuditLogAgeLimit_|_msExchMailboxAuditLogAgeLimit_|**Get-Mailbox**
**Get-UnifiedGroup**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.AuditLogAgeLimit - ''"`. For example, `Get-Mailbox | where "$_.AuditLogAgeLimit -gt '60.00:00:00'"`.| -|_AuthenticationPolicy_|_msExchAuthPolicyLink_|**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "AuthenticationPolicy -eq 'CN=Block Basic Auth,CN=Auth Policies,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR11B009,DC=PROD,DC=OUTLOOK,DC=COM'"`.| -|_BlockedSendersHash_|_msExchBlockedSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'BlockedSendersHash -ne $null'.`| -|_c_|_c_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String (wildcards accepted) or `$null`|This filter requires the ISO 3166-1 two-letter country code for the user (for example, `US` for the United States). This property is used together with the _co_ and _countryCode_ properties to define the user's country in Active Directory.
For example, `Get-User -Filter "c -eq 'US'"`.| -|_CalendarLoggingQuota_|_msExchCalendarLoggingQuota_|**Get-Mailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "CalendarLoggingQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "CalendarLoggingQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.CalendarLoggingQuota - ''"`. For example, `Get-Mailbox | where "$_.CalendarLoggingQuota -gt '10GB'"`.| -|_CalendarRepairDisabled_|_msExchCalendarRepairDisabled_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'CalendarRepairDisabled -eq $true'`.| -|_CertificateSubject_|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`|The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers).
For example, `Get-User -Filter "CertificateSubject -eq 'X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`')| -|_City_|_l_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "City -eq 'Redmond'"`.| -|_Company_|_company_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Company -like 'Contoso*'"`.| -|_ComplianceTagHoldApplied_|n/a|**Get-Mailbox**
**Get-MailUser**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'ComplianceTagHoldApplied -eq $true'`.| -|_ConsumerNetID_|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter 'ConsumerNetID -ne $null'`.| -|_CountryCode_|_countryCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|Integer|This filter requires the ISO 3166-1 three-digit country code for the user (for example, `840` for the United States). This property is used together with the _c_ and _co_ properties to define the user's country in Active Directory.
For example, `Get-User -Filter "countryCode -eq 796"`.| -|_CountryOrRegion_|_co_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String|This filter requires the ISO 3166-1 country name for the user (for example, `United States`). You can select an available value in Active Directory Users and Computers ( **Address** tab > **Country/region** field), or the Exchange admin center (user properties > **Contact information** tab > **Country/Region** field).
When you select a user's country in Active Directory Users and Computers or the EAC, the corresponding values for the _co_ and _countryCode_ properties are automatically configured.
For example, `Get-User -Filter "CountryOrRegion -like 'United*'"`.| -|_CustomAttribute1_ to _CustomAttribute15_|_extensionAttribute1_ to _extensionAttribute15_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "CustomAttribute8 -like 'audited*'"`.| -|_Database_|_homeMDB_|**Get-Mailbox**
**Get-Recipient**|String|This filter requires the distinguished name of the mailbox database. For example, `Get-Mailbox -Filter "Database -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_DefaultPublicFolderMailbox_|_msExchPublicFolderMailbox_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the public folder mailbox. For example, `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'CN=PF Mailbox01,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'contoso.com/Users/PF Mailbox01'"`.
To find the distinguished names of public folder mailboxes, run this command: `Get-Mailbox -PublicFolder | Format-List Name,DistinguishedName`.| -|_DeletedItemFlags_|_deletedItemFlags_|**Get-Mailbox**
**Get-SecurityPrincipal**|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).|For example, `Get-Mailbox -Filter "DeletedItemFlags -ne 'DatabaseDefault'"`.| -|_DeliverToMailboxAndForward_|_deliverAndRedirect_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-MailPublicFolder**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'DeliverToMailboxAndForward -eq $true'`.| -|_Department_|_department_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "Department -like 'Engineering*'"`.| -|_DirectReports_|_directReports_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the direct report. For example, `Get-User -Filter "DirectReports -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "DirectReports -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a direct report, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_DisabledArchiveDatabase_|_msExchDisabledArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the disabled archive mailbox database. For example, `Get-Mailbox -Filter "DisabledArchiveDatabase -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_DisabledArchiveGuid_|_msExchDisabledArchiveDatabaseGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the GUID of the disabled archive mailbox. For example, `Get-Mailbox -Filter "DisabledArchiveGuid -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`.
You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`.| -|_DisplayName_|_displayName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "DisplayName -like 'Julia*'"`.| -|_DistinguishedName_|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|This filter requires the distinguished name of the recipient. For example, `Get-Mailbox -Filter "DistinguishedName -eq 'CN=Basho Kato,CN=Users,DC=contoso,DC=com'"`.
You can find the distinguished names of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,DistinguishedName`.| -|_EcpEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'EcpEnabled -eq $false'`.| -|_EmailAddresses_|_proxyAddresses_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-Recipient -Filter "EmailAddresses -like 'marketing*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"EmailAddresses -eq 'lila@fabrikam.com'"` returns a match, `"EmailAddresses -like 'lila*'"` won't return a match, but or `"EmailAddresses -like 'smtp:lila*'"` will return a match.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_EmailAddressPolicyEnabled_|n/a|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'EmailAddressPolicyEnabled -eq $false'`.| -|_EntryId_|_msExchPublicFolderEntryId_|**Get-MailPublicFolder**|String (wildcards accepted)|For example, `Get-MailPublicFolder -Filter "EntryId -like '60000*'"`.
You can find the entry IDs of mail-enabled public folders by running this command: `Get-MailPublicFolder | Format-List Name,EntryId`.| -|_EwsApplicationAccessPolicy_|_msExchEwsApplicationAccessPolicy_|**Get-CASMailbox**|`EnforceAllowList`, `EnforceBlockList`. or `$null`|For example, `Get-CASMailbox -Filter 'EwsApplicationAccessPolicy -ne $null'`.| -|_EwsEnabled_|_msExchEwsEnabled_|**Get-CASMailbox**|0 (disabled), 1 (enabled) or `$null`.|For example, `Get-CASMailbox -Filter "EwsEnabled -eq 1"`.| -|_ExchangeGuid_|_msExchMailboxGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String|For example, `Get-Mailbox -Filter "ExchangeGuid -eq 'c80a753d-bd4a-4e19-804a-6344d833ecd8'"`.
To find the Exchange GUID of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,ExchangeGuid`.
Note that an object's Exchange GUID value is different than its GUID value. Also, the Exchange GUID value for non-mailboxes (mail contacts, mail users, distribution groups, dynamic distribution groups, mail-enabled security groups, and mail-enabled public folders) is `00000000-0000-0000-0000-000000000000`.| -|_ExchangeUserAccountControl_|_msExchUserAccountControl_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`None` (0) or `AccountDisabled` (2)|For example, `Get-Mailbox -Filter "ExchangeUserAccountControl -eq 'AccountDisabled'"`.| -|_ExchangeVersion_|_msExchVersion_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|Integer|This property contains the earliest version of Exchange that you can use to manage the recipient. The property values that you see are different than the values that you need to use in the filter. To see the **ExchangeVersion** property values, run this command: `Get-Recipient | Format-Table Name,RecipientType,ExchangeVersion`.
For the Exchange 2010 value `0.10 (14.0.100.0)`, use the value 44220983382016 in the filter.
For the Exchange 2013 or Exchange 2016 value `0.20 (15.0.0.0)`, use the value 88218628259840 in the filter.
For example, `Get-Recipient -Filter "ExchangeVersion -lt 88218628259840"`.| -|_ExpansionServer_|_msExchExpansionServerName_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExpansionServer -like 'Mailbox01*'"`.
For an exact match, you need to use the **ExchangeLegacyDN** value of the server. For example, `Get-Recipient -Filter "ExpansionServer -eq '/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01'"`
You can find the **ExchangeLegacyDN** value by running this command: `Get-ExchangeServer | Format-List Name,ExchangeLegacyDN`.| -|_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExtensionCustomAttribute8 -like 'audited*'"`.| -|_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'ExternalDirectoryObjectId -ne $null'`.| -|_ExternalEmailAddress_|_targetAddress_|**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ExternalEmailAddress -eq 'lila@fabrikam.com'"` returns a match, `"ExternalEmailAddress -like 'lila*'"` won't return a match, but `"ExternalEmailAddress -like 'smtp:lila*'"` will return a match.| -|_ExternalOofOptions_|_msExchExternalOOFOptions_|**Get-Mailbox**|`External` (0) or `InternalOnly` (1)|For example, `Get-Mailbox -Filter "ExternalOofOptions -eq 'External'"`.| -|_Fax_|_facsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Fax -like '206*'"`.| -|_FirstName_|_givenName_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "FirstName -like 'Chris*'"`.| -|_ForwardingAddress_|_altRecipient_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the forwarding recipient. For example, `Get-Mailbox -Filter "ForwardingAddress -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ForwardingAddress -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a forwarding recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.| -|_ForwardingSmtpAddress_|_msExchGenericForwardingAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "ForwardingSmtpAddress -like '@fabrikam.com*'"`.
When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ForwardingSmtpAddress -eq 'lila@fabrikam.com'"` returns a match, `"ForwardingSmtpAddress -like 'lila*'"` won't return a match, but `"ForwardingSmtpAddress -like 'smtp:lila*'"` will return a match.| -|_GeneratedOfflineAddressBooks_|_msExchOABGeneratingMailboxBL_|**Get-Mailbox**|String or `$null`|This property is only meaningful on arbitration mailboxes, so you need to use the _Arbitration_ switch in the filter command. Also, This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "GeneratedOfflineAddressBooks -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_GrantSendOnBehalfTo_|_publicDelegates_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the mail-enabled security principal (mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_GroupMemberCount_|_n/a_|**Get-UnifiedGroup**|Integer|For example, `Get-UnifiedGroup -Filter "GroupMemberCount -gt 100"`.| -|_GroupExternalMemberCount_|_n/a_|**Get-UnifiedGroup**|Integer|For example, `Get-UnifiedGroup -Filter "GroupExternalMemberCount -gt 0"`.| -|_GroupType_|_groupType_|**Get-DistributionGroup**
**Get-Group**
**Get-UnifiedGroup**|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).|Distribution groups have the value `Universal`, and mail-enabled security groups have the value `Universal, SecurityEnabled`. You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-DistributionGroup -Filter "GroupType -eq 'Universal,SecurityEnabled'"` returns the same results as `Get-DistributionGroup -Filter "GroupType -eq 'SecurityEnabled,Universal'"`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_Guid_|_objectGuid_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|For example, `Get-Recipient -Filter "Guid -eq '8a68c198-be28-4a30-83e9-bffb760c65ba'"`.
You can find the GUIDs of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,Guid`.
Note that an object's GUID value is different than its Exchange GUID value.| -|_HasActiveSyncDevicePartnership_|n/a|**Get-CASMailbox**
**Get-Recipient**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'HasActiveSyncDevicePartnership -eq $true'`.| -|_HiddenFromAddressListsEnabled_|_msExchHideFromAddressLists_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-Recipient -Filter 'HiddenFromAddressListsEnabled -eq $true'`.| -|_HiddenGroupMembershipEnabled_|_hideDLMembership_|**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-UnifiedGroup -Filter 'HiddenGroupMembershipEnabled -eq $true'`.| -|_HomePhone_|_homePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "HomePhone -like '206*'"`.| -|_Id_|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMMailbox**
**Get-User**
**Get-SecurityPrincipal**
**Get-UnifiedGroup**|String|This filter requires the distinguished name or canonical distinguished name of the recipient. For example, `Get-Mailbox -Filter "Id -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Id -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.| -|_IgnoreMissingFolderLink_|n/a|**Get-MailPublicFolder**|Boolean (`$true` or `$false`)|For example, `Get-MailPublicFolder -Filter 'IgnoreMissingFolderLink -eq $true'`.| -|_ImapEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'ImapEnabled -eq $false'`.| -|_ImmutableId_|_msExchGenericImmutableId_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'ImmutableId -ne $null'`.| -|_IncludeInGarbageCollection_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IncludeInGarbageCollection -eq $true'`.| -|_Initials_|_initials_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Initials -like 'B.'"`.| -|_InPlaceHolds_|_msExchUserHoldPolicies_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String|This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHolds -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`.
To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_InPlaceHoldsRaw_|n/a|**Get-LinkedUser**
**Get-User**|String|This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHoldsRaw -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`.
To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_IsDirSynced_|_msExchIsMSODirsynced_|**Get-Contact**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter 'IsDirSynced -eq $true'`.| -|_IsExcludedFromServingHierarchy_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsExcludedFromServingHierarchy -eq $true'`.| -|_IsHierarchyReady_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsHierarchyReady -eq $false'`.| -|_IsHierarchySyncEnabled_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsHierarchySyncEnabled -eq $false'`.| -|_IsInactiveMailbox_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsInactiveMailbox -eq $false'`.| -|_IsLinked_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsLinked -eq $true'`.| -|_IsMailboxEnabled_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsMailboxEnabled -eq $false'`.| -|_IsResource_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsResource -eq $true'`.| -|_IsSecurityPrincipal_|n/a|**Get-LinkedUser**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter 'IsSecurityPrincipal -eq $false'`.| -|_IsShared_|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsShared -eq $true'`.| -|_IsSoftDeletedByDisable_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsSoftDeletedByDisable -eq $true'`.| -|_IsSoftDeletedByRemove_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'IsSoftDeletedByRemove -eq $true'`.| -|_IssueWarningQuota_|_mDBStorageQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "IssueWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "IssueWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.IssueWarningQuota - ''`". For example, `Get-Mailbox | where "$_.IssueWarningQuota -lt '50GB'"`.| -|_JournalArchiveAddress_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String|This property uses an SMTP email address. For example, `Get-Mailbox -Filter "JournalArchiveAddress -eq 'michelle@contoso.com'"`.| -|_LanguagesRaw_|_msExchUserCulture_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This property is named **Languages** in the properties of a mailbox, and it contains the language preference for the mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](/dotnet/api/system.globalization.cultureinfo).
You can specify multiple values separated by commas, but the order matters. For example, `Get-Mailbox -Filter "LanguagesRaw -eq 'en-US,es-MX'"` returns different results than `Get-Mailbox -Filter "LanguagesRaw -eq 'es-MX,en-US'"`.
For single values, this multivalued property will return a match if the property _contains_ the specified value.| -|_LastExchangeChangedTime_|_msExchLastExchangeChangedTime_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Mailbox -Filter 'LastExchangeChangedTime -ne $null'`.| -|_LegacyExchangeDN_|_legacyExchangeDN_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-User -Filter "LegacyExchangeDN -like 'Osca*'"`.
You can find LegacyExchangeDN values for users by running this command: `Get-User | Format-List Name,LegacyExchangeDN`| -|_LitigationHoldDate_|_msExchLitigationHoldDate_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Mailbox -Filter "LitigationHoldDate -gt '8/13/2017'"`.| -|_LitigationHoldEnabled_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'LitigationHoldEnabled -eq $true'`.| -|_LitigationHoldOwner_|_msExchLitigationHoldOwner_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property uses the user principal name of the litigation hold owner. For example, `Get-Mailbox -Filter "LitigationHoldOwner -eq 'agruber@contoso.com'"`.| -|_LastName_|_sn_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "LastName -like 'Martin*'"`.| -|_MailboxContainerGUID_|_msExchMailboxContainerGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'MailboxContainerGUID -ne $null'`.| -|_MailboxMoveBatchName_|_msExchMailboxMoveBatchName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|This property includes the name of the migration batch. For example, `Get-Mailbox -Filter "MailboxMoveBatchName -like 'LocalMove 01*'"`.
You can find the names of migration batches by running the **Get-MigrationBatch** command. Note that migration batches that you create in the Exchange admin center use the naming convention `MigrationService:`.| -|_MailboxMoveFlags_|_msExchMailboxMoveFlags_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest).|For example, `Get-Mailbox -Filter "MailboxMoveFlags -ne 'None'"`.
You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-Recipient -Filter "MailboxMoveFlags -eq 'IntraOrg,Pull'"` returns the same results as `Get-Recipient -Filter "MailboxMoveFlags -eq 'Pull,IntraOrg'"`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_MailboxMoveRemoteHostName_|_msExchMailboxMoveRemoteHostName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|For example, `Get-Mailbox -Filter 'MailboxMoveRemoteHostName -ne $null'`.| -|_MailboxMoveSourceMDB_|_msExchMailboxMoveSourceMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the source mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveSourceMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_MailboxMoveStatus_|_msExchMailboxMoveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest).|For example, `Get-Mailbox -Filter "MailboxMoveStatus -eq 'Completed'"`.| -|_MailboxMoveTargetMDB_|_msExchMailboxMoveTargetMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`|This filter requires the distinguished name of the target mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveTargetMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`.| -|_MailboxPlan_|_msExchParentPlanLink_|**Get-Mailbox**|String or `$null`|Mailbox plans correspond to Microsoft 365 license types. The availability of a license plans is determined by the selections that you make when you enroll your domain.
For example, `Get-Mailbox -Filter 'MailboxPlan -ne $null'`.| -|_MailboxRelease_|_msExchMailboxRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.|For example, `Get-Recipient -Filter 'MailboxRelease -ne $null'`.| -|_MailTipTranslations_|_msExchSenderHintTranslations_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|When you use this property in a filter, you need to account for the leading and trailing HTML tags. For example, `Get-DistributionGroup -Filter "MailTipTranslations -like 'is not monitored.*'"`.| -|_ManagedBy_|_managedBy_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group owner (a mail-enabled security principal, which is a mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "ManagedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ManagedBy -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ManagedFolderMailboxPolicy_|_msExchMailboxTemplateLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|Managed folder mailbox policies aren't available in Exchange 2013 or later.
For example, `Get-Mailbox -Filter 'ManagedFolderMailboxPolicy -eq $null'`.
This filter requires the distinguished name of the managed folder mailbox policy. For example, `Get-Mailbox -Filter "ManagedFolderMailboxPolicy -eq 'CN=MFM Inbox Policy,CN=ELC Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
You can find the distinguished names of managed folder mailbox policies on Exchange 2010 servers by running this command: `Get-ManagedFolderMailboxPolicy | Format-List Name,DistinguishedName`.| -|_Manager_|_manager_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the manager (a mailbox or mail user). For example, `Get-User -Filter "Manager -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Manager -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a manager, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName.`| -|_MAPIEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'MAPIEnabled -eq $false'`.| -|_MasterAccountSid_|_msExchMasterAccountSid_|**Get-Mailbox**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String or `$null`|For example, `Get-Mailbox -Filter 'MasterAccountSid -ne $null'`.
This value is blank ( `$null`) for mailboxes with associated user accounts, and `S-1-5-10` (Self) for mailboxes without associated user accounts (for example, shared mailboxes, resource mailboxes, discovery search mailboxes, arbitration mailboxes, and public folder mailboxes).| -|_MaxBlockedSenders_|_msExchMaxBlockedSenders_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter "MaxBlockedSenders -gt 0"`.| -|_MaxReceiveSize_|_delivContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxReceiveSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxReceiveSize -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxReceiveSize -gt '50GB'"`.| -|_MaxSafeSenders_|_msExchMaxSafeSenders_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter "MaxSafeSenders -gt 0"`.| -|_MaxSendSize_|_submissionContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxSendSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxSendSize -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxSendSize -gt '50GB'"`.| -|_MemberDepartRestriction_|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|For example, `Get-DistributionGroup -Filter "MemberDepartRestriction -eq 'ApprovalRequired'"`.| -|_MemberJoinRestriction_|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|For example, `Get-DistributionGroup -Filter "MemberJoinRestriction -eq 'ApprovalRequired'"`.| -|_MemberOfGroup_|_memberOf_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the distribution group or mail-enabled security group. For example, `Get-User -Filter "MemberOfGroup -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "MemberOfGroup -eq 'contoso.com/Users/Marketing Group'"`.
To find the distinguished name of a group, replace _\_ with the name, alias, or email address of the group, and run this command: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Members_|_member_|**Get-DistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-SecurityPrincipal**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group member. For example, `Get-Group -Filter "Members -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "Members -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a group member, replace _\_ with the name, alias, or email address of the group member, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_MobilePhone_|_mobile_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "MobilePhone -like '555*'"`.| -|_ModeratedBy_|_msExchModeratedByLink_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String|This filter requires the distinguished name or canonical distinguished name of the group moderator (a mail-enabled security principal, which is a mailbox, mail-user, or mail-enabled security group). For example, `Get-DistributionGroup -Filter "ModeratedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "ModeratedBy -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_ModerationEnabled_|_msExchEnableModeration_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ModerationEnabled -eq $true'`.| -|_Name_|_name_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)|For example, `Get-User -Filter "Name -like 'Laura*'"`.| -|_NetID_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|String or `$null`|This property is populated for Exchange Online mailboxes in hybrid environments. A sample value is `1003BFFD9A0CFA03`.
For example, `Get-User -Filter 'NetId -ne $null'`.| -|_Notes_|_info_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Notes -like 'Events Team*'"`.| -|_ObjectCategory_|_objectCategory_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|This filter requires the canonical distinguished name of the object. The value uses the syntax `/Configuration/Schema/`.
Valid _\_ values are: `Person` for mailboxes, mail users, and mail contacts, `Group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `ms-Exch-Public-Folder` for mail-enabled public folders, and `ms-Exch-Dynamic-Distribution-List` for dynamic distribution groups.
For example, `Get-Recipient -Filter "ObjectCategory -eq 'contoso.com/Configuration/Schema/Group'"`.| -|_ObjectClass_|_objectClass_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String|The value of this property is `top, person, organizationalPerson, user` for mailboxes and mail users, `top, person, organizationalPerson, contact` for mail contacts, `top, group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `msExchDynamicDistributionList` for dynamic distribution groups and `top, publicFolder` for mail-enabled public folders
For example, `Get-Recipient -Filter "ObjectClass -eq 'Contact'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Office_|_physicalDeliveryOfficeName_|**Get-Contact**
**Get-LinkedUser**
**Get-Mailbox**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Office -like '22*'"`.| -|_OfflineAddressBook_|_msExchUseOAB_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "OfflineAddressBook -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`
You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`.| -|_OnPremisesObjectId_|n/a|**Get-MailPublicFolder**|String or `$null`|For example, `Get-MailPublicFolder -Filter 'OnPremisesObjectId -ne $null'`.| -|_OperatorNumber_|_msExchUMOperatorNumber_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMailbox -Filter "OperatorNumber -eq 5"`.| -|_OtherFax_|_otherFacsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherFax -like '206*'"`.| -|_OtherHomePhone_|_otherHomePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherHomePhone -like '206*'"`.| -|_OtherTelephone_|_otherTelephone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "OtherTelephone -like '206*'"`.| -|_OWAEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|The filter operates backwards. For example, `Get-CASMailbox -Filter 'OWAEnabled -eq $true'` returns mailboxes where the **OWAEnabled** property is `False`, and `Get-CASMailbox -Filter 'OWAEnabled -eq $false'` returns mailboxes where the **OWAEnabled** property is `True`| -|_OWAforDevicesEnabled_|_msExchOmaAdminWirelessEnable_|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'OWAForDevicesEnabled -eq $true'`.| -|_OWAMailboxPolicy_|_msExchOWAPolicy_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the Outlook on the web mailbox policy (formerly known as an Outlook Web App mailbox policy). For example, `Get-CASMailbox -Filter "OWAMailboxPolicy -eq 'CN=Default,CN=OWA Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com`'".
You can find the distinguished names of Outlook on the web mailbox policies by running this command: `Get-OwaMailboxPolicy | Format-List Name,DistinguishedName`.| -|_Pager_|_pager_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Pager -like '206*'"`.| -|_PersistedCapabilities_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`|Typically, the value of this property something other than `$null` (blank) for Microsoft 365 accounts and mailboxes. For more information about the valid property values, see [Capability enumeration](/previous-versions/office/exchange-server-api/ff441134(v=exchg.150)).
For example, `Get-Mailbox -Filter 'PersistedCapabilities -ne $null'`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_Phone_|_telephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Phone -like '206*'"`.| -|_PhoneProviderId_|_msExchUMPhoneProvider_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMailbox -Filter "PhoneProviderId -like '206*'"`.| -|_PhoneticDisplayName_|_msDS-PhoneticDisplayName_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-MailPublicFolder**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "PhoneticDisplayName -like 'Lila*'"`.| -|_PoliciesExcluded_|_msExchPoliciesExcluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'PoliciesExcluded -ne $null'`.| -|_PoliciesIncluded_|_msExchPoliciesIncluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|For example, `Get-Recipient -Filter 'PoliciesIncluded -eq $null'`.| -|_PopEnabled_|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)|For example, `Get-CASMailbox -Filter 'POPEnabled -eq $false'`.| -|_PostalCode_|_postalCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "PostalCode -eq 90210"`.| -|_PostOfficeBox_|_postOfficeBox_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "PostOfficeBox -like '555*'"`.| -|_PreviousRecipientTypeDetails_|_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser**
**Get-User**|String or `$null`|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient).
For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`.| -|_PrimarySmtpAddress_|n/a|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)|Don't use the _PrimarySmtpAddress_ property; use the _EmailAddresses_ property instead. Any filter that uses the _PrimarySmtpAddress_ property will also search values in the _EmailAddresses_ property. For example, if a mailbox has the primary email address dario@contoso.com, and the additional proxy addresses dario2@contoso.com and dario3@contoso.com, all of the following filters will return that mailbox in the result: `"PrimarySmtpAddress -eq 'dario@contoso.com'"`, `"PrimarySmtpAddress -eq 'dario2@contoso.com'"`, or `"PrimarySmtpAddress -eq 'dario3@contoso.com'"`.| -|_ProhibitSendQuota_|_mDBOverQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendQuota -lt '70GB'"`.| -|_ProhibitSendReceiveQuota_|_mDBOverHardQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendReceiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendReceiveQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendReceiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendReceiveQuota -lt '70GB'"`.| -|_ProtocolSettings_|_protocolSettings_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|The default value of this property on mailboxes is `RemotePowerShell§1`. This property is populated with additional values when you use Set-CASMailbox to disable protocols (for example, POP3 or IMAP4).
For example, `Get-Mailbox -Filter "ProtocolSettings -like 'POP3*'"`.| -|_PublicFolderContacts_|_pFContacts_|**Get-MailPublicFolder**|String or `$null`|This property is displayed as **Contacts** in the results of the command `Get-MailPublicFolder -Identity | Format-List`, but you need to use the property name **PublicFolderContacts** in the filter.
This filter requires the distinguished name or canonical distinguished name of the public folder contact. For example, `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of a public folder contact, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_QueryBaseDN_|_msExchQueryBaseDN_|**Get-Mailbox**|String or `$null`|This property was used in Exchange 2007 global address list segregation to specify a location in Active Directory. This feature was replaced by address book policies in Exchange 2010 Service Pack 2, so the value of this property should always be blank ( `$null`).
For example, `Get-Mailbox -Filter 'QueryBaseDN -ne $null'`.| -|_RecipientContainer_|_msExchDynamicDLBaseDN_|**Get-DynamicDistributionGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the organizational unit or container in Active Directory. For example, `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'CN=Users,DC=contoso,DC=com'"` or `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'contoso.com/Users'"`
To find the distinguished names or canonical distinguished names of organizational units and containers in Active Directory, run this command: `Get-OrganizationalUnit -IncludeContainers | Format-List Name,DistinguishedName,ID`.| -|_RecipientLimits_|_msExchRecipLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Integer or `Unlimited`|For example, `Get-Mailbox -Filter "RecipientLimits -ne 'Unlimited'"`.| -|_RecipientType_|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|`DynamicDistributionGroup`, `MailContact`, `MailNonUniversalGroup`, `MailUniversalDistributionGroup`, `MailUniversalSecurityGroup`, `MailUser`, `PublicFolder` or `UserMailbox`|For example, `Get-Recipient -Filter "RecipientType -eq 'MailContact'"`.| -|_RecipientTypeDetails_|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|String|For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient).
For example, `Get-Recipient -Filter "RecipientTypeDetails -eq 'SharedMailbox'"`.| -|_RecoverableItemsQuota_|_msExchDumpsterQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsQuota - ''`. For example, `Get-Mailbox | where "$_.RecoverableItemsQuota -gt '35GB'"`.| -|_RecoverableItemsWarningQuota_|_msExchDumpsterWarningQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.|You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsWarningQuota -ne 'Unlimited'"`.
You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsWarningQuota - ''`". For example, `Get-Mailbox | where "$_.RecoverableItemsWarningQuota -gt '25GB'"`.| -|_RejectMessagesFrom_|_unauthOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'contoso.com/Users/Angela Gruber'"`.
To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_RejectMessagesFromDLMembers_|_dLMemRejectPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`|This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`.
To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_RemoteAccountPolicy_|_msExchSyncAccountsPolicyDN_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the remote account policy. For example, `Get-Mailbox -Filter "RemoteAccountPolicy -eq 'CN=Contoso Remote Account Policy,CN=Remote Accounts Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.| -|_RemotePowerShellEnabled_|n/a|**Get-User**|Boolean (`$true` or `$false`)|For example, `Get-User -Filter 'RemotePowerShellEnabled -eq $false'`.| -|_RemoteRecipientType_|_msExchRemoteRecipientType_|**Get-Mailbox**
**Get-RemoteMailbox**|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), `TeamMailbox` (128), or `$null`.|For example, `Get-RemoteMailbox -Filter "RemoteRecipientType -eq 'ProvisionMailbox'"`.| -|_ReportToManagerEnabled_|_reportToOwner_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ReportToManagerEnabled -eq $true'`.| -|_ReportToOriginatorEnabled_|_reportToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'ReportToOriginatorEnabled -eq $false'`.| -|_RequireAllSendersAreAuthenticated_|_msExchRequireAuthToSendTo_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**|Boolean (`$true` or `$false`)|This property is displayed as **RequireSenderAuthenticationEnabled** in the results of the command `Get- -Identity | Format-List`, but you need to use the property name **RequireAllSendersAreAuthenticated** in the filter. For example, `Get-DistributionGroup -Filter 'RequireAllSendersAreAuthenticated -eq $false'`.| -|_ResourceBehaviorOptions_|n/a|**Get-UnifiedGroup**|`AllowOnlyMembersToPost`, `CalendarMemberReadOnly`, `ConnectorsEnabled`, `HideGroupInOutlook`, `NotebookForLearningCommunitiesEnabled`, `ReportToOriginator`, `SharePointReadonlyForMembers`, `SubscriptionEnabled`, `SubscribeMembersToCalendarEvents`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers`, `WelcomeEmailDisabled`, `WelcomeEmailEnabled`, or `$null`|For example, `Get-UnifiedGroup -Filter "ResourceBehaviorOptions -eq 'CalendarMemberReadOnly'"`| -|_ResourceCapacity_|_msExchResourceCapacity_|**Get-Mailbox**|Integer or `$null`|For example, `Get-Mailbox -Filter "ResourceCapacity -gt 15"`| -|_ResourceCustom_|n/a|**Get-Mailbox**|String or `$null`|You create custom resource properties by using the Set-ResourceConfig cmdlet. For example, `Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van`. After you create the properties, you can assign them to room or equipment mailboxes. For example, `Set-Mailbox -Identity "Conference Room 1" -ResourceCustom Whiteboard`.
When you search for values, use the custom resource property that's assigned to the room or equipment mailbox. For example, `Get-Mailbox -Filter "ResourceCustom -eq 'Whiteboard'"`.| -|_ResourceProvisioningOptions_|n/a|**Get-UnifiedGroup**|`Team` or `$null`|For example, `Get-UnifiedGroup -Filter "ResourceProvisioningOptions -eq 'Team'"`| -|_ResourceType_|n/a|**Get-Mailbox**
**Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`|For example, `Get-Mailbox -Filter "ResourceType -eq 'Equipment'"`| -|_RetainDeletedItemsFor_|_garbageCollPeriod_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.|You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.RetainDeletedItemsFor - ''"`. For example, `Get-Mailbox | where "$_.RetainDeletedItemsFor -gt '14.00:00:00'"`.| -|_RetentionComment_|_msExchRetentionComment_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "RetentionComment -like '7 years*'"`| -|_RetentionPolicy_|n/a|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the retention policy. For example, `Get-Mailbox -Filter "RetentionPolicy -eq 'CN=Default MRM Policy,CN=Retention Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of retention policies, run this command: `Get-RetentionPolicy | Format-List Name,DistinguishedName`.| -|_RetentionUrl_|_msExchRetentionURL_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "RetentionUrl -like 'https://intranet.contoso.com/*'"`| -|_RoleAssignmentPolicy_|_msExchRBACPolicyLink_|**Get-Mailbox**|String (wildcards accepted) or `$null`|This filter requires the distinguished name of the role assignment policy in Exchange Online. For example, `Get-Mailbox -Filter "RoleAssignmentPolicy -eq 'CN=Default Role Assignment Policy,CN=Policies,CN=RBAC,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR10A001,DC=PROD,DC=OUTLOOK,DC=COM'"`.
To find the distinguished names of role assignment policies in Exchange Online, run this command: `Get-RoleAssignmentPolicy | Format-List Name,DistinguishedName`.| -|_RulesQuota_|_msExchMDBRulesQuota_|**Get-Mailbox**|A byte quantified size value (for example, `50B` or `128KB`). Unqualified values are treated as bytes.|You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RulesQuota - ''"`. For example, `Get-Mailbox | where "$_.RulesQuota -lt '256KB'"`.| -|_SafeRecipientsHash_|_msExchSafeRecipientsHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeRecipientsHash -ne $null'.`| -|_SafeSendersHash_|_msExchSafeSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.|Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeSendersHash -ne $null'.`| -|_SamAccountName_|_SamAccountName_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Recipient -Filter "SamAccountName -like 'laura*'"`| -|_SCLDeleteThresholdInt_|_msExchMessageHygieneSCLDeleteThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLDeleteThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLDeleteThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLDeleteThresholdInt -ge -2147483640"`.| -|_SCLJunkThresholdInt_|_msExchMessageHygieneSCLJunkThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLJunkThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLJunkThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLJunkThresholdInt -ge -2147483645"`.| -|_SCLQuarantineThresholdInt_|_msExchMessageHygieneSCLQuarantineThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLQuarantineThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLQuarantineThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLQuarantineThresholdInt -ge -2147483643"`.| -|_SCLRejectThresholdInt_|_msExchMessageHygieneSCLRejectThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`|This property is displayed as **SCLRejectThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLRejectThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLRejectThresholdInt -ge -2147483641"`.| -|_SendOofMessageToOriginatorEnabled_|_oOFReplyToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)|For example, `Get-DistributionGroup -Filter 'SendOofMessageToOriginatorEnabled -eq $true'`.| -|_ServerLegacyDN_|_msExchHomeServerName_|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "ServerLegacyDN -like 'Mailbox01'"`.
This is an example of a complete **ServerLegacyDN** value: `/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01`.| -|_ServerName_|n/a|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String or `$null`|For example, `Get-Recipient -Filter "ServerName -eq 'Mailbox01'"`.| -|_SharingPolicy_|_msExchSharingPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the sharing policy. For example, `Get-Mailbox -Filter "SharingPolicy -eq 'CN=Custom Sharing Policy,CN=Federation,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of sharing policies, run this command: `Get-SharingPolicy | Format-List Name,DistinguishedName`.
**Note**: For the default assignment of the default sharing policy (named Default Sharing Policy) to a mailbox, the value of the **SharingPolicy** property is blank (`$null`).| -|_Sid_|_objectSid_|**Get-Group**
**Get-LinkedUser**
**Get-SecurityPrincipal**
**Get-User**|String|For example, `Get-User -Filter "Sid -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`.| -|_SidHistory_|_SIDHistory_|**Get-Group**
**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter "SidHistory -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`.| -|_SimpleDisplayName_|_displayNamePrintable_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "SimpleDisplayName -like 'lila*'"`.| -|_SingleItemrecoveryEnabled_|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'SingleItemRecoveryEnabled -eq $true'`.| -|_SKUAssigned_|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|Boolean (`$true` or `$false`) or `$null`.|For example, `Get-User -Filter 'SKUAssigned -eq $true'`.| -|_SourceAnchor_|n/a|**Get-Mailbox**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter 'SourceAnchor -ne $null'`.| -|_StateOrProvince_|_st_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "StateOrProvince -like 'Carolina*'"`.| -|_StreetAddress_|_streetAddress_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "StreetAddress -like '36th Ave NE*'"`.| -|_StsRefreshTokensValidFrom_|_msExchStsRefreshTokensValidFrom_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-User -Filter "StsRefreshTokensValidFrom -gt '8/1/2017'"`.| -|_TelephoneAssistant_|_telephoneAssistant_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "TelephoneAssistant -like '206*'"`.| -|_ThrottlingPolicy_|_msExchThrottlingPolicyDN_|**Get-Mailbox**|String or `$null`|This filter requires the distinguished name of the throttling policy. For example, `Get-Mailbox -Filter "ThrottlingPolicy -eq 'CN=Custom Throttling Policy,CN=Global Settings,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of throttling policies, run this command: `Get-ThrottlingPolicy | Format-List Name,DistinguishedName`.| -|_Title_|_title_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "Title -eq 'Dr.'"`.| -|_UMAddresses_|_msExchUMAddresses_|**Get-UMMailbox**|String (wildcards accepted) or `$null`|For example, `Get-UMMailbox -Filter 'UMAddresses -ne $null'`.| -|_UMCallingLineIds_|_msExchUMCallingLineIds_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "UMCallingLineIds -like '123*'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_UMDtmfMap_|_msExchUMDtmfMap_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "UMDtmfMap -like '26297*'"`.
Although this is a multivalued property, the filter will return a match if the property _contains_ the specified value.| -|_UMEnabled_|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'UMEnabled -eq $true'`.| -|_UMMailboxPolicy_|_msExchUMTemplateLink_|**Get-Recipient**
**Get-UMMailbox**|String or `$null`|This filter requires the distinguished name of the UM mailbox policy. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Default Policy,CN=UM Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of UM mailbox policies, run this command: `Get-UMMailboxPolicy | Format-List Name,DistinguishedName`.| -|_UMRecipientDialPlanId_|_msExchUMRecipientDialPlanLink_|**Get-Recipient**|String or `$null`|This filter requires the distinguished name of the UM dial plan. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Dial Plan,CN=UM DialPlan Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`.
To find the distinguished names of UM dial plans, run this command: `Get-UMDialPlan | Format-List Name,DistinguishedName`.| -|_UpgradeRequest_|n/a|**Get-User**|`None` (0), `TenantUpgrade` (1), `PrestageUpgrade` (2), `CancelPrestageUpgrade` (3), `PilotUpgrade` (4), or `TenantUpgradeDryRun` (5),|For example, `Get-User -Filter "UpgradeRequest -ne 'None'"`.| -|_UpgradeStatus_|n/a|**Get-User**|`None` (0), `NotStarted` (1), `InProgress` (2), `Warning` (3), `Error` (4), `Cancelled` (5), `Complete` (6), or `ForceComplete` (7).|For example, `Get-User -Filter "UpgradeStatus -ne 'None'"`.| -|_UsageLocation_|_msExchUsageLocation_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**|String or `$null`|This filter requires the ISO 3166-1 country name (for example, `United States`), or two-letter country code (for example `US`) for the user in Microsoft 365. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).
For example, `Get-Recipient -Filter 'UsageLocation -ne $null'`.| -|_UseDatabaseQuotaDefaults_|_mDBUseDefaults_|**Get-Mailbox**|Boolean (`$true` or `$false`)|For example, `Get-Mailbox -Filter 'UseDatabaseQuotaDefaults -eq $false'`.| -|_UserAccountControl_|_userAccountControl_|**Get-LinkedUser**
**Get-User**|`AccountDisabled`, `DoNotExpirePassword`, or `NormalAccount`|For example, `Get-User -Filter "UserAccountControl -eq 'NormalAccount'"`.
You can specify multiple values separated by commas, but the order matters. For example, `Get-User -Filter "UserAccountControl -eq 'AccountDisabled,NormalAccount'"` returns different results than `Get-User -Filter "UserAccountControl -eq 'NormalAccount,AccountDisabled'"`.
This multivalued property will only return a match if the property *equals* the specified value.| -|_UserPrincipalName_|_userPrincipalName_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted)|For example, `Get-User -Filter "UserPrincipalName -like 'julia@*'"`.| -|_VoiceMailSettings_|_msExchUCVoiceMailSettings_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`|For example, `Get-User -Filter 'VoiceMailSettings -ne $null'`.| -|_WebPage_|_wWWHomePage_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-User -Filter "WebPage -like 'https://intranet.contoso.com/*'"`.| -|_WhenChanged_|_WhenChanged_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenChanged -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenChangedUTC_|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenChangedUTC -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenCreated_|_whenCreated_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenCreated -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenCreatedUTC_|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenCreatedUTC -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenMailboxCreated_|_msExchWhenMailboxCreated_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|For example, `Get-Recipient -Filter "WhenMailboxCreated -gt '8/1/2017 2:00:00 PM'"`.| -|_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)|This filter requires the _SoftDeleted_ switch in the command for mailboxes.
For example, `Get-Mailbox -SoftDeleted -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"`.| -|_WindowsEmailAddress_|_mail_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.com*'"`.| -|_WindowsLiveID_|_msExchWindowsLiveID_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`|For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.onmicrosoft.com*'"`.| -| +- For filtering considerations for the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). + +## AcceptMessagesOnlyFrom + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_authOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "AcceptMessagesOnlyFrom -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## AcceptMessagesOnlyFromDLMembers + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_dLMemSubmitPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"`. or `Get-Mailbox -Filter "AcceptMessagesOnlyFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`. + +To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## ActiveSyncAllowedDeviceIDs + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMobileAllowedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`| + +A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`. + +After you have the device ID value, you can use it in the filter. For example, `Get-CasMailbox -Filter "(ActiveSyncAllowedDeviceIDs -like 'text1*') -or (ActiveSyncAllowedDeviceIDs -eq 'text2'"`. + +## ActiveSyncBlockedDeviceIDs + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMobileBlockedDeviceIds_|**Get-CASMailbox**|String (wildcards accepted) or `$null`| + +A device ID is a text string that uniquely identifies the device. Use the **Get-MobileDevice** cmdlet to see the devices that have ActiveSync partnerships with a mailbox. To see the device IDs on a mailbox, replace _\_ with the name, alias, or email address of the mailbox, and run this command: `Get-MobileDevice -Mailbox | Format-List`. + +After you have the device ID value, you can use it in a filter. For example, `Get-CasMailbox -Filter "(ActiveSyncBlockedDeviceIDs -like 'text1*') -or (ActiveSyncBlockedDeviceIDs -eq 'text2'"`. + +## ActiveSyncEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CasMailbox -Filter 'ActiveSyncEnable -eq $false'`. + +## ActiveSyncMailboxPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMobileMailboxPolicyLink_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the ActiveSync mailbox policy. For example, `Get-CASMailbox -Filter "ActiveSyncMailboxPolicy -eq 'CN=Default,CN=Mobile Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of ActiveSync mailbox policies by running this command: `Get-MobileDeviceMailboxPolicy | Format-List Name,DistinguishedName`. + +> [!NOTE] +> For the default assignment of the default ActiveSync mailbox policy (named Default) to a mailbox, the value of the **ActiveSyncMailboxPolicy** property is blank (`$null`). + +## ActiveSyncSuppressReadReceipt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CasMailbox -Filter 'ActiveSyncSuppressReadReceipt -eq $true'`. + +## AddressBookPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAddressBookPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the address book policy. For example, `Get-Mailbox -Filter "AddressBookPolicy -eq 'CN=Contoso ABP,CN=AddressBook Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of address book policies by running this command: `Get-AddressBookPolicy | Format-List Name,DistinguishedName`. + +## AddressListMembership + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_showInAddressBook_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name of the address list. For example, `Get-MailContact -Filter "AddressListMembership -eq 'CN=All Contacts,CN=All Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of address lists by running this command: `Get-AddressList | Format-List Name,DistinguishedName`. + +## AdminDisplayName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_adminDisplayName_|**Get-SecurityPrincipal**|String (wildcards accepted) or `$null`| + +For example, `Get-SecurityPrincipal -Filter 'AdminDisplayName -ne $null' | Format-Table -Auto Name,AdminDisplayName`. + +## AdministrativeUnits + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAdministrativeUnitLink_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|`$null`| + +For example, `Get-User -Filter 'AdministrativeUnits -ne $null'`. + +## AggregatedMailboxGuids + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAlternateMailboxes_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +For example, `Get-Mailbox -Filter 'AggregatedMailboxGuids -ne $null'`. + +## Alias + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mailNickname_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-Recipient -Filter "Alias -like 'smith*'"`. + +## AllowUMCallsFromNonUsers + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMListInDirectorySearch_|**Get-Contact**
**Get-LinkedUser**
**Get-UMMailbox**
**Get-User**|`None` (0) or `SearchEnabled` (1)| + +For example, `Get-User -Filter "AllowUMCallsFromNonUsers -ne 'SearchEnabled'"`. + +## ArbitrationMailbox + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArbitrationMailbox_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the arbitration mailbox. For example, `Get-DistributionGroup -Filter "ArbitrationMailbox -eq 'CN=SystemMailbox"1f05a927-2e8f-4cbb-9039-2cfb8b95e486",CN=Users,DC=contoso,DC=com'"`. + +You can find the distinguished names of arbitration mailboxes by running this command: `Get-Mailbox -Arbitration | Format-List Name,DistinguishedName`. + +## ArchiveDatabase + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the archive mailbox database. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## ArchiveDomain + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +This property is used in on-premises Exchange environments to identify the Exchange Online organization that holds the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveDomain -like 'contoso.onmicrosoft.com*'"`. + +## ArchiveGuid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the GUID of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveMailbox -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`. + +You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`. + +## ArchiveName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveName_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +This filter requires the name of the archive mailbox. For example, `Get-Mailbox -Filter "ArchiveName -like 'In-Place Archive*'"`. + +You can find the names of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveName`. + +## ArchiveQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveQuota -gt '85GB'"`. + +## ArchiveRelease + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.| + +For example, `Get-Recipient -Filter 'ArchiveRelease -ne $null'`. + +## ArchiveState + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0), `Local` (1), `HostedProvisioned` (2), `HostedPending` (3), or `OnPremise` (4).| + +For example, `Get-Recipient -Filter "ArchiveState -eq 'HostedProvisioned'"`. + +## ArchiveStatus + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|`None` (0) or `Active` (1).| + +For example, `Get-Recipient -Filter "ArchiveStatus -eq 'Active'"`. + +## ArchiveWarningQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchArchiveWarnQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ArchiveWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ArchiveWarningQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ArchiveWarningQuota - ''"`. For example, `Get-Mailbox | where "$_.ArchiveWarningQuota -gt '85GB'"`. + +## AssistantName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAssistantName_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "AssistantName -like 'Julia*'"`. + +## AuditEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxAuditEnable_|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'AuditEnabled -eq $true'`. + +## AuditLogAgeLimit + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxAuditLogAgeLimit_|**Get-Mailbox**
**Get-UnifiedGroup**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.| + +You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.AuditLogAgeLimit - ''"`. For example, `Get-Mailbox | where "$_.AuditLogAgeLimit -gt '60.00:00:00'"`. + +## AuthenticationPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchAuthPolicyLink_|**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "AuthenticationPolicy -eq 'CN=Block Basic Auth,CN=Auth Policies,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR11B009,DC=PROD,DC=OUTLOOK,DC=COM'"`. + +## BlockedSendersHash + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchBlockedSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.| + +Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'BlockedSendersHash -ne $null'.` + +## c + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_c_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String (wildcards accepted) or `$null`| + +This filter requires the ISO 3166-1 two-letter country code for the user (for example, `US` for the United States). This property is used together with the _co_ and _countryCode_ properties to define the user's country in Active Directory. + +For example, `Get-User -Filter "c -eq 'US'"`. + +## CalendarLoggingQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchCalendarLoggingQuota_|**Get-Mailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "CalendarLoggingQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "CalendarLoggingQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.CalendarLoggingQuota - ''"`. For example, `Get-Mailbox | where "$_.CalendarLoggingQuota -gt '10GB'"`. + +## CalendarRepairDisabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchCalendarRepairDisabled_|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'CalendarRepairDisabled -eq $true'`. + +## CertificateSubject + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`| + +The X509 certificate that's published for the user account (visible on the **Published Certificates** tab in Active Directory Users and Computers). + +For example, `Get-User -Filter "CertificateSubject -eq 'X509:C=US,O=InternetCA,CN=APublicCertificateAuthorityC=US,O=Fabrikam,OU=Sales,CN=Jeff Smith`') + +## City + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_l_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "City -eq 'Redmond'"`. + +## Company + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_company_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Company -like 'Contoso*'"`. + +## ComplianceTagHoldApplied + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'ComplianceTagHoldApplied -eq $true'`. + +## ConsumerNetID + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-User**|String or `$null`| + +For example, `Get-User -Filter 'ConsumerNetID -ne $null'`. + +## CountryCode + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_countryCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|Integer| + +This filter requires the ISO 3166-1 three-digit country code for the user (for example, `840` for the United States). This property is used together with the _c_ and _co_ properties to define the user's country in Active Directory. + +For example, `Get-User -Filter "countryCode -eq 796"`. + +## CountryOrRegion + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_co_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String| + +This filter requires the ISO 3166-1 country name for the user (for example, `United States`). You can select an available value in Active Directory Users and Computers ( **Address** tab > **Country/region** field), or the Exchange admin center (user properties > **Contact information** tab > **Country/Region** field). + +When you select a user's country in Active Directory Users and Computers or the EAC, the corresponding values for the _co_ and _countryCode_ properties are automatically configured. + +For example, `Get-User -Filter "CountryOrRegion -like 'United*'"`. + +## CustomAttribute1 to CustomAttribute15 + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_extensionAttribute1_ to _extensionAttribute15_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "CustomAttribute8 -like 'audited*'"`. + +## Database + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_homeMDB_|**Get-Mailbox**
**Get-Recipient**|String| + +This filter requires the distinguished name of the mailbox database. For example, `Get-Mailbox -Filter "Database -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## DefaultPublicFolderMailbox + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPublicFolderMailbox_|**Get-Mailbox**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the public folder mailbox. For example, `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'CN=PF Mailbox01,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "DefaultPublicFolderMailbox -eq 'contoso.com/Users/PF Mailbox01'"`. + +To find the distinguished names of public folder mailboxes, run this command: `Get-Mailbox -PublicFolder | Format-List Name,DistinguishedName`. + +## DeletedItemFlags + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_deletedItemFlags_|**Get-Mailbox**
**Get-SecurityPrincipal**|`DatabaseDefault` (0), `RetainUntilBackupOrCustomPeriod` (3), or `RetainForCustomPeriod` (5).| + +For example, `Get-Mailbox -Filter "DeletedItemFlags -ne 'DatabaseDefault'"`. + +## DeliverToMailboxAndForward + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_deliverAndRedirect_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-MailPublicFolder**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'DeliverToMailboxAndForward -eq $true'`. + +## Department + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_department_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "Department -like 'Engineering*'"`. + +## DirectReports + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_directReports_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the direct report. For example, `Get-User -Filter "DirectReports -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "DirectReports -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a direct report, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## DisabledArchiveDatabase + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDisabledArchiveDatabaseLink_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the disabled archive mailbox database. For example, `Get-Mailbox -Filter "DisabledArchiveDatabase -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## DisabledArchiveGuid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDisabledArchiveDatabaseGUID_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the GUID of the disabled archive mailbox. For example, `Get-Mailbox -Filter "DisabledArchiveGuid -eq '6476f55e-e5eb-4462-a095-f2cb585d648d'"`. + +You can find the GUID of archive mailboxes by running this command: `Get-Mailbox -Archive | Format-Table -Auto Name,ArchiveGUID`. + +## DisplayName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_displayName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-Recipient -Filter "DisplayName -like 'Julia*'"`. + +## DistinguishedName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String| + +This filter requires the distinguished name of the recipient. For example, `Get-Mailbox -Filter "DistinguishedName -eq 'CN=Basho Kato,CN=Users,DC=contoso,DC=com'"`. + +You can find the distinguished names of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,DistinguishedName`. + +## EcpEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'EcpEnabled -eq $false'`. + +## EmailAddresses + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_proxyAddresses_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-Recipient -Filter "EmailAddresses -like 'marketing*'"`. + +When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"EmailAddresses -eq 'lila@fabrikam.com'"` returns a match, `"EmailAddresses -like 'lila*'"` won't return a match, but or `"EmailAddresses -like 'smtp:lila*'"` will return a match. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## EmailAddressPolicyEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-Recipient -Filter 'EmailAddressPolicyEnabled -eq $false'`. + +## EntryId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPublicFolderEntryId_|**Get-MailPublicFolder**|String (wildcards accepted)| + +For example, `Get-MailPublicFolder -Filter "EntryId -like '60000*'"`. + +You can find the entry IDs of mail-enabled public folders by running this command: `Get-MailPublicFolder | Format-List Name,EntryId`. + +## EwsApplicationAccessPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchEwsApplicationAccessPolicy_|**Get-CASMailbox**|`EnforceAllowList`, `EnforceBlockList`. or `$null`| + +For example, `Get-CASMailbox -Filter 'EwsApplicationAccessPolicy -ne $null'`. + +## EwsEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchEwsEnabled_|**Get-CASMailbox**|0 (disabled), 1 (enabled) or `$null`.| + +For example, `Get-CASMailbox -Filter "EwsEnabled -eq 1"`. + +## ExchangeGuid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String| + +For example, `Get-Mailbox -Filter "ExchangeGuid -eq 'c80a753d-bd4a-4e19-804a-6344d833ecd8'"`. + +To find the Exchange GUID of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,ExchangeGuid`. + +Note that an object's Exchange GUID value is different than its GUID value. Also, the Exchange GUID value for non-mailboxes (mail contacts, mail users, distribution groups, dynamic distribution groups, mail-enabled security groups, and mail-enabled public folders) is `00000000-0000-0000-0000-000000000000`. + +## ExchangeUserAccountControl + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUserAccountControl_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`None` (0) or `AccountDisabled` (2)| + +For example, `Get-Mailbox -Filter "ExchangeUserAccountControl -eq 'AccountDisabled'"`. + +## ExchangeVersion + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchVersion_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|Integer| + +This property contains the earliest version of Exchange that you can use to manage the recipient. The property values that you see are different than the values that you need to use in the filter. To see the **ExchangeVersion** property values, run this command: `Get-Recipient | Format-Table Name,RecipientType,ExchangeVersion`. + +For the Exchange 2010 value `0.10 (14.0.100.0)`, use the value 44220983382016 in the filter. + +For the Exchange 2013 or Exchange 2016 value `0.20 (15.0.0.0)`, use the value 88218628259840 in the filter. + +For example, `Get-Recipient -Filter "ExchangeVersion -lt 88218628259840"`. + +## ExpansionServer + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchExpansionServerName_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Recipient**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "ExpansionServer -like 'Mailbox01*'"`. + +For an exact match, you need to use the **ExchangeLegacyDN** value of the server. For example, `Get-Recipient -Filter "ExpansionServer -eq '/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01'"` + +You can find the **ExchangeLegacyDN** value by running this command: `Get-ExchangeServer | Format-List Name,ExchangeLegacyDN`. + +## ExtensionCustomAttribute1 to ExtensionCustomAttribute5 + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "ExtensionCustomAttribute8 -like 'audited*'"`. + +## ExternalDirectoryObjectId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchExternalDirectoryObjectId_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|String or `$null`| + +For example, `Get-Recipient -Filter 'ExternalDirectoryObjectId -ne $null'`. + +## ExternalEmailAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_targetAddress_|**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "ExternalEmailAddress -like '@fabrikam.com*'"`. + +When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ExternalEmailAddress -eq 'lila@fabrikam.com'"` returns a match, `"ExternalEmailAddress -like 'lila*'"` won't return a match, but `"ExternalEmailAddress -like 'smtp:lila*'"` will return a match. + +## ExternalOofOptions + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchExternalOOFOptions_|**Get-Mailbox**|`External` (0) or `InternalOnly` (1)| + +For example, `Get-Mailbox -Filter "ExternalOofOptions -eq 'External'"`. + +## Fax + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_facsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Fax -like '206*'"`. + +## FirstName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_givenName_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "FirstName -like 'Chris*'"`. + +## ForwardingAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_altRecipient_|**Get-Mailbox**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the forwarding recipient. For example, `Get-Mailbox -Filter "ForwardingAddress -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ForwardingAddress -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a forwarding recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +## ForwardingSmtpAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchGenericForwardingAddress_|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "ForwardingSmtpAddress -like '@fabrikam.com*'"`. + +When you use a complete email address, you don't need to account for the `smtp:` prefix. If you use wildcards, you do. For example, if `"ForwardingSmtpAddress -eq 'lila@fabrikam.com'"` returns a match, `"ForwardingSmtpAddress -like 'lila*'"` won't return a match, but `"ForwardingSmtpAddress -like 'smtp:lila*'"` will return a match. + +## GeneratedOfflineAddressBooks + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchOABGeneratingMailboxBL_|**Get-Mailbox**|String or `$null`| + +This property is only meaningful on arbitration mailboxes, so you need to use the _Arbitration_ switch in the filter command. Also, This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "GeneratedOfflineAddressBooks -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## GrantSendOnBehalfTo + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_publicDelegates_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the mail-enabled security principal (mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "GrantSendOnBehalfTo -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## GroupMemberCount + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-UnifiedGroup**|Integer| + +For example, `Get-UnifiedGroup -Filter "GroupMemberCount -gt 100"`. + +## GroupExternalMemberCount + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-UnifiedGroup**|Integer| + +For example, `Get-UnifiedGroup -Filter "GroupExternalMemberCount -gt 0"`. + +## GroupType + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_groupType_|**Get-DistributionGroup**
**Get-Group**
**Get-UnifiedGroup**|`None` (0), `Global` (2), `DomainLocal` (4), `BuiltinLocal` (5), `Universal` (8), or `SecurityEnabled` (-2147483648).| + +Distribution groups have the value `Universal`, and mail-enabled security groups have the value `Universal, SecurityEnabled`. You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-DistributionGroup -Filter "GroupType -eq 'Universal,SecurityEnabled'"` returns the same results as `Get-DistributionGroup -Filter "GroupType -eq 'SecurityEnabled,Universal'"`. + +This multivalued property will only return a match if the property _equals_ the specified value. + +## Guid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_objectGuid_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**
**Get-UnifiedGroup**|String| + +For example, `Get-Recipient -Filter "Guid -eq '8a68c198-be28-4a30-83e9-bffb760c65ba'"`. + +You can find the GUIDs of recipients by running this command: `Get-Recipient | Format-List Name,RecipientType,Guid`. + +Note that an object's GUID value is different than its Exchange GUID value. + +## HasActiveSyncDevicePartnership + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-Recipient**|Boolean (`$true` or `$false`)| + +For example, `Get-Recipient -Filter 'HasActiveSyncDevicePartnership -eq $true'`. + +## HiddenFromAddressListsEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchHideFromAddressLists_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-Recipient -Filter 'HiddenFromAddressListsEnabled -eq $true'`. + +## HiddenGroupMembershipEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_hideDLMembership_|**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-UnifiedGroup -Filter 'HiddenGroupMembershipEnabled -eq $true'`. + +## HomePhone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_homePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "HomePhone -like '206*'"`. + +## Id + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_distinguishedName_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMMailbox**
**Get-User**
**Get-SecurityPrincipal**
**Get-UnifiedGroup**|String| + +This filter requires the distinguished name or canonical distinguished name of the recipient. For example, `Get-Mailbox -Filter "Id -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Id -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +## IgnoreMissingFolderLink + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-MailPublicFolder**|Boolean (`$true` or `$false`)| + +For example, `Get-MailPublicFolder -Filter 'IgnoreMissingFolderLink -eq $true'`. + +## ImapEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'ImapEnabled -eq $false'`. + +## ImmutableId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchGenericImmutableId_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +For example, `Get-Mailbox -Filter 'ImmutableId -ne $null'`. + +## IncludeInGarbageCollection + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IncludeInGarbageCollection -eq $true'`. + +## Initials + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_initials_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Initials -like 'B.'"`. + +## InPlaceHolds + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUserHoldPolicies_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String| + +This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHolds -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`. + +To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## InPlaceHoldsRaw + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-User**|String| + +This filter requires the **InPlaceHoldIdentity** value of the mailbox search. For example, `Get-Mailbox -Filter "InPlaceHoldsRaw -eq '9d0f81154cc64c6b923ecc0be5ced0d7'"`. + +To find the **InPlaceHoldIdentity** values of mailbox searches, run this command: `Get-MailboxSearch | Format-Table Name,InPlaceHoldIdentity`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## IsDirSynced + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchIsMSODirsynced_|**Get-Contact**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-User -Filter 'IsDirSynced -eq $true'`. + +## IsExcludedFromServingHierarchy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsExcludedFromServingHierarchy -eq $true'`. + +## IsHierarchyReady + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsHierarchyReady -eq $false'`. + +## IsHierarchySyncEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsHierarchySyncEnabled -eq $false'`. + +## IsInactiveMailbox + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsInactiveMailbox -eq $false'`. + +## IsLinked + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsLinked -eq $true'`. + +## IsMailboxEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsMailboxEnabled -eq $false'`. + +## IsResource + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsResource -eq $true'`. + +## IsSecurityPrincipal + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-User -Filter 'IsSecurityPrincipal -eq $false'`. + +## IsShared + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsShared -eq $true'`. + +## IsSoftDeletedByDisable + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsSoftDeletedByDisable -eq $true'`. + +## IsSoftDeletedByRemove + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'IsSoftDeletedByRemove -eq $true'`. + +## IssueWarningQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mDBStorageQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "IssueWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "IssueWarningQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.IssueWarningQuota - ''`". For example, `Get-Mailbox | where "$_.IssueWarningQuota -lt '50GB'"`. + +## JournalArchiveAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String| + +This property uses an SMTP email address. For example, `Get-Mailbox -Filter "JournalArchiveAddress -eq 'michelle@contoso.com'"`. + +## LanguagesRaw + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUserCulture_|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +This property is named **Languages** in the properties of a mailbox, and it contains the language preference for the mailbox in the format `-`. For example, United States English is `en-US`. For more information, see [CultureInfo Class](/dotnet/api/system.globalization.cultureinfo). + +You can specify multiple values separated by commas, but the order matters. For example, `Get-Mailbox -Filter "LanguagesRaw -eq 'en-US,es-MX'"` returns different results than `Get-Mailbox -Filter "LanguagesRaw -eq 'es-MX,en-US'"`. + +For single values, this multivalued property will return a match if the property _contains_ the specified value. + +## LastExchangeChangedTime + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchLastExchangeChangedTime_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Mailbox -Filter 'LastExchangeChangedTime -ne $null'`. + +## LegacyExchangeDN + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_legacyExchangeDN_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-User -Filter "LegacyExchangeDN -like 'Osca*'"`. + +You can find LegacyExchangeDN values for users by running this command: `Get-User | Format-List Name,LegacyExchangeDN` + +## LitigationHoldDate + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchLitigationHoldDate_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Mailbox -Filter "LitigationHoldDate -gt '8/13/2017'"`. + +## LitigationHoldEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'LitigationHoldEnabled -eq $true'`. + +## LitigationHoldOwner + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchLitigationHoldOwner_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +This property uses the user principal name of the litigation hold owner. For example, `Get-Mailbox -Filter "LitigationHoldOwner -eq 'agruber@contoso.com'"`. + +## LastName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_sn_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "LastName -like 'Martin*'"`. + +## MailboxContainerGUID + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxContainerGuid_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +For example, `Get-Mailbox -Filter 'MailboxContainerGUID -ne $null'`. + +## MailboxMoveBatchName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveBatchName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +This property includes the name of the migration batch. For example, `Get-Mailbox -Filter "MailboxMoveBatchName -like 'LocalMove 01*'"`. + +You can find the names of migration batches by running the **Get-MigrationBatch** command. Note that migration batches that you create in the Exchange admin center use the naming convention `MigrationService:`. + +## MailboxMoveFlags + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveFlags_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _Flags_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest#-flags).| + +For example, `Get-Mailbox -Filter "MailboxMoveFlags -ne 'None'"`. + +You can specify multiple values separated by commas, and the order doesn't matter. For example, `Get-Recipient -Filter "MailboxMoveFlags -eq 'IntraOrg,Pull'"` returns the same results as `Get-Recipient -Filter "MailboxMoveFlags -eq 'Pull,IntraOrg'"`. + +This multivalued property will only return a match if the property _equals_ the specified value. + +## MailboxMoveRemoteHostName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveRemoteHostName_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +For example, `Get-Mailbox -Filter 'MailboxMoveRemoteHostName -ne $null'`. + +## MailboxMoveSourceMDB + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveSourceMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the source mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveSourceMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## MailboxMoveStatus + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveStatus_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|For valid values, see the description of the _MoveStatus_ parameter in [Get-MoveRequest](/powershell/module/exchange/get-moverequest#-movestatus).| + +For example, `Get-Mailbox -Filter "MailboxMoveStatus -eq 'Completed'"`. + +## MailboxMoveTargetMDB + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxMoveTargetMDBLink_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|String or `$null`| + +This filter requires the distinguished name of the target mailbox database. For example, `Get-Mailbox -Filter "MailboxMoveTargetMDB -eq 'CN=MBX DB02,CN=Databases,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of mailbox databases by running this command: `Get-MailboxDatabase | Format-List Name,DistinguishedName`. + +## MailboxPlan + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchParentPlanLink_|**Get-Mailbox**|String or `$null`| + +Mailbox plans correspond to Microsoft 365 license types. The availability of a license plans is determined by the selections that you make when you enroll your domain. + +For example, `Get-Mailbox -Filter 'MailboxPlan -ne $null'`. + +## MailboxRelease + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxRelease_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-User**|`None`, `E14`, `E15`, or `$null`.| + +For example, `Get-Recipient -Filter 'MailboxRelease -ne $null'`. + +## MailTipTranslations + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSenderHintTranslations_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`| + +When you use this property in a filter, you need to account for the leading and trailing HTML tags. For example, `Get-DistributionGroup -Filter "MailTipTranslations -like 'is not monitored.*'"`. + +## ManagedBy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_managedBy_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the group owner (a mail-enabled security principal, which is a mailbox, mail user, or mail-enabled security group). For example, `Get-Mailbox -Filter "ManagedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "ManagedBy -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## ManagedFolderMailboxPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMailboxTemplateLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +Managed folder mailbox policies aren't available in Exchange 2013 or later. + +For example, `Get-Mailbox -Filter 'ManagedFolderMailboxPolicy -eq $null'`. + +This filter requires the distinguished name of the managed folder mailbox policy. For example, `Get-Mailbox -Filter "ManagedFolderMailboxPolicy -eq 'CN=MFM Inbox Policy,CN=ELC Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +You can find the distinguished names of managed folder mailbox policies on Exchange 2010 servers by running this command: `Get-ManagedFolderMailboxPolicy | Format-List Name,DistinguishedName`. + +## Manager + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_manager_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the manager (a mailbox or mail user). For example, `Get-User -Filter "Manager -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "Manager -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a manager, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName.` + +## MAPIEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'MAPIEnabled -eq $false'`. + +## MasterAccountSid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMasterAccountSid_|**Get-Mailbox**
**Get-LinkedUser**
**Get-Recipient**
**Get-SecurityPrincipal**
**Get-User**|String or `$null`| + +For example, `Get-Mailbox -Filter 'MasterAccountSid -ne $null'`. + +This value is blank ( `$null`) for mailboxes with associated user accounts, and `S-1-5-10` (Self) for mailboxes without associated user accounts (for example, shared mailboxes, resource mailboxes, discovery search mailboxes, arbitration mailboxes, and public folder mailboxes). + +## MaxBlockedSenders + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMaxBlockedSenders_|**Get-Mailbox**|Integer or `$null`| + +For example, `Get-Mailbox -Filter "MaxBlockedSenders -gt 0"`. + +## MaxReceiveSize + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_delivContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxReceiveSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxReceiveSize -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxReceiveSize -gt '50GB'"`. + +## MaxSafeSenders + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMaxSafeSenders_|**Get-Mailbox**|Integer or `$null`| + +For example, `Get-Mailbox -Filter "MaxSafeSenders -gt 0"`. + +## MaxSendSize + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_submissionContLength_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|A byte quantified size value (for example, `75MB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "MaxSendSize -eq 'Unlimited'"` or `Get-Mailbox -Filter "MaxSendSize -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.MaxReceiveSize - ''"`. For example, `Get-Mailbox | where "$_.MaxSendSize -gt '50GB'"`. + +## MemberDepartRestriction + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).| + +For example, `Get-DistributionGroup -Filter "MemberDepartRestriction -eq 'ApprovalRequired'"`. + +## MemberJoinRestriction + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchGroupDepartRestriction_|**Get-DistributionGroup**|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).| + +For example, `Get-DistributionGroup -Filter "MemberJoinRestriction -eq 'ApprovalRequired'"`. + +## MemberOfGroup + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_memberOf_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMMailbox**
**Get-User**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the distribution group or mail-enabled security group. For example, `Get-User -Filter "MemberOfGroup -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "MemberOfGroup -eq 'contoso.com/Users/Marketing Group'"`. + +To find the distinguished name of a group, replace _\_ with the name, alias, or email address of the group, and run this command: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## Members + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_member_|**Get-DistributionGroup**
**Get-Group**
**Get-Recipient**
**Get-SecurityPrincipal**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the group member. For example, `Get-Group -Filter "Members -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-User -Filter "Members -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a group member, replace _\_ with the name, alias, or email address of the group member, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## MobilePhone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mobile_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "MobilePhone -like '555*'"`. + +## ModeratedBy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchModeratedByLink_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String| + +This filter requires the distinguished name or canonical distinguished name of the group moderator (a mail-enabled security principal, which is a mailbox, mail-user, or mail-enabled security group). For example, `Get-DistributionGroup -Filter "ModeratedBy -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "ModeratedBy -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a mail-enabled security principal, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## ModerationEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchEnableModeration_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-DistributionGroup -Filter 'ModerationEnabled -eq $true'`. + +## Name + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_name_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted)| + +For example, `Get-User -Filter "Name -like 'Laura*'"`. + +## NetID + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-User**|String or `$null`| + +This property is populated for Exchange Online mailboxes in hybrid environments. A sample value is `1003BFFD9A0CFA03`. + +For example, `Get-User -Filter 'NetId -ne $null'`. + +## Notes + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_info_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**
**Get-UnifiedGroup**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Notes -like 'Events Team*'"`. + +## ObjectCategory + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_objectCategory_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String| + +This filter requires the canonical distinguished name of the object. The value uses the syntax `/Configuration/Schema/`. + +Valid _\_ values are: `Person` for mailboxes, mail users, and mail contacts, `Group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `ms-Exch-Public-Folder` for mail-enabled public folders, and `ms-Exch-Dynamic-Distribution-List` for dynamic distribution groups. + +For example, `Get-Recipient -Filter "ObjectCategory -eq 'contoso.com/Configuration/Schema/Group'"`. + +## ObjectClass + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_objectClass_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|String| + +The value of this property is `top, person, organizationalPerson, user` for mailboxes and mail users, `top, person, organizationalPerson, contact` for mail contacts, `top, group` for distribution groups, mail-enabled security groups and Microsoft 365 Groups, `msExchDynamicDistributionList` for dynamic distribution groups and `top, publicFolder` for mail-enabled public folders + +For example, `Get-Recipient -Filter "ObjectClass -eq 'Contact'"`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## Office + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_physicalDeliveryOfficeName_|**Get-Contact**
**Get-LinkedUser**
**Get-Mailbox**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Office -like '22*'"`. + +## OfflineAddressBook + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUseOAB_|**Get-Mailbox**|String or `$null`| + +This filter requires the distinguished name of the offline address book. For example, `Get-Mailbox -Arbitration -Filter "OfflineAddressBook -eq 'CN=OAB 1,CN=Offline Address Lists,CN=Address Lists Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"` + +You can find the distinguished names of offline address books by running this command: `Get-OfflineAddressBook | Format-List Name,DistinguishedName`. + +## OnPremisesObjectId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-MailPublicFolder**|String or `$null`| + +For example, `Get-MailPublicFolder -Filter 'OnPremisesObjectId -ne $null'`. + +## OperatorNumber + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMOperatorNumber_|**Get-UMMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-UMMailbox -Filter "OperatorNumber -eq 5"`. + +## OtherFax + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_otherFacsimileTelephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "OtherFax -like '206*'"`. + +## OtherHomePhone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_otherHomePhone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "OtherHomePhone -like '206*'"`. + +## OtherTelephone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_otherTelephone_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "OtherTelephone -like '206*'"`. + +## OWAEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +The filter operates backwards. For example, `Get-CASMailbox -Filter 'OWAEnabled -eq $true'` returns mailboxes where the **OWAEnabled** property is `False`, and `Get-CASMailbox -Filter 'OWAEnabled -eq $false'` returns mailboxes where the **OWAEnabled** property is `True` + +## OWAforDevicesEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchOmaAdminWirelessEnable_|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'OWAForDevicesEnabled -eq $true'`. + +## OWAMailboxPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchOWAPolicy_|**Get-CASMailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the Outlook on the web mailbox policy (formerly known as an Outlook Web App mailbox policy). For example, `Get-CASMailbox -Filter "OWAMailboxPolicy -eq 'CN=Default,CN=OWA Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com`'". + +You can find the distinguished names of Outlook on the web mailbox policies by running this command: `Get-OwaMailboxPolicy | Format-List Name,DistinguishedName`. + +## Pager + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_pager_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Pager -like '206*'"`. + +## PersistedCapabilities + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String or `$null`| + +Typically, the value of this property something other than `$null` (blank) for Microsoft 365 accounts and mailboxes. For more information about the valid property values, see [Capability enumeration](/previous-versions/office/exchange-server-api/ff441134(v=exchg.150)). + +For example, `Get-Mailbox -Filter 'PersistedCapabilities -ne $null'`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## Phone + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_telephoneNumber_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Phone -like '206*'"`. + +## PhoneProviderId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMPhoneProvider_|**Get-UMMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-UMMailbox -Filter "PhoneProviderId -like '206*'"`. + +## PhoneticDisplayName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msDS-PhoneticDisplayName_|**Get-Contact**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-MailPublicFolder**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "PhoneticDisplayName -like 'Lila*'"`. + +## PoliciesExcluded + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPoliciesExcluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +For example, `Get-Recipient -Filter 'PoliciesExcluded -ne $null'`. + +## PoliciesIncluded + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPoliciesIncluded_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +For example, `Get-Recipient -Filter 'PoliciesIncluded -eq $null'`. + +## PopEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-CASMailbox -Filter 'POPEnabled -eq $false'`. + +## PostalCode + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_postalCode_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "PostalCode -eq 90210"`. + +## PostOfficeBox + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_postOfficeBox_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "PostOfficeBox -like '555*'"`. + +## PreviousRecipientTypeDetails + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchPreviousRecipientTypeDetails_|**Get-LinkedUser**
**Get-User**|String or `$null`| + +For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient#-recipienttypedetails). + +For example, `Get-User -Filter 'PreviousRecipientTypeDetails -ne $null'`. + +## PrimarySmtpAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-UnifiedGroup**|String (wildcards accepted)| + +Don't use the _PrimarySmtpAddress_ property; use the _EmailAddresses_ property instead. Any filter that uses the _PrimarySmtpAddress_ property will also search values in the _EmailAddresses_ property. For example, if a mailbox has the primary email address dario@contoso.com, and the additional proxy addresses dario2@contoso.com and dario3@contoso.com, all of the following filters will return that mailbox in the result: `"PrimarySmtpAddress -eq 'dario@contoso.com'"`, `"PrimarySmtpAddress -eq 'dario2@contoso.com'"`, or `"PrimarySmtpAddress -eq 'dario3@contoso.com'"`. + +## ProhibitSendQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mDBOverQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendQuota -lt '70GB'"`. + +## ProhibitSendReceiveQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mDBOverHardQuotaLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "ProhibitSendReceiveQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "ProhibitSendReceiveQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.ProhibitSendReceiveQuota - ''"`. For example, `Get-Mailbox | where "$_.ProhibitSendReceiveQuota -lt '70GB'"`. + +## ProtocolSettings + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_protocolSettings_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +The default value of this property on mailboxes is `RemotePowerShell§1`. This property is populated with additional values when you use Set-CASMailbox to disable protocols (for example, POP3 or IMAP4). + +For example, `Get-Mailbox -Filter "ProtocolSettings -like 'POP3*'"`. + +## PublicFolderContacts + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_pFContacts_|**Get-MailPublicFolder**|String or `$null`| + +This property is displayed as **Contacts** in the results of the command `Get-MailPublicFolder -Identity | Format-List`, but you need to use the property name **PublicFolderContacts** in the filter. + +This filter requires the distinguished name or canonical distinguished name of the public folder contact. For example, `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'CN=Angela Gruber,CN=Users,DC=contoso,DC=com'"` or `Get-MailPublicFolder -Filter "PublicFolderContacts -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of a public folder contact, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## QueryBaseDN + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchQueryBaseDN_|**Get-Mailbox**|String or `$null`| + +This property was used in Exchange 2007 global address list segregation to specify a location in Active Directory. This feature was replaced by address book policies in Exchange 2010 Service Pack 2, so the value of this property should always be blank ( `$null`). + +For example, `Get-Mailbox -Filter 'QueryBaseDN -ne $null'`. + +## RecipientContainer + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDynamicDLBaseDN_|**Get-DynamicDistributionGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the organizational unit or container in Active Directory. For example, `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'CN=Users,DC=contoso,DC=com'"` or `Get-DynamicDistributionGroup -Filter "RecipientContainer -eq 'contoso.com/Users'"` + +To find the distinguished names or canonical distinguished names of organizational units and containers in Active Directory, run this command: `Get-OrganizationalUnit -IncludeContainers | Format-List Name,DistinguishedName,ID`. + +## RecipientLimits + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRecipLimit_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Integer or `Unlimited`| + +For example, `Get-Mailbox -Filter "RecipientLimits -ne 'Unlimited'"`. + +## RecipientType + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|`DynamicDistributionGroup`, `MailContact`, `MailNonUniversalGroup`, `MailUniversalDistributionGroup`, `MailUniversalSecurityGroup`, `MailUser`, `PublicFolder` or `UserMailbox`| + +For example, `Get-Recipient -Filter "RecipientType -eq 'MailContact'"`. + +## RecipientTypeDetails + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-User**
**Get-UnifiedGroup**|String| + +For valid values, see the description of the _RecipientTypeDetails_ parameter in [Get-Recipient](/powershell/module/exchange/get-recipient#-recipienttypedetails). + +For example, `Get-Recipient -Filter "RecipientTypeDetails -eq 'SharedMailbox'"`. + +## RecoverableItemsQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDumpsterQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsQuota - ''`. For example, `Get-Mailbox | where "$_.RecoverableItemsQuota -gt '35GB'"`. + +## RecoverableItemsWarningQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchDumpsterWarningQuota_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A byte quantified size value (for example, `300MB` or `1.5GB`), or `Unlimited`. Unqualified values are treated as bytes.| + +You can only use the _Filter_ parameter to look for the value `Unlimited` for this property. For example, `Get-Mailbox -Filter "RecoverableItemsWarningQuota -eq 'Unlimited'"` or `Get-Mailbox -Filter "RecoverableItemsWarningQuota -ne 'Unlimited'"`. + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RecoverableItemsWarningQuota - ''`". For example, `Get-Mailbox | where "$_.RecoverableItemsWarningQuota -gt '25GB'"`. + +## RejectMessagesFrom + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_unauthOrig_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name of the individual recipient (a mailbox, mail user, or mail contact). For example, `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'CN=Yuudai Uchida,CN=Users,DC=contoso,DC=com'"` or `Get-DistributionGroup -Filter "RejectMessagesFrom -eq 'contoso.com/Users/Angela Gruber'"`. + +To find the distinguished name of the individual recipient, replace _\_ with the name, alias, or email address of the recipient, and run this command: `Get-Recipient -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## RejectMessagesFromDLMembers + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_dLMemRejectPerms_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UnifiedGroup**|String or `$null`| + +This filter requires the distinguished name or canonical distinguished name of the group (a distribution group, mail-enabled security group, or dynamic distribution group). For example, `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'CN=Marketing Department,CN=Users,DC=contoso,DC=com'"` or `Get-Mailbox -Filter "RejectMessagesFromDLMembers -eq 'contoso.com/Users/Marketing Department'"`. + +To find the distinguished name of the group, replace _\_ with the name, alias, or email address of the group, and run one of these commands: `Get-DistributionGroup -Identity "" | Format-List Name,DistinguishedName` or `Get-DynamicDistributionGroup -Identity "" | Format-List Name,DistinguishedName`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## RemoteAccountPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSyncAccountsPolicyDN_|**Get-Mailbox**|String or `$null`| + +This filter requires the distinguished name of the remote account policy. For example, `Get-Mailbox -Filter "RemoteAccountPolicy -eq 'CN=Contoso Remote Account Policy,CN=Remote Accounts Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +## RemotePowerShellEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-User**|Boolean (`$true` or `$false`)| + +For example, `Get-User -Filter 'RemotePowerShellEnabled -eq $false'`. + +## RemoteRecipientType + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRemoteRecipientType_|**Get-Mailbox**
**Get-RemoteMailbox**|`None` (0), `ProvisionMailbox` (1), `ProvisionArchive` (2), `Migrated` (4), `DeprovisionMailbox` (8), `DeprovisionArchive` (16), `RoomMailbox` (32), `EquipmentMailbox` (64), `SharedMailbox` (96), `TeamMailbox` (128), or `$null`.| + +For example, `Get-RemoteMailbox -Filter "RemoteRecipientType -eq 'ProvisionMailbox'"`. + +## ReportToManagerEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_reportToOwner_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-DistributionGroup -Filter 'ReportToManagerEnabled -eq $true'`. + +## ReportToOriginatorEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_reportToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-DistributionGroup -Filter 'ReportToOriginatorEnabled -eq $false'`. + +## RequireAllSendersAreAuthenticated + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRequireAuthToSendTo_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**|Boolean (`$true` or `$false`)| + +This property is displayed as **RequireSenderAuthenticationEnabled** in the results of the command `Get- -Identity | Format-List`, but you need to use the property name **RequireAllSendersAreAuthenticated** in the filter. For example, `Get-DistributionGroup -Filter 'RequireAllSendersAreAuthenticated -eq $false'`. + +## ResourceBehaviorOptions + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-UnifiedGroup**|`AllowOnlyMembersToPost`, `CalendarMemberReadOnly`, `ConnectorsEnabled`, `HideGroupInOutlook`, `NotebookForLearningCommunitiesEnabled`, `ReportToOriginator`, `SharePointReadonlyForMembers`, `SubscriptionEnabled`, `SubscribeMembersToCalendarEvents`, `SubscribeMembersToCalendarEventsDisabled`, `SubscribeNewGroupMembers`, `WelcomeEmailDisabled`, `WelcomeEmailEnabled`, or `$null`| + +For example, `Get-UnifiedGroup -Filter "ResourceBehaviorOptions -eq 'CalendarMemberReadOnly'"` + +## ResourceCapacity + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchResourceCapacity_|**Get-Mailbox**|Integer or `$null`| + +For example, `Get-Mailbox -Filter "ResourceCapacity -gt 15"` + +## ResourceCustom + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|String or `$null`| + +You create custom resource properties by using the Set-ResourceConfig cmdlet. For example, `Set-ResourceConfig -ResourcePropertySchema Room/Whiteboard,Equipment/Van`. After you create the properties, you can assign them to room or equipment mailboxes. For example, `Set-Mailbox -Identity "Conference Room 1" -ResourceCustom Whiteboard`. + +When you search for values, use the custom resource property that's assigned to the room or equipment mailbox. For example, `Get-Mailbox -Filter "ResourceCustom -eq 'Whiteboard'"`. + +## ResourceProvisioningOptions + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-UnifiedGroup**|`Team` or `$null`| + +For example, `Get-UnifiedGroup -Filter "ResourceProvisioningOptions -eq 'Team'"` + +## ResourceType + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-Recipient**|`Room` (0), `Equipment` (1), or `$null`| + +For example, `Get-Mailbox -Filter "ResourceType -eq 'Equipment'"` + +## RetainDeletedItemsFor + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_garbageCollPeriod_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|A time span value: _dd.hh:mm:ss_ where _dd_ = days, _hh_ = hours, _mm_ = minutes, and _ss_ = seconds.| + +You can't use the _Filter_ parameter to look for time span values for this property. Instead, use this syntax: `Get-Mailbox | where "$_.RetainDeletedItemsFor - ''"`. For example, `Get-Mailbox | where "$_.RetainDeletedItemsFor -gt '14.00:00:00'"`. + +## RetentionComment + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRetentionComment_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "RetentionComment -like '7 years*'"` + +## RetentionPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the retention policy. For example, `Get-Mailbox -Filter "RetentionPolicy -eq 'CN=Default MRM Policy,CN=Retention Policies Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of retention policies, run this command: `Get-RetentionPolicy | Format-List Name,DistinguishedName`. + +## RetentionUrl + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRetentionURL_|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "RetentionUrl -like 'https://intranet.contoso.com/*'"` + +## RoleAssignmentPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchRBACPolicyLink_|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +This filter requires the distinguished name of the role assignment policy in Exchange Online. For example, `Get-Mailbox -Filter "RoleAssignmentPolicy -eq 'CN=Default Role Assignment Policy,CN=Policies,CN=RBAC,CN=Configuration,CN=contoso.onmicrosoft.com,CN=ConfigurationUnits,DC=NAMPR10A001,DC=PROD,DC=OUTLOOK,DC=COM'"`. + +To find the distinguished names of role assignment policies in Exchange Online, run this command: `Get-RoleAssignmentPolicy | Format-List Name,DistinguishedName`. + +## RulesQuota + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMDBRulesQuota_|**Get-Mailbox**|A byte quantified size value (for example, `50B` or `128KB`). Unqualified values are treated as bytes.| + +You can't use the _Filter_ parameter to look for size values of this property. Instead, use this syntax: `Get-Mailbox | where "$_.RulesQuota - ''"`. For example, `Get-Mailbox | where "$_.RulesQuota -lt '256KB'"`. + +## SafeRecipientsHash + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSafeRecipientsHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.| + +Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeRecipientsHash -ne $null'.` + +## SafeSendersHash + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSafeSendersHash_|**Get-Recipient**|Blank ( `$null`) or a hashed value.| + +Realistically, you can only use this value to filter on blank or non-blank values. For example, `Get-Recipient -Filter 'SafeSendersHash -ne $null'.` + +## SamAccountName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_SamAccountName_|**Get-CASMailbox**
**Get-DistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Recipient -Filter "SamAccountName -like 'laura*'"` + +## SCLDeleteThresholdInt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMessageHygieneSCLDeleteThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`| + +This property is displayed as **SCLDeleteThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLDeleteThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLDeleteThresholdInt -ge -2147483640"`. + +## SCLJunkThresholdInt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMessageHygieneSCLJunkThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`| + +This property is displayed as **SCLJunkThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLJunkThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLJunkThresholdInt -ge -2147483645"`. + +## SCLQuarantineThresholdInt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMessageHygieneSCLQuarantineThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`| + +This property is displayed as **SCLQuarantineThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLQuarantineThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLQuarantineThresholdInt -ge -2147483643"`. + +## SCLRejectThresholdInt + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchMessageHygieneSCLRejectThreshold_|**Get-Mailbox**|-2147483648 (SCL value 0), -2147483647 (SCL value 1), -2147483646 (SCL value 2), -2147483645 (SCL value 3), -2147483644 (SCL value 4), -2147483643 (SCL value 5), -2147483642 (SCL value 6), -2147483641 (SCL value 7), -2147483640 (SCL value 8), -2147483639 (SCL value 9) or `$null`| + +This property is displayed as **SCLRejectThreshold** in the results of the command `Get-Mailbox -Identity | Format-List`, but you need to use the property name **SCLRejectThresholdInt** in the filter. For example, `Get-Mailbox -Filter "SCLRejectThresholdInt -ge -2147483641"`. + +## SendOofMessageToOriginatorEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_oOFReplyToOriginator_|**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-UnifiedGroup**|Boolean (`$true` or `$false`)| + +For example, `Get-DistributionGroup -Filter 'SendOofMessageToOriginatorEnabled -eq $true'`. + +## ServerLegacyDN + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchHomeServerName_|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "ServerLegacyDN -like 'Mailbox01'"`. + +This is an example of a complete **ServerLegacyDN** value: `/o=Contoso Corporation/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01`. + +## ServerName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|String or `$null`| + +For example, `Get-Recipient -Filter "ServerName -eq 'Mailbox01'"`. + +## SharingPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchSharingPolicyLink_|**Get-Mailbox**
**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the sharing policy. For example, `Get-Mailbox -Filter "SharingPolicy -eq 'CN=Custom Sharing Policy,CN=Federation,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of sharing policies, run this command: `Get-SharingPolicy | Format-List Name,DistinguishedName`. + +> [!NOTE] +> For the default assignment of the default sharing policy (named Default Sharing Policy) to a mailbox, the value of the **SharingPolicy** property is blank (`$null`). + +## Sid + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_objectSid_|**Get-Group**
**Get-LinkedUser**
**Get-SecurityPrincipal**
**Get-User**|String| + +For example, `Get-User -Filter "Sid -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`. + +## SidHistory + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_SIDHistory_|**Get-Group**
**Get-LinkedUser**
**Get-User**|String or `$null`| + +For example, `Get-User -Filter "SidHistory -eq 's-1-5-21-3628364307-1600040346-819251021-2603'"`. + +## SimpleDisplayName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_displayNamePrintable_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "SimpleDisplayName -like 'lila*'"`. + +## SingleItemrecoveryEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'SingleItemRecoveryEnabled -eq $true'`. + +## SKUAssigned + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|Boolean (`$true` or `$false`) or `$null`.| + +For example, `Get-User -Filter 'SKUAssigned -eq $true'`. + +## SourceAnchor + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter 'SourceAnchor -ne $null'`. + +## StateOrProvince + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_st_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "StateOrProvince -like 'Carolina*'"`. + +## StreetAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_streetAddress_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "StreetAddress -like '36th Ave NE*'"`. + +## StsRefreshTokensValidFrom + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchStsRefreshTokensValidFrom_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|`$null` or a date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-User -Filter "StsRefreshTokensValidFrom -gt '8/1/2017'"`. + +## TelephoneAssistant + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_telephoneAssistant_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "TelephoneAssistant -like '206*'"`. + +## ThrottlingPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchThrottlingPolicyDN_|**Get-Mailbox**|String or `$null`| + +This filter requires the distinguished name of the throttling policy. For example, `Get-Mailbox -Filter "ThrottlingPolicy -eq 'CN=Custom Throttling Policy,CN=Global Settings,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of throttling policies, run this command: `Get-ThrottlingPolicy | Format-List Name,DistinguishedName`. + +## Title + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_title_|**Get-Contact**
**Get-LinkedUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "Title -eq 'Dr.'"`. + +## UMAddresses + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMAddresses_|**Get-UMMailbox**|String (wildcards accepted) or `$null`| + +For example, `Get-UMMailbox -Filter 'UMAddresses -ne $null'`. + +## UMCallingLineIds + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMCallingLineIds_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "UMCallingLineIds -like '123*'"`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## UMDtmfMap + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMDtmfMap_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-UMMailbox**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "UMDtmfMap -like '26297*'"`. + +Although this property is multi-valued, the filter returns a match if the property _contains_ the specified value. + +## UMEnabled + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-Mailbox**
**Get-Recipient**
**Get-UMMailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'UMEnabled -eq $true'`. + +## UMMailboxPolicy + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMTemplateLink_|**Get-Recipient**
**Get-UMMailbox**|String or `$null`| + +This filter requires the distinguished name of the UM mailbox policy. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Default Policy,CN=UM Mailbox Policies,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of UM mailbox policies, run this command: `Get-UMMailboxPolicy | Format-List Name,DistinguishedName`. + +## UMRecipientDialPlanId + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUMRecipientDialPlanLink_|**Get-Recipient**|String or `$null`| + +This filter requires the distinguished name of the UM dial plan. For example, `Get-Recipient -Filter "UMMailboxPolicy -eq 'CN=Contoso Dial Plan,CN=UM DialPlan Container,CN=Contoso Corporation,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com'"`. + +To find the distinguished names of UM dial plans, run this command: `Get-UMDialPlan | Format-List Name,DistinguishedName`. + +## UpgradeRequest + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-User**|`None` (0), `TenantUpgrade` (1), `PrestageUpgrade` (2), `CancelPrestageUpgrade` (3), `PilotUpgrade` (4), or `TenantUpgradeDryRun` (5),| + +For example, `Get-User -Filter "UpgradeRequest -ne 'None'"`. + +## UpgradeStatus + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-User**|`None` (0), `NotStarted` (1), `InProgress` (2), `Warning` (3), `Error` (4), `Cancelled` (5), `Complete` (6), or `ForceComplete` (7).| + +For example, `Get-User -Filter "UpgradeStatus -ne 'None'"`. + +## UsageLocation + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUsageLocation_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**|String or `$null`| + +This filter requires the ISO 3166-1 country name (for example, `United States`), or two-letter country code (for example `US`) for the user in Microsoft 365. For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html). + +For example, `Get-Recipient -Filter 'UsageLocation -eq "US"'`. + +## UseDatabaseQuotaDefaults + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mDBUseDefaults_|**Get-Mailbox**|Boolean (`$true` or `$false`)| + +For example, `Get-Mailbox -Filter 'UseDatabaseQuotaDefaults -eq $false'`. + +## UserAccountControl + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_userAccountControl_|**Get-LinkedUser**
**Get-User**|`AccountDisabled`, `DoNotExpirePassword`, or `NormalAccount`| + +For example, `Get-User -Filter "UserAccountControl -eq 'NormalAccount'"`. + +You can specify multiple values separated by commas, but the order matters. For example, `Get-User -Filter "UserAccountControl -eq 'AccountDisabled,NormalAccount'"` returns different results than `Get-User -Filter "UserAccountControl -eq 'NormalAccount,AccountDisabled'"`. + +This multivalued property will only return a match if the property _equals_ the specified value. + +## UserPrincipalName + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_userPrincipalName_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted)| + +For example, `Get-User -Filter "UserPrincipalName -like 'julia@*'"`. + +## VoiceMailSettings + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchUCVoiceMailSettings_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String or `$null`| + +For example, `Get-User -Filter 'VoiceMailSettings -ne $null'`. + +## WebPage + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_wWWHomePage_|**Get-Contact**
**Get-LinkedUser**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-User -Filter "WebPage -like 'https://intranet.contoso.com/*'"`. + +## WhenChanged + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_WhenChanged_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenChanged -gt '8/1/2017 2:00:00 PM'"`. + +## WhenChangedUTC + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenChangedUTC -gt '8/1/2017 2:00:00 PM'"`. + +## WhenCreated + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_whenCreated_|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenCreated -gt '8/1/2017 2:00:00 PM'"`. + +## WhenCreatedUTC + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|n/a|**Get-CASMailbox**
**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**
**Get-SecurityPrincipal**
**Get-UMMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenCreatedUTC -gt '8/1/2017 2:00:00 PM'"`. + +## WhenMailboxCreated + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchWhenMailboxCreated_|**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-RemoteMailbox**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +For example, `Get-Recipient -Filter "WhenMailboxCreated -gt '8/1/2017 2:00:00 PM'"`. + +## WhenSoftDeleted + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchWhenSoftDeletedTime_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**
**Get-UnifiedGroup**|A date/time value: 64-bit value representing the number of 100-nanosecond intervals since January 1, 1601 (UTC)| + +This filter requires the _SoftDeleted_ switch in the command for mailboxes. + +For example, `Get-Mailbox -SoftDeletedMailbox -Filter "WhenSoftDeleted -gt '8/1/2017 2:00:00 PM'"`. + +## WindowsEmailAddress + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_mail_|**Get-Contact**
**Get-DistributionGroup**
**Get-DynamicDistributionGroup**
**Get-Group**
**Get-LinkedUser**
**Get-Mailbox**
**Get-MailContact**
**Get-MailPublicFolder**
**Get-MailUser**
**Get-RemoteMailbox**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.com*'"`. + +## WindowsLiveID + +|LDAP display name|Available on cmdlets|Value| +|---|---|---| +|_msExchWindowsLiveID_|**Get-LinkedUser**
**Get-Mailbox**
**Get-MailUser**
**Get-Recipient**
**Get-User**|String (wildcards accepted) or `$null`| + +For example, `Get-Mailbox -Filter "WindowsEmailAddress -like '@fabrikam.onmicrosoft.com*'"`.| ## For more information -Exchange Server 2007 was the first version of Exchange that required OPATH filters instead of LDAP filters. For more information about converting LDAP filters to OPATH filters, see the Microsoft Exchange Team Blog article, [Need help converting your LDAP filters to OPATH?](https://techcommunity.microsoft.com/t5/exchange-team-blog/need-help-converting-your-ldap-filters-to-opath/ba-p/595108). +Exchange 2007 was the first version of Exchange that required OPATH filters instead of LDAP filters. For more information about converting LDAP filters to OPATH filters, see the Microsoft Exchange Team Blog article, [Need help converting your LDAP filters to OPATH?](https://techcommunity.microsoft.com/t5/exchange-team-blog/need-help-converting-your-ldap-filters-to-opath/ba-p/595108). diff --git a/exchange/docs-conceptual/filters-v2.md b/exchange/docs-conceptual/filters-v2.md index b83bba3785..aae21efdc2 100644 --- a/exchange/docs-conceptual/filters-v2.md +++ b/exchange/docs-conceptual/filters-v2.md @@ -1,52 +1,52 @@ --- -title: Filters in the EXO V2 module +title: Filters in the Exchange Online PowerShell module ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 9/1/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -ms.reviewer: navgupta -localization_priority: Priority +ms.reviewer: +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn about how to use filtering for cmdlets in the Exchange Online V2 module." +description: "Learn about how to use filtering for cmdlets in the Exchange Online V2 module and V3 module." --- -# Filters in the EXO V2 module +# Filters in the Exchange Online PowerShell module -The Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module) contains a few exclusive cmdlets that are optimized for high speed, high volume operations, and (after you connect to your organization) gives you access to the hundreds of existing cmdlets in the service. For more information, see [About the Exchange Online PowerShell V2 module](exchange-online-powershell-v2.md). +The Exchange Online PowerShell module contains nine exclusive **Get-EXO\*** cmdlets that are optimized for high speed, high volume operations, and (after you connect to your organization) gives you access to the hundreds of existing cmdlets in the service. For more information, see [Cmdlets in the Exchange Online PowerShell module](exchange-online-powershell-v2.md#cmdlets-in-the-exchange-online-powershell-module). -In order to get the most out of the EXO V2 module, you need to follow the guidance in this article. +In order to get the most out of filters in the nine exclusive **Get-EXO\*** cmdlets in the module, you need to follow the guidance in this article. -## Use client-side filtering for the best performance +> [!TIP] +> Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). -Server-side filtering uses the available _Filter_ or _RecipientFilter_ parameters on a cmdlet. Client-side filtering uses the [Where-Object](/powershell/module/microsoft.powershell.core/where-object) cmdlet (also known as **where** or **?**). +## Use client-side filtering for the best performance -Generally, you get much better performance in PowerShell cmdlets with server-side filtering. However, for the EXO V2 module, you actually get better performance when you use client-side filtering. We're working on improving the performance of server-side filtering in the module. +Server-side filtering uses the available _Filter_ or _RecipientFilter_ parameters on a cmdlet. -## Supported and unsupported attributes +Client-side filtering uses the [Where-Object](/powershell/module/microsoft.powershell.core/where-object) cmdlet (also known as **where** or **?**). -Although the EXO V2 module supports the majority of filterable attributes, the following attributes are currently not supported for filtering: +Generally, you get much better performance in Exchange PowerShell cmdlets with server-side filtering. However, for the Exchange Online PowerShell module, you actually get better performance when you use client-side filtering. We're working on improving the performance of server-side filtering in the module. -
+## Unsupported filterable properties -**** +The **Get-EXO\*** cmdlets in the module support the majority of [filterable properties](filter-properties.md) that are available in their older, equivalent cmdlets. But, there are currently some properties that don't work with filtering in the **Get-EXO\*** cmdlets. These properties are described in the following table: -|Cmdlet|Attribute|LDAP Display Name| +|Cmdlet|Unsupported filterable property|LDAP Display Name| |---|---|---| -|[Get-CASMailbox](/powershell/module/exchange/get-casmailbox)|MemberOfGroup

ExternalDirectoryObjectId|memberOf

msExchExternalDirectoryObjectId| -|[Get-Mailbox](/powershell/module/exchange/get-mailbox)|DeletedItemFlags

ExternalDirectoryObjectId

LanguagesRaw

MasterAccountSid

MemberOfGroup

RequireAllSendersAreAuthenticated

SCLDeleteThresholdInt

SCLJunkThresholdInt

SCLQuarantineThresholdInt

SCLRejectThresholdInt|deletedItemFlags

msExchExternalDirectoryObjectId

msExchUserCulture

msExchMasterAccountSid

memberOf

msExchRequireAuthToSendTo

msExchMessageHygieneSCLDeleteThreshold

msExchMessageHygieneSCLJunkThreshold

msExchMessageHygieneSCLQuarantineThreshold

msExchMessageHygieneSCLRejectThreshold| -|[Get-Recipient](/powershell/module/exchange/get-recipient)|CountryCode

ExternalDirectoryObjectId

MasterAccountSid

MemberOfGroup

Members|countryCode

msExchExternalDirectoryObjectId

msExchMasterAccountSid

memberOf

member| -| +|[Get-EXOCASMailbox](/powershell/module/exchange/get-exocasmailbox)|MemberOfGroup

ExternalDirectoryObjectId|memberOf

msExchExternalDirectoryObjectId| +|[Get-EXOMailbox](/powershell/module/exchange/get-exomailbox)|DeletedItemFlags

LanguagesRaw

MasterAccountSid

MemberOfGroup

RequireAllSendersAreAuthenticated

SCLDeleteThresholdInt

SCLJunkThresholdInt

SCLQuarantineThresholdInt

SCLRejectThresholdInt|deletedItemFlags

msExchUserCulture

msExchMasterAccountSid

memberOf

msExchRequireAuthToSendTo

msExchMessageHygieneSCLDeleteThreshold

msExchMessageHygieneSCLJunkThreshold

msExchMessageHygieneSCLQuarantineThreshold

msExchMessageHygieneSCLRejectThreshold| +|[Get-EXORecipient](/powershell/module/exchange/get-exorecipient)|CountryCode

ExternalDirectoryObjectId

MasterAccountSid

MemberOfGroup

Members|countryCode

msExchExternalDirectoryObjectId

msExchMasterAccountSid

memberOf

member| -## Supported and unsupported operators +## Supported operators -The following operators are fully supported for all string formats in the EXO V2 module: +The following operators are fully supported for all string formats in the **Get-EXO\*** cmdlets in the Exchange Online PowerShell module: - [Logical operators](/powershell/module/microsoft.powershell.core/about/about_logical_operators): - `-and` diff --git a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md index b040d607c5..e19393384e 100644 --- a/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md +++ b/exchange/docs-conceptual/find-exchange-cmdlet-permissions.md @@ -2,13 +2,13 @@ title: "Find the permissions required to run any Exchange cmdlet" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 06/06/2024 ms.audience: ITPro audience: ITPro ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5bcc46d3-8a07-4e9f-b1b0-e4cb0b0afc12 description: "Admins can learn how to use PowerShell to find the permissions required to run any cmdlet in Exchange Server PowerShell or Exchange Online PowerShell." --- @@ -17,26 +17,41 @@ description: "Admins can learn how to use PowerShell to find the permissions req You can use PowerShell to find the permissions required to run any Exchange or Exchange Online cmdlet. This procedure shows the role-based access control (RBAC) management roles and role groups that give you access to a specified cmdlet—even if your organization has custom roles, custom role groups, or custom role assignments. +> [!TIP] +> Currently, the procedures in this article don't work with Microsoft 365 Group cmdlets (**\*-UnifiedGroup**) in Exchange Online PowerShell. + ## What do you need to know before you begin? - Estimated time to complete this procedure: less than 5 minutes. - You can only use PowerShell to perform these procedures. -- Basically, you need to be an administrator to complete this procedure. Specifically, you need access to the **Get-ManagementRole** and **Get-ManagementRoleAssignment** cmdlets. By default, access to these cmdlets is granted by the **View-Only Configuration** or **Role Management** roles, which are only assigned to the **View-Only Organization Management** and **Organization Management** role groups by default. - -- The procedures in this article don't work in Security & Compliance Center PowerShell or standalone Exchange Online Protection (EOP) PowerShell (Microsoft 365 organizations without Exchange Online mailboxes). For more information about permissions in these environments, see the following articles: - - [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) - - [Permissions in the Microsoft 365 security center](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - - [Permissions in standalone EOP](/microsoft-365/security/office-365-security/feature-permissions-in-eop). - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) or [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542). +- The procedures in this article don't work in Security & Compliance PowerShell. For more information about Security & Compliance permissions, see the following articles: + - [Permissions in the Microsoft Defender portal](/defender-office-365/mdo-portal-permissions) + - [Permissions in the Microsoft Purview compliance portal](/purview/purview-compliance-portal-permissions) + +- You need to be assigned permissions before you can do the procedures in this article. You have the following options: + - [Exchange Server permissions](/exchange/permissions/permissions): Membership in one of the following role groups: + - **Compliance Management** + - **Hygiene Management** + - **Organization Management** + - **View-Only Organization Management** + - [Exchange Online permissions](/exchange/permissions-exo/permissions-exo): Membership in one of the following role groups: + - **Compliance Management** + - **Delegated Setup** + - **Hygiene Management** + - **Organization Management** + - **View-Only Organization Management** + - [Microsoft Entra permissions](/entra/identity/role-based-access-control/manage-roles-portal): Membership in the **Global Administrator**\* or **Global Reader** roles gives users the required permissions _and_ permissions for other features in Microsoft 365. + + > [!IMPORTANT] + > \* Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. ## Use PowerShell to find the permissions required to run a cmdlet 1. If you haven't already, open the Exchange PowerShell environment that you're interested in: - **Exchange Online**: [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). + - **Exchange Online Protection** (Microsoft 365 organizations without Exchange Online mailboxes): [Connect to Exchange Online Protection PowerShell](connect-to-exchange-online-protection-powershell.md). - **Exchange Server**: [Open the Exchange Management Shell](open-the-exchange-management-shell.md) or [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md). 2. Replace `` and optionally, `,,...` with the values that you want to use, and run the following command: @@ -45,7 +60,8 @@ You can use PowerShell to find the permissions required to run any Exchange or E $Perms = Get-ManagementRole -Cmdlet [-CmdletParameters ,,...] ``` - **Note**: If you specify multiple parameters, only roles that include the cmdlet with **all** of the parameters are returned. + > [!TIP] + > If you specify multiple parameters, only roles that include _all_ of the specified parameters on the cmdlet are returned. 3. Run the following command: @@ -57,7 +73,7 @@ You can use PowerShell to find the permissions required to run any Exchange or E The results contain the following information: -- **Role**: Indicates the role that gives access to the cmdlet or the combination of cmdlet and parameters. Note that role names that begin with "My" are user roles that allow regular users to operate on objects they own (for example, their own mailbox or their distribution groups). +- **Role**: Indicates the role that gives access to the cmdlet or the combination of cmdlet and parameters. Role names that begin with "My" are user roles that allow regular users to operate on objects they own (for example, their own mailbox or their distribution groups). - **RoleAssigneeType** and **RoleAssigneeName**: These values are inter-related: - **RoleAssigneeType** is the type of object that has the role assigned to it. For administrator roles, this value is typically a role group, but it can also be a role assignment policy, a security group, or a user. @@ -68,8 +84,10 @@ The results contain the following information: What if there are no results? - Verify that you entered the cmdlet and parameter names correctly. - -- The parameters that you specified are actually available for a cmdlet in a single role. Try specifying only the cmdlet name in the first command before you run the second command. Then, add the parameters one at a time to the first command before you run the second command. +- Multiple parameters for a cmdlet might not be defined in a single role (some parameters might be in one role, while the others are in a different role). Take it one step at a time: + - Run the first command with no parameters, and then run the second command. + - Add one parameter to the first command, and then run the second command. + - Repeat the previous step by adding other parameters to the first command before running the second command. Otherwise, no results are likely caused by one of the following conditions: @@ -79,10 +97,11 @@ Otherwise, no results are likely caused by one of the following conditions: To find the roles in your environment (if any) that contain the cmdlet or parameters, replace `` and optionally, `,,...` with the values that you want to use and run the following command: ```powershell -Get-ManagementRoleEntry -Identity *\ [-Parameters ,,...] +Get-ManagementRoleEntry -Identity *\ [-Parameters ,,...] ``` -**Note**: You can use wildcard characters (*) in the cmdlet and parameter names (for example, `*-Mailbox*`). +> [!TIP] +> You can use wildcard characters (\*) in the cmdlet and parameter names (for example, `*-Mailbox*`). If the command returns an error saying the object couldn't be found, the cmdlet or parameters aren't available in your environment. @@ -120,7 +139,8 @@ For example: Get-ManagementRoleAssignment -RoleAssignee julia@contoso.com -Delegating $false | Format-Table -Auto Role,RoleAssigneeName,RoleAssigneeType ``` -**Note**: The _RoleAssignee_ parameter returns both direct role assignments to users (uncommon) and indirect role assignments granted to the user through their membership in role groups. +> [!TIP] +> The _RoleAssignee_ parameter returns both direct role assignments to users (uncommon) and indirect role assignments granted to the user through their membership in role groups. ### Find all users who have a specific role assigned @@ -133,7 +153,7 @@ Get-ManagementRoleAssignment -Role "" -GetEffectiveUsers -Delegating For example: ```powershell -Get-ManagementRoleAssignment -Role "Mailbox Import Export" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod +Get-ManagementRoleAssignment -Role "Mailbox Import Export" -GetEffectiveUsers -Delegating $false | Where-Object {$_.EffectiveUserName -ne "All Group Members"} | Format-Table -Auto EffectiveUserName,Role,RoleAssigneeName,AssignmentMethod ``` ### Find the members of a role group @@ -150,4 +170,5 @@ For example: Get-RoleGroupMember "Organization Management" ``` -**Note**: To see the names of all available role groups, run `Get-RoleGroup`. +> [!TIP] +> To see the names of all available role groups, run `Get-RoleGroup`. diff --git a/exchange/docs-conceptual/index.yml b/exchange/docs-conceptual/index.yml index ad54d964df..7fe140c922 100644 --- a/exchange/docs-conceptual/index.yml +++ b/exchange/docs-conceptual/index.yml @@ -1,20 +1,19 @@ ### YamlMime:Landing title: Exchange PowerShell documentation # < 60 chars -summary: Learn about the Exchange PowerShell environments that are available in on-premises Exchange and Microsoft 365. # < 160 chars +summary: Learn about the PowerShell environments that are available in on-premises Exchange Server and Microsoft 365. # < 160 chars metadata: title: Exchange PowerShell documentation # Required; page title displayed in search results. Include the brand. < 60 chars. - description: Learn about the Exchange PowerShell environments that are available in on-premises Exchange and Microsoft 365. # Required; article description that is displayed in search results. < 160 chars. + description: Learn about the PowerShell environments that are available in on-premises Exchange and Microsoft 365. # Required; article description that is displayed in search results. < 160 chars. services: exchange-online ms.service: exchange-online #Required; service per approved list. service slug assigned to your service by ACOM. - ms.subservice: subservice # Optional; Remove if no subservice is used. ms.topic: landing-page # Required ms.assetid: 9983a964-f642-4fcd-856b-452a172bcd4e - manager: dansimp + manager: deniseb author: chrisda #Required; your GitHub user alias, with correct capitalization. ms.author: chrisda #Required; microsoft alias of author; optional team alias. - ms.date: 07/10/2020 #Required; mm/dd/yyyy format. + ms.date: 9/1/2023 #Required; mm/dd/yyyy format. # linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | sample | tutorial | video | whats-new @@ -22,7 +21,7 @@ landingContent: # Cards and links should be based on top customer tasks or top subjects # Start card title with a verb # Card (optional) - - title: About Exchange PowerShell + - title: About linkLists: - linkListType: overview links: @@ -30,7 +29,37 @@ landingContent: url: /powershell/exchange/exchange-management-shell - text: Exchange Online PowerShell url: /powershell/exchange/exchange-online-powershell - - text: Security & Compliance Center PowerShell + - text: Security & Compliance PowerShell url: /powershell/exchange/scc-powershell - text: Exchange Online Protection PowerShell url: /powershell/exchange/exchange-online-protection-powershell + - title: Connect + linkLists: + - linkListType: overview + links: + - text: Open the Exchange Management Shell + url: /powershell/exchange/open-the-exchange-management-shell + - text: Remotely connect to Exchange Server PowerShell + url: /powershell/exchange/connect-to-exchange-servers-using-remote-powershell + - text: Connect to Exchange Online PowerShell + url: /powershell/exchange/connect-to-exchange-online-powershell + - text: Connect to Security & Compliance PowerShell + url: /powershell/exchange/connect-to-scc-powershell + - text: Connect to Exchange Online Protection PowerShell + url: /powershell/exchange/connect-to-exchange-online-protection-powershell + - title: More + linkLists: + - linkListType: overview + links: + - text: Exchange cmdlet syntax + url: /powershell/exchange/exchange-cmdlet-syntax + - text: Find the permissions required to run any Exchange cmdlet + url: /powershell/exchange/find-exchange-cmdlet-permissions + - text: Control remote PowerShell access to Exchange servers + url: /powershell/exchange/control-remote-powershell-access-to-exchange-servers + - text: About the Exchange Online PowerShell module + url: /powershell/exchange/exchange-online-powershell-v2 + - text: What's new in the Exchange Online PowerShell module + url: /powershell/exchange/whats-new-in-the-exo-module + - text: Enable or disable access to Exchange Online PowerShell + url: /powershell/exchange/disable-access-to-exchange-online-powershell diff --git a/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md b/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md new file mode 100644 index 0000000000..50aba1763d --- /dev/null +++ b/exchange/docs-conceptual/invoke-command-workarounds-rest-api.md @@ -0,0 +1,127 @@ +--- +title: Workarounds for Invoke-Command scenarios in REST API connections +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 7/5/2023 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-powershell +ms.reviewer: +ms.localizationpriority: medium +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +description: "Learn about the alternatives to Invoke-Command commands in REST API connections using the EXO V3 module." +--- + +# Workarounds for Invoke-Command scenarios in REST API connections + +In multiple connections to Exchange Online or Security & Compliance PowerShell in the same window, you use the [Invoke-Command](/powershell/module/microsoft.powershell.core/invoke-command) cmdlet to run scripts or commands in a specific remote PowerShell session. But, the **Invoke-Command** cmdlet doesn't work in [REST API connections](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module) to Exchange Online or Security & Compliance PowerShell. + +This article offers REST API alternatives for scenarios that that use **Invoke-Command** commands. + +## Scenario 1: Run Exchange Online cmdlets + +This example finds the identity of any other user (`$Us = $User.Identity`). + +> [!TIP] +> Other commands were required to get the values of `$User` and therefore `$Us`. Those commands aren't important. The overall approach that's being used is what's important. + +- **In a remote PowerShell session**: Use the **Get-PSSession** cmdlet to store the remote PowerShell session details in the variable named `$Session`, and then run the following command: + + ```powershell + Invoke-Command -Session $Session -ScriptBlock {Get-User $Using:Us | Select-Object DistinguishedName, ExternalDirectoryObjectId} -ErrorAction SilentlyContinue + ``` + +- **In a REST API session**: Run the following command: + + ```powershell + Get-User $Us | Format-List DistinguishedName, ExternalDirectoryObjectId + ``` + +This example finds the identity of a group member: + +- **In a remote PowerShell session**: Use the **Get-PSSession** cmdlet to store the remote PowerShell session details in the variable named `$Session`, and then run the following command: + + ```powershell + Invoke-Command -Session $Session -ScriptBlock {Get-Recipient -Filter "Members -eq '$($User.DistinguishedName)'" -RecipientTypeDetails MailUniversalDistributionGroup | Select-Object DisplayName, ExternalDirectoryObjectId, RecipientTypeDetails} -ErrorAction SilentlyContinue -HideComputerName + ``` + +- **In a REST API session**: Run the following command: + + ```powershell + Get-Recipient -Filter "Members -eq '$($User.DistinguishedName)'" -RecipientTypeDetails MailUniversalDistributionGroup | Format-List DisplayName, ExternalDirectoryObjectId, RecipientTypeDetails + ``` + +## Scenario 2: Run Exchange Online cmdlets and expand specific properties + +This example finds all mailboxes where the GrantSendOnBehalfTo permission is set, and then returns the users who have the permission on the mailbox. + +- **In a remote PowerShell session**: Use the **Get-PSSession** cmdlet to store the remote PowerShell session details in the variable named `$Session`, and then run the following command: + + ```powershell + Invoke-Command -Session $Session -ScriptBlock {Get-Mailbox -Filter "GrantSendOnBehalfTo -ne `$null" -ErrorAction SilentlyContinue | Select-Object ExternalDirectoryObjectId, GrantSendOnBehalfTo -ExpandProperty GrantSendOnBehalfTo} + ``` + +- **In a REST API session**: Run the following command: + + ```powershell + $mailboxes = Get-Mailbox -Filter "GrantSendOnBehalfTo -ne `$null" + + foreach ($mailbox in $mailboxes) + + { + $users = $mailbox | Select-Object GrantSendOnBehalfTo -ExpandProperty GrantSendOnBehalfTo | Get-User + + $users | Select-Object Name, Guid + } + ``` + +## Scenario 3: Run Exchange Online cmdlets in a specific PowerShell session when multiple sessions are present + +This example shows how to create two PowerShell sessions in the same window and run the **Get-Mailbox** cmdlet in each session. + +- **In a remote PowerShell session**: + 1. Use the **Get-PSSession** cmdlet to store the first remote PowerShell session details in the variable named `$Session1`. + 2. Use the **Get-PSSession** cmdlet to store the second remote PowerShell session details in the variable named `$Session2`. + 3. Run the following commands: + + ```powershell + Invoke-Command -Session $Session1 -ScriptBlock {Get-Mailbox -ResultSize 1} + + Invoke-Command -Session $Session2 -ScriptBlock {Get-Mailbox -ResultSize 1} + ``` + +- **In a REST API session**: + 1. In the first **Connect-ExchangeOnline** command, use the parameter _Prefix_ with the value C1. + 2. Store the first REST API connection details in the variable named `$ConnectionInfo1` by running the following command: + + ```powershell + $ConnectionInfo1 = Get-ConnectionInformation | Where-Object { $_.ModulePrefix -eq "C1"} + ``` + + 3. In the second **Connect-ExchangeOnline** command, use the parameter _Prefix_ with the value C2. + 4. Store the second REST API connection details in the variable named `$ConnectionInfo2` by running the following command: + + ```powershell + $ConnectionInfo1 = Get-ConnectionInformation | Where-Object { $_.ModulePrefix -eq "C2"} + ``` + + 5. Now you can run commands in either session. For example: + + ```powershell + $CommandStr1 = "Get-$($ConnectionInfo1.ModulePrefix)Mailbox -ResultSize 10" + + Invoke-Expression $CommandStr1 + ``` + + Or + + ```powershell + $CommandStr2 = "Get-$($ConnectionInfo2.ModulePrefix)Mailbox -ResultSize 10" + + Invoke-Expression $CommandStr2 + ``` diff --git a/exchange/docs-conceptual/media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png b/exchange/docs-conceptual/media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png deleted file mode 100644 index ab6fca6e9e..0000000000 Binary files a/exchange/docs-conceptual/media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/24645e56-8b11-4c0f-ace4-09bdb2703562.png b/exchange/docs-conceptual/media/24645e56-8b11-4c0f-ace4-09bdb2703562.png deleted file mode 100644 index e3bb7eb65a..0000000000 Binary files a/exchange/docs-conceptual/media/24645e56-8b11-4c0f-ace4-09bdb2703562.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/MSN_Video_Widget.gif b/exchange/docs-conceptual/media/MSN_Video_Widget.gif deleted file mode 100644 index 852a7daa98..0000000000 Binary files a/exchange/docs-conceptual/media/MSN_Video_Widget.gif and /dev/null differ diff --git a/exchange/docs-conceptual/media/add-icon.png b/exchange/docs-conceptual/media/add-icon.png new file mode 100644 index 0000000000..9a4d36acf7 Binary files /dev/null and b/exchange/docs-conceptual/media/add-icon.png differ diff --git a/exchange/docs-conceptual/media/app-only-auth-exchange-api-perms.png b/exchange/docs-conceptual/media/app-only-auth-exchange-api-perms.png deleted file mode 100644 index 03747a57d4..0000000000 Binary files a/exchange/docs-conceptual/media/app-only-auth-exchange-api-perms.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/app-only-auth-exchange-manageasapp.png b/exchange/docs-conceptual/media/app-only-auth-exchange-manageasapp.png deleted file mode 100644 index eddd6fc8da..0000000000 Binary files a/exchange/docs-conceptual/media/app-only-auth-exchange-manageasapp.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/app-only-auth-register-app.png b/exchange/docs-conceptual/media/app-only-auth-register-app.png deleted file mode 100644 index c70d779bd4..0000000000 Binary files a/exchange/docs-conceptual/media/app-only-auth-register-app.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/app-only-auth-role-assignment.png b/exchange/docs-conceptual/media/app-only-auth-role-assignment.png deleted file mode 100644 index e621133963..0000000000 Binary files a/exchange/docs-conceptual/media/app-only-auth-role-assignment.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/app-only-auth-upload-cert.png b/exchange/docs-conceptual/media/app-only-auth-upload-cert.png deleted file mode 100644 index e06831dc87..0000000000 Binary files a/exchange/docs-conceptual/media/app-only-auth-upload-cert.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png b/exchange/docs-conceptual/media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png deleted file mode 100644 index 9973407fe0..0000000000 Binary files a/exchange/docs-conceptual/media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png b/exchange/docs-conceptual/media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png deleted file mode 100644 index 014a8d3165..0000000000 Binary files a/exchange/docs-conceptual/media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png index 556726052f..75ff84fb7f 100644 Binary files a/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png and b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-granted.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-removed-from-graph.png b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-removed-from-graph.png new file mode 100644 index 0000000000..1da31d9437 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-admin-consent-removed-from-graph.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-add-a-permission.png b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-add-a-permission.png new file mode 100644 index 0000000000..52056bb322 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-add-a-permission.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png new file mode 100644 index 0000000000..e39a40aaec Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-exchange-manageasapp.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-o365-exo.png b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-o365-exo.png new file mode 100644 index 0000000000..5db4cced79 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-api-permissions-select-o365-exo.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role-scc.png b/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role-scc.png new file mode 100644 index 0000000000..4783aede58 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-app-assigned-to-role-scc.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role-scc.png b/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role-scc.png new file mode 100644 index 0000000000..10075fff24 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-and-select-supported-role-scc.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-app-registrations.png b/exchange/docs-conceptual/media/exo-app-only-auth-find-app-registrations.png new file mode 100644 index 0000000000..ebdbe372a5 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-app-registrations.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-find-roles-and-administrators.png b/exchange/docs-conceptual/media/exo-app-only-auth-find-roles-and-administrators.png new file mode 100644 index 0000000000..373d9995a9 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-find-roles-and-administrators.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-manage-ad-view.png b/exchange/docs-conceptual/media/exo-app-only-auth-manage-ad-view.png deleted file mode 100644 index 5ab47205b9..0000000000 Binary files a/exchange/docs-conceptual/media/exo-app-only-auth-manage-ad-view.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-api-permissions.png b/exchange/docs-conceptual/media/exo-app-only-auth-manifest-select-api-permissions.png similarity index 100% rename from exchange/docs-conceptual/media/exo-app-only-auth-select-api-permissions.png rename to exchange/docs-conceptual/media/exo-app-only-auth-manifest-select-api-permissions.png diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png b/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png index e1ff41c91a..4d52b45e84 100644 Binary files a/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png and b/exchange/docs-conceptual/media/exo-app-only-auth-original-permissions.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png b/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png index 36de7d3689..d06da71669 100644 Binary files a/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png and b/exchange/docs-conceptual/media/exo-app-only-auth-register-app.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png b/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png new file mode 100644 index 0000000000..4fb99251c5 Binary files /dev/null and b/exchange/docs-conceptual/media/exo-app-only-auth-role-assignments-click-add-assignments-scc.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-app-registrations.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-app-registrations.png deleted file mode 100644 index 3b3c884eef..0000000000 Binary files a/exchange/docs-conceptual/media/exo-app-only-auth-select-app-registrations.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png index ee56a245a7..89eb491ef9 100644 Binary files a/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png and b/exchange/docs-conceptual/media/exo-app-only-auth-select-manifest.png differ diff --git a/exchange/docs-conceptual/media/exo-app-only-auth-select-roles-and-administrators.png b/exchange/docs-conceptual/media/exo-app-only-auth-select-roles-and-administrators.png deleted file mode 100644 index 26eca627fa..0000000000 Binary files a/exchange/docs-conceptual/media/exo-app-only-auth-select-roles-and-administrators.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/f3b4c351-17d9-42d9-8540-e48e01779b31.png b/exchange/docs-conceptual/media/f3b4c351-17d9-42d9-8540-e48e01779b31.png deleted file mode 100644 index f1c37dbfc8..0000000000 Binary files a/exchange/docs-conceptual/media/f3b4c351-17d9-42d9-8540-e48e01779b31.png and /dev/null differ diff --git a/exchange/docs-conceptual/media/mi-add-exo-module.png b/exchange/docs-conceptual/media/mi-add-exo-module.png new file mode 100644 index 0000000000..fa36117aa4 Binary files /dev/null and b/exchange/docs-conceptual/media/mi-add-exo-module.png differ diff --git a/exchange/docs-conceptual/media/search-icon.png b/exchange/docs-conceptual/media/search-icon.png new file mode 100644 index 0000000000..6241aea737 Binary files /dev/null and b/exchange/docs-conceptual/media/search-icon.png differ diff --git a/exchange/docs-conceptual/open-the-exchange-management-shell.md b/exchange/docs-conceptual/open-the-exchange-management-shell.md index 5af4771002..c097a3fc37 100644 --- a/exchange/docs-conceptual/open-the-exchange-management-shell.md +++ b/exchange/docs-conceptual/open-the-exchange-management-shell.md @@ -2,34 +2,31 @@ title: "Open the Exchange Management Shell" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 9/7/2023 ms.audience: ITPro audience: ITPro ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 63976059-25f8-4b4f-b597-633e78b803c0 description: "Find and open the shortcut for Exchange PowerShell (also known as the Exchange Management Shell) on Exchange servers or computers that have the Exchange management tools installed." --- # Open the Exchange Management Shell -When you open the Exchange Management Shell you can perform administrative tasks on Exchange Server from the command line. You can open the Exchange Management Shell from the following locations: +The Exchange Management Shell enables you to do administrative tasks on Exchange servers from the command line. You can open the Exchange Management Shell from the following locations: - On the Exchange server directly or in a Remote Desktop Connection session. - - On a local computer after you install the Exchange management tools. For more information, see [Install the Exchange management tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools). ## What do you need to know before you begin? - Estimated time to complete this procedure: less than 1 minute. -- To do the procedures in this article, you need to be assigned at least one management role (typically, via membership in a role group). After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). - - For more information, see [Exchange Server permissions](/exchange/permissions/permissions). +- To do the procedures in this article, you need to be assigned at least one management role (typically, via membership in a role group). After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Exchange Server permissions](/exchange/permissions/permissions). -- If you want to run the Exchange Management Shell from a local installation of the Exchange management tools, you need to consider remote PowerShell access for your user account. By default, users are allowed to use remote PowerShell to connect to an Exchange server. However, you can block remote PowerShell access for a user account. For more information, see [Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md). +- Running the Exchange Management Shell from a local installation of the Exchange management tools requires remote PowerShell access for your user account. By default, users are allowed to use remote PowerShell to connect to an Exchange server, but you can block remote PowerShell access for user accounts. For instructions, see [Control remote PowerShell access to Exchange servers](control-remote-powershell-access-to-exchange-servers.md). > [!TIP] > Having problems? Ask for help in the [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) forums. @@ -42,7 +39,7 @@ When you open the Exchange Management Shell you can perform administrative tasks LaunchEMS ``` -- **Edge Transport servers**: Run the following commands from a Command Prompt. Note that these are two separate commands on one line for ease of copying and running: +- **Edge Transport servers**: Run the following commands from a Command Prompt. These two separate commands are presented on one line for ease of copying and running: ```dos exshell.psc1 & exchange.ps1 @@ -50,15 +47,15 @@ When you open the Exchange Management Shell you can perform administrative tasks ## Open the Exchange Management Shell in Windows Server 2016 or Windows 10 -Click **Start** > **Microsoft Exchange Server 2016 \>** **Exchange Management Shell**. +Select **Start** \> **Microsoft Exchange Server 2016 \>** **Exchange Management Shell**. ## Open the Exchange Management Shell in Windows Server 2012 R2 or Windows 8.1 When you install Exchange on Windows Server 2012 R2 or the Exchange management tools on Windows 8.1, the Exchange Management Shell shortcut isn't automatically pinned to the Start screen. -To pin the shortcut to the Start screen, do the following: +To pin the shortcut to the Start screen, do the following steps: -1. On the Start screen, open the Apps view by clicking the down arrow near the lower-left corner or swiping up from the middle of the screen. +1. On the Start screen, open the Apps view by selecting the down arrow near the lower-left corner or swiping up from the middle of the screen. 2. The **Exchange Management Shell** shortcut is in a group named **Microsoft Exchange Server 2016**. When you find the shortcut, right-click it or press and hold it, and select **Pin to Start**. To pin it to the desktop taskbar, select **Pin to taskbar**. @@ -70,14 +67,14 @@ When you install Exchange on Windows Server 2012, the Exchange Management Shell If it's not, or if you just want to quickly find and run the Exchange Management Shell, use one of the following methods: -- On the Start screen, click an empty area, and type Exchange Management Shell. When the shortcut appears in the search results, you can select it. +- On the Start screen, click in an empty area, and type Exchange Management Shell. When the shortcut appears in the search results, you can select it. - On the desktop or the Start screen, press Windows key + Q. In the Search charm, type Exchange Management Shell. When the shortcut appears in the results, you can select it. -- On the desktop or the Start screen, move your cursor to the upper-right corner, or swipe left from the right edge of the screen to show the charms. Click the Search charm, and type Exchange Management Shell. When the shortcut appears in the results, you can select it. +- On the desktop or the Start screen, move your cursor to the upper-right corner, or swipe left from the right edge of the screen to show the charms. Select the Search charm, and type Exchange Management Shell. When the shortcut appears in the results, you can select it. -If you are using Remote Desktop Connection, you might need to use one of the following methods so the Search charm appears on the remote Exchange server and not on your local computer: +If you're using Remote Desktop Connection, you might need to use one of the following methods so the Search charm appears on the remote Exchange server and not on your local computer: -- Open Remote Desktop Connection and click **Show Options** > **Local Resources** tab > **Apply Windows key combinations**. The default value is **Only when using the full screen**, but you can change it to **On the remote computer**. +- Open Remote Desktop Connection and select **Show Options** \> **Local Resources** tab \> **Apply Windows key combinations**. The default value is **Only when using the full screen**, but you can change it to **On the remote computer**. - While you're connected to the remote Exchange server, use the connection bar that appears at the top of the screen to open the Exchange server's Search charm or Start screen by clicking the down arrow and selecting **Charms** or **Start**. diff --git a/exchange/docs-conceptual/recipient-filters.md b/exchange/docs-conceptual/recipient-filters.md index a53ed62c85..dc3ea8bf77 100644 --- a/exchange/docs-conceptual/recipient-filters.md +++ b/exchange/docs-conceptual/recipient-filters.md @@ -2,34 +2,34 @@ title: "Recipient filters in Exchange PowerShell commands" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 09/07/2023 ms.audience: ITPro audience: ITPro ms.topic: reference ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: fb4b1396-9aae-4037-be1a-b09e336b890e description: "Learn about creating different kinds of recipient filters in the Exchange Management Shell and Exchange Online PowerShell." --- # Recipient filters in Exchange PowerShell commands -The cmdlets in the Exchange Management Shell and Exchange Online PowerShell support a variety of filters in recipient related cmdlets: +The cmdlets in the [Exchange Management Shell](exchange-management-shell.md) and [Exchange Online PowerShell](exchange-online-powershell.md)l support different types of filters in recipient related cmdlets: -- Precanned filters -- Custom filters using the _RecipientFilter_ parameter -- Custom filters using the _Filter_ parameter -- Custom filters using the _ContentFilter_ parameter +- Precanned filters. +- Custom filters using the _RecipientFilter_ parameter. +- Custom filters using the _Filter_ parameter. +- Custom filters using the _ContentFilter_ parameter. Older versions of Exchange used LDAP filtering syntax to create custom address lists, global address lists (GALs), email address policies, and distribution groups. OPATH filtering syntax replaced LDAP filtering syntax starting in Exchange Server 2007. ## Precanned filters -A precanned filter is a commonly used Exchange filter that you can use to meet a variety of recipient-filtering criteria for creating dynamic distribution groups, email address policies, address lists, or GALs. With precanned filters, you can use either the Exchange PowerShell or the Exchange admin center (EAC). Using precanned filters, you can do the following: +A _precanned filter_ uses popular properties in Exchange to filter recipients for dynamic distribution groups, email address policies, address lists, or GALs. With precanned filters, you can use either the Exchange PowerShell or the Exchange admin center (EAC). Using precanned filters, you can do the following tasks: - Determine the scope of recipients. -- Add conditional filtering based on properties such as company, department, and state or region. +- Add conditional filtering based on common properties such as company, department, and state or region. - Add custom attributes for recipients. For more information, see [Custom Attributes](/Exchange/recipients/mailbox-custom-attributes). The following parameters are considered precanned filters: @@ -40,7 +40,7 @@ The following parameters are considered precanned filters: - _ConditionalStateOrProvince_ - _ConditionalCustomAttribute1_ to _ConditionalCustomAttribute15_. -Precanned filters are available for the following cmdlets: +Precanned filters are available on the following cmdlets: - [New-DynamicDistributionGroup](/powershell/module/exchange/new-dynamicdistributiongroup) - [Set-DynamicDistributionGroup](/powershell/module/exchange/set-dynamicdistributiongroup) @@ -58,16 +58,21 @@ Precanned filters are available for the following cmdlets: This example describes using precanned filters in the Exchange Management Shell to create a dynamic distribution group. The syntax in this example is similar but not identical to the syntax you would use to create an email address policy, address list, or GAL. When creating a precanned filter, you should ask the following questions: -- From which organizational unit (OU) do you want to include recipients? (This question corresponds to the _RecipientContainer_ parameter.) +- From which organizational unit (OU) do you want to include recipients (the _RecipientContainer_ parameter)? > [!NOTE] - > Selecting the OU for this purpose applies only when creating dynamic distribution groups, and not when creating email address policies, address lists, or GALs. + > Selecting the OU for this purpose applies only to creating dynamic distribution groups, and not to creating email address policies, address lists, or GALs. -- What type of recipients do you want to include? (This question corresponds to the _IncludedRecipients_ parameter.) +- What types of recipients do you want to include (the _IncludedRecipients_ parameter)? -- What additional conditions do you want to include in the filter? (This question corresponds to the _ConditionalCompany_, _ConditionalDepartment_, _ConditionalStateOrProvince_, and _ConditionalCustomAttribute_ parameters.) +- What additional conditions do you want to include in the filter (the _ConditionalCompany_, _ConditionalDepartment_, _ConditionalStateOrProvince_, and _ConditionalCustomAttribute_ parameters)? -This example creates the dynamic distribution group Contoso Finance for user mailboxes in the OU Contoso.com/Users and specifies the condition to include only recipients who have the **Department** attribute defined as Finance and the **Company** attribute defined as Contoso. +This example creates a dynamic distribution group with the following properties: + +- **Name**: Contoso Finance. +- **Recipient types**: User mailboxes. +- **Recipient location**: The OU named Contoso.com/Users. +- **Filters** Include only recipients who have the **Department** attribute defined as Finance and the **Company** attribute defined as Contoso. ```powershell New-DynamicDistributionGroup -Name "Contoso Finance" -OrganizationalUnit Contoso.com/Users -RecipientContainer Contoso.com/Users -IncludedRecipients MailboxUsers -ConditionalDepartment "Finance" -ConditionalCompany "Contoso" @@ -81,9 +86,7 @@ Get-DynamicDistributionGroup -Identity "Contoso Finance" | Format-List Recipient ## Custom filters using the RecipientFilter parameter -If precanned filters don't meet your needs for creating or modifying dynamic distribution groups, email address policies, and address lists, you can create a custom filter by using the _RecipientFilter_ parameter. - -The recipient filter parameter is available for the following cmdlets: +If precanned filters don't meet your needs, you can create custom filters by using the _RecipientFilter_ parameter. This parameter is available on the following cmdlets: - [New-DynamicDistributionGroup](/powershell/module/exchange/new-dynamicdistributiongroup) - [Set-DynamicDistributionGroup](/powershell/module/exchange/set-dynamicdistributiongroup) @@ -103,19 +106,26 @@ For more information about the filterable properties you can use with the _Recip The following example uses the _RecipientFilter_ parameter to create a dynamic distribution group. The syntax in this example is similar but not identical to the syntax you use to create an email address policy, address list, or GAL. -This example uses custom filters to create a dynamic distribution group for user mailboxes that have the **Company** attribute defined as Contoso and the **Office** attribute defined as North Building. +This example uses custom filters to create a dynamic distribution group with the following properties: + +- **Name**: AllContosoNorth. +- **Recipient types**: User mailboxes. +- **Recipient location**: The OU named Contoso.com/Users. +- **Filters** Include only recipients who have the **Company** attribute defined as Contoso and the **Office** attribute defined as North Building. ```powershell -New-DynamicDistributionGroup -Name AllContosoNorth -OrganizationalUnit contoso.com/Users -RecipientFilter "((RecipientType -eq 'UserMailbox') -and (Company -eq 'Contoso') -and (Office -eq 'North Building'))" +New-DynamicDistributionGroup -Name AllContosoNorth -OrganizationalUnit contoso.com/Users -RecipientFilter "((RecipientTypeDetails -eq 'UserMailbox') -and (Company -eq 'Contoso') -and (Office -eq 'North Building'))" ``` ## Custom filters using the Filter parameter -You can use the _Filter_ parameter to filter the results of a command to specify which objects to retrieve. For example, instead of retrieving all users or groups, you can specify a set of users or groups by using a filter string. This type of filter doesn't modify any configuration or attributes of objects. It only modifies the set of objects that the command returns. +You can use the _Filter_ parameter to filter the results of a command to specify which objects to retrieve. For example, instead of retrieving all users or groups, you can specify a set of users or groups using a filter string. This type of filter doesn't modify any configuration or attributes of objects. It only modifies the set of objects that the command returns. -Using the _Filter_ parameter to modify command results is known as server-side filtering. Server-side filtering submits the command and the filter to the server for processing. We also support client-side filtering, in which the command retrieves all objects from the server and then applies the filter in the local console window. To perform client-side filtering, use the **Where-Object** cmdlet. For more information about server-side and client-side filtering, see "How to Filter Data" in [Working with Command Output](/exchange/working-with-command-output-exchange-2013-help). +Using the _Filter_ parameter to modify command results is known as _server-side filtering_. Server-side filtering submits the command and the filter to the server for processing. We also support client-side filtering, in which the command retrieves all objects from the server and then applies the filter in the local console window. To perform client-side filtering, use the **Where-Object** cmdlet. For more information about server-side and client-side filtering, see "How to Filter Data" in [Working with Command Output](/exchange/working-with-command-output-exchange-2013-help). -To find the filterable properties for cmdlets that have the _Filter_ parameter, you can run the **Get** command against an object and format the output by pipelining the **Format-List** parameter. Most of the returned values will be available for use in the _Filter_ parameter. The following example returns a detailed list for the mailbox Ayla. +To find the filterable properties for cmdlets that have the _Filter_ parameter, you can run the **Get** command against an object and format the output by pipelining the **Format-List** parameter. Most of the returned values are available for use in the _Filter_ parameter. + +The following example returns a detailed list for the mailbox Ayla. ```powershell Get-Mailbox -Identity Ayla | Format-List @@ -141,9 +151,9 @@ The _Filter_ parameter is available for the following recipient cmdlets: For more information about the filterable properties you can use with the _Filter_ parameter, see [Filterable properties for the Filter parameter](filter-properties.md). -### Example +### Filter parameter example -This example uses the _Filter_ parameter to return information about users whose title contains the word "manager". +This example uses the _Filter_ parameter to return information about users whose title contains the word "manager." ```powershell Get-User -Filter "Title -like 'Manager*'" @@ -155,7 +165,7 @@ You can use the _ContentFilter_ parameter to select specific message content to ### ContentFilter parameter example -This example creates an export request that searches Ayla's mailbox for messages where the body contains the phrase "company prospectus". If that phrase is found, the command exports all messages with that phrase to a .pst file. +This example creates an export request that searches Ayla's mailbox for messages where the body contains the phrase "company prospectus." If that phrase is found, the command exports all messages with that phrase to a .pst file. ```powershell New-MailboxExportRequest -Mailbox Ayla -ContentFilter "Body -like 'company prospectus*'" @@ -165,52 +175,44 @@ For more information about the filterable properties that you can use with the _ ## Additional OPATH syntax information -When creating your own custom OPath filters, consider the following items: +When creating your own custom OPATH filters, consider the following items: - Use the following syntax to identify the types of values that you're searching for: - - **Text values**: Enclose the text in single quotation marks (for example, `'Value'` or `'Value with spaces'`). Or, you can enclose a text value in double quotation marks, but that limits the characters you can use to enclose the whole OPath filter. + - **Text values**: Enclose the text in single quotation marks (for example, `'Value'` or `'Value with spaces'`). Or, you can enclose a text value in double quotation marks, but that limits the characters you can use to enclose the whole OPATH filter. - **Variables**: Enclose variables that need to be expanded in single quotation marks (for example, `'$User'`). If the variable value itself contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. - - **Integer values**: You don't need to enclose integers (for example, `500`). You can often enclose integers in single quotation marks or double quotation marks, but that limits the characters you can use to enclose the whole OPath filter. + - **Integer values**: You don't need to enclose integers (for example, `500`). You can often enclose integers in single quotation marks or double quotation marks, but that limits the characters you can use to enclose the whole OPATH filter. - - **System values**: Don't enclose system values (for example, `$true`, `$false`, or `$null`). To enclose the whole OPath filter in double quotation marks, you need to escape the dollar sign in system value (for example, `` `$true``). + - **System values**: Don't enclose system values (for example, `$true`, `$false`, or `$null`). To enclose the whole OPATH filter in double quotation marks, you need to escape the dollar sign in system value (for example, `` `$true``). -- You need to enclose the whole OPath filter in double quotation marks " or " single quotation marks ' '. Although any OPath filter object is technically a string and not a script block, you can still use braces { }, but only if the filter doesn't contain variables that require expansion. The characters that you can use to enclose the whole OPath filter depend on types of values that you're searching for and the characters you used (or didn't use) to enclose those values: +- You need to enclose the whole OPATH filter in double quotation marks " " or single quotation marks ' '. Although any OPATH filter object is technically a string and not a script block, you can still use braces { }, but only if the filter doesn't contain variables that require expansion. The characters that you can use to enclose the whole OPATH filter depend on types of values that you're searching for and the characters you used (or didn't use) to enclose those values: - **Text values**: Depends on how you enclosed the text to search for: + - **Text enclosed in single quotation marks**: Enclose the whole OPATH filter in double quotation marks or braces. + - **Text enclosed in double quotation marks**: Enclose the whole OPATH filter in braces. - - **Text enclosed in single quotation marks**: Enclose the whole OPath filter in double quotation marks or braces. - - **Text enclosed in double quotation marks**: Enclose the whole OPath filter in braces. - - - **Variables**: Enclose the whole OPath filter in double quotation marks (for example, `"Name -eq '$User'"`). - - - **Integer values**: Depends on how you enclosed (or didn't enclose) the integer to search for: + - **Variables**: Enclose the whole OPATH filter in double quotation marks (for example, `"Name -eq '$User'"`). - - **Integer not enclosed**: Enclose the whole OPath filter in double quotation marks, single quotation marks, or braces (for example `"CountryCode -eq 840"`). - - **Integer enclosed in single quotation marks**: Enclose the whole OPath filter in double quotation marks or braces `"CountryCode -eq '840'"`. - - **Integer enclosed in double quotation marks**: Enclose the whole OPath filter in braces (for example `{CountryCode -eq "840"}`). + - **Integer values**: To ensure they work in all cases, enclose them in one of the following ways: + - **Integer enclosed in single quotation marks**: Enclose the whole OPATH filter in double quotation marks or braces `"CountryCode -eq '840'"`. + - **Integer enclosed in double quotation marks**: Enclose the whole OPATH filter in braces (for example `{CountryCode -eq "840"}`). - - **System values**: Enclose the whole OPath filter in single quotation marks or braces (for example `'HiddenFromAddressListsEnabled -eq $true'`). If you escape the dollar sign system value, you can also enclose the whole OPath filter in double quotation marks (for example, ``"HiddenFromAddressListsEnabled -eq `$true"``). + - **System values**: Enclose the whole OPATH filter in single quotation marks or braces (for example `'HiddenFromAddressListsEnabled -eq $true'`). If you escape the dollar sign system value, you can also enclose the whole OPATH filter in double quotation marks (for example, ``"HiddenFromAddressListsEnabled -eq `$true"``). - The compatibility of search criteria and the valid characters that you can use to enclose the whole OPath filter are summarized in the following table: + The compatibility of search criteria and the valid characters that you can use to enclose the whole OPATH filter are summarized in the following table: -
- - **** - - |Search value|OPath filter
enclosed in
double quotation marks|OPath filter
enclosed in
single quotation marks|OPath filter enclosed in
braces| + |Search value|OPATH filter
enclosed in
double quotation marks|OPATH filter
enclosed in
single quotation marks|OPATH filter enclosed in
braces| |---|:---:|:---:|:---:| - |`'Text'`|![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)||![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| - |`"Text"`|||![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| - |`'$Variable'`|![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)||| - |`500`|![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)|![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)|![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| - |`'500'`|![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)||![Check mark](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| - |`"500"`|||![Check mark](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| - |`$true`||![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)|![Check mark](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| - |`` `$true``|![Check mark.](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)|![Check mark](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)|![Check mark](media/f3b4c351-17d9-42d9-8540-e48e01779b31.png)| - | + |`'Text'`|✔||✔| + |`"Text"`|||✔| + |`'$Variable'`|✔||| + |`500`|✔|✔|✔| + |`'500'`|✔||✔| + |`"500"`|||✔| + |`$true`||✔|✔| + |`` `$true``|✔|✔|✔| - Include the hyphen before all logical or comparison operators. The most common operators include: @@ -226,24 +228,22 @@ When creating your own custom OPath filters, consider the following items: - Many filterable properties accept wildcard characters. If you use a wildcard character, use the **-like** operator instead of the **-eq** operator. Use the **-like** operator to find pattern matches in rich types (for example, strings). Use the **-eq** operator to find an exact match. - When you use the **-like** operator in Exchange Online PowerShell, the wildcard character is supported only as a suffix. For example, `"Department -like 'sales*'"` is allowed; `"Department -like '*sales'"` is not allowed. + When you use the **-like** operator in Exchange Online PowerShell, the wildcard character is supported only as a suffix in **most** parameters. For example, `"Department -like 'sales*'"` is allowed, but `"Department -like '*sales'"` isn't allowed. + + > [!TIP] + > Even if a wildcard prefix works in a filter parameter in Exchange Online PowerShell, we don't recommend using it due to low performance issues. -- For more information about operators you can use, see: +- For more information about operators that you can use, see: - [about_Logical_Operators](/powershell/module/microsoft.powershell.core/about/about_logical_operators) - [about_Comparison_Operators](/powershell/module/microsoft.powershell.core/about/about_comparison_operators) ## Recipient filter documentation -The following table contains links to articles that will help you learn more about the filterable properties that you can use with Exchange recipient commands. - -
- -**** +The following table contains links to articles to help you learn more about the filterable properties that you can use with Exchange recipient commands. |Article|Description| |---|---| |[Filterable properties for the RecipientFilter parameter on Exchange cmdlets](recipientfilter-properties.md)|Learn more about the filterable properties that are available for the _RecipientFilter_ parameter.| |[Filterable properties for the Filter parameter on Exchange cmdlets](filter-properties.md) |Learn more about the filterable properties that are available for the _Filter_ parameter.| -|[Filters in the EXO V2 module](filters-v2.md)|Learn about the considerations for filters when you connect to Exchange Online PowerShell using the Exchange Online PowerShell V2 module.| -| +|[Filters in the Exchange Online PowerShell module](filters-v2.md)|Learn about the considerations for filters in the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module.| diff --git a/exchange/docs-conceptual/recipientfilter-properties.md b/exchange/docs-conceptual/recipientfilter-properties.md index 85388b79dd..0c75acd5b6 100644 --- a/exchange/docs-conceptual/recipientfilter-properties.md +++ b/exchange/docs-conceptual/recipientfilter-properties.md @@ -2,13 +2,13 @@ title: "Filterable properties for the RecipientFilter parameter" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 09/07/2023 ms.audience: ITPro audience: ITPro ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: cf78aca5-6699-485c-9b15-e0adba252176 description: "Learn about the recipient properties that you can use with the RecipientFilter parameter in Exchange Server and Exchange Online cmdlets." --- @@ -36,21 +36,22 @@ The recipient properties that have been *confirmed* to work with the _RecipientF - Not all recipient properties have a corresponding Active Directory property. The LDAP display name value in the table is "n/a" for these properties, which indicates that the property is calculated (likely by Exchange). -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. For more information, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. For more information, see [Additional OPATH syntax information](recipient-filters.md#additional-opath-syntax-information). - You typically use the object's name for properties that require a valid object value (for example, a mailbox, a distribution group, or an email address policy, but the property might also accept the object's distinguished name (DN) or globally unique identifier (GUID). To find the object's DN or GUID, use the **Get-** cmdlet that corresponds to the object's type (for example, `Get-EmailAddressPolicy | Format-List Name,DistinguishedName,GUID`). -- Text string properties that accept wildcard characters require the `-like` operator (for example, `"Property -like 'abc*'"`). In Exchange Online PowerShell, you can't use the wildcard as a prefix (for example, `"Property -like '*abc'"`) is not allowed). +- Text string properties that accept wildcard characters require the `-like` operator (for example, `"Property -like 'abc*'"`). In Exchange Online PowerShell, you can't use the wildcard as a prefix in **most** parameters (for example, `"Property -like '*abc'"`) isn't allowed). -- The Value column in the table describes the acceptable values for the *filter*, not necessarily for the property itself. For example, a property might obviously contain a date or numeric value, but when you use that property in a filter, it might be treated like a text string (no value check, and wildcards are supported). + > [!TIP] + > Even if a wildcard prefix works in a filter parameter in Exchange Online PowerShell, we don't recommend using it due to low performance issues. -- To look for blank or non-blank property values, use the value `$null` (for example, `'Property -eq $null'` or `'Property -ne $null'`). +- The Value column in the table describes the acceptable values for the _filter_, not necessarily for the property itself. For example, a property might obviously contain a date or numeric value, but when you use that property in a filter, it might be treated like a text string (no value check, and wildcards are supported). -- For filtering considerations for connections using the Exchange Online PowerShell v2 module, see [Filters in the EXO V2 module](filters-v2.md). +- To look for blank or non-blank property values, use the value `$null` (for example, `'Property -eq $null'` or `'Property -ne $null'`). -
+- For filtering considerations for the nine exclusive **Get-EXO\*** cmdlets in the Exchange Online PowerShell module, see [Filters in the Exchange Online PowerShell module](filters-v2.md). -**** +- In Exchange Online, you can't use a wildcard character (*) as the first character in the search string. |Property name|LDAP display name|Value|Comments| |---|---|---|---| @@ -110,7 +111,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_ElcExpirationSuspensionEndDate_|_msExchELCExpirySuspensionEnd_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| |_ElcExpirationSuspensionStartDate_|_msExchELCExpirySuspensionStart_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|This property contains a date-time value.| |_ElcMailboxFlags_|_msExchELCMailboxFlags_|`None` (0), `ExpirationSuspended` (1), `ElcV2` (2), `DisableCalendarLogging` (4),`LitigationHold` (8), `SingleItemRecovery` (16), `ValidArchiveDatabase` (32), `ShouldUseDefaultRetentionPolicy` (128), `EnableSiteMailboxMessageDedup` (256), `ElcProcessingDisabled` (512), or `ComplianceTagHold` (1024).|| -|_EmailAddresses_|_proxyAddresses_|String (wildcards accepted).|This property contains the recipient's email addresses (the primary email address and all proxy addresses).| +|_EmailAddresses_|_proxyAddresses_|String (wildcards accepted).|This property contains the recipient's email addresses (the primary email address and all proxy addresses). This is the property used to identify inactive mailboxes.| |_EmailAddressPolicyEnabled_|n/a|Boolean (`$true` or `$false`)|| |_EntryId_|_msExchPublicFolderEntryId_|String (wildcards accepted).|| |_EwsApplicationAccessPolicy_|_msExchEwsApplicationAccessPolicy_|`EnforceAllowList` or `EnforceBlockList`.|| @@ -119,7 +120,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_ExchangeUserAccountControl_|_msExchUserAccountControl_|For valid values, see [ADS_USER_FLAG_ENUM enumeration](/windows/win32/api/iads/ne-iads-ads_user_flag_enum). The integer values will work as described. Most of the text values won't work as described (even if you remove `ADS_UF` and all underscores).|| |_ExchangeVersion_|_msExchVersion_|Dynamic distribution groups: String (wildcards accepted).
Others: `ExchangeObjectVersion` values.|| |_ExpansionServer_|_msExchExpansionServerName_|String (wildcards accepted).|| -|_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|String (wildcards accepted).|| +|_ExtensionCustomAttribute1_ to _ExtensionCustomAttribute5_|_msExchExtensionCustomAttribute1_ to _msExchExtensionCustomAttribute5_|String (wildcards accepted).|Currently, these attributes aren't useable as filters in Exchange Online. For more information, see [Microsoft Entra Connect Sync: Attributes synchronized to Microsoft Entra ID](/entra/identity/hybrid/connect/reference-connect-sync-attributes-synchronized).| |_ExternalDirectoryObjectId_|_msExchExternalDirectoryObjectId_|String (wildcards accepted).|| |_ExternalEmailAddress_|_targetAddress_|String (wildcards accepted).|This property contains the external email address for mail contacts and mail users.| |_ExternalOofOptions_|_msExchExternalOOFOptions_|`External` (0) or `InternalOnly` (1).|| @@ -184,7 +185,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_MaxSendSize_|_submissionContLength_|Dynamic distribution groups: A byte quantified size value (for example, `50MB`). Unqualified values are treated as bytes.
Others: Blank or non-blank.|| |_MemberDepartRestriction_|_msExchGroupDepartRestriction_|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|| |_MemberJoinRestriction_|_msExchGroupDepartRestriction_|`Closed` (0), `Open` (1), or `ApprovalRequired` (2).|| -|_MemberOfGroup_|_memberOf_|String (wildcards accepted in dynamic distribution groups).|| +|_MemberOfGroup_|_memberOf_|String (wildcards accepted in dynamic distribution groups).|You must use the DistinguishedName. This property only works with groups recognized by Exchange, therefore Microsoft Entra security groups do not work.| |_Members_|_member_|String (wildcards accepted in dynamic distribution groups).|| |_MessageHygieneFlags_|_msExchMessageHygieneFlags_|`None` (0) or `AntispamBypass` (1).|| |_MobileAdminExtendedSettings_|_msExchOmaAdminExtendedSettings_|String (wildcards accepted).|| @@ -298,7 +299,7 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_UsageLocation_|_msExchUsageLocation_|A valid ISO 3166-1 two-letter country code value or the corresponding display name (for example, `US` or `UnitedStates`). For more information, see [Country Codes - ISO 3166](https://www.iso.org/iso-3166-country-codes.html).|| |_UseDatabaseQuotaDefaults_|_mDBUseDefaults_|Boolean (`$true` or `$false`)|If the value of this property is $true, the values of these properties are ignored for the mailbox: _IssueWarningQuota_, _ProhibitSendQuota_, _ProhibitSendReceiveQuota_, , _CalendarLoggingQuota_, _RecoverableItemsWarningQuota_, and _RecoverableItemsQuota_.| |_UserAccountControl_|_userAccountControl_|For valid values, see the Remarks section in [User-Account-Control attribute](/windows/win32/adschema/a-useraccountcontrol). You need to convert the hexadecimal values to decimal. Most of the text values won't work as described (even if you remove `ADS_UF` and all underscores).|| -|_UserPrincipalName_|_userPrincipalName_|String (wildcards accepted).|This property contains the user principal name (UPN) for this recipient (for example, `kim@contoso.com`).| +|_UserPrincipalName_|_userPrincipalName_|String (wildcards accepted).|This property contains the user principal name (UPN) for this recipient (for example, `kim@contoso.com`). This property is not supported to identify inactive mailboxes.| |_VoiceMailSettings_|_msExchUCVoiceMailSettings_|String (wildcards accepted).|Valid values for this property are: `ExchangeHostedVoiceMail=0`, `ExchangeHostedVoiceMail=1`, `CsHostedVoiceMail=0`, or `CsHostedVoiceMail=1`.| |_WebPage_|_wWWHomePage_|String (wildcards accepted).|| |_WhenChanged_|_whenChanged_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| @@ -309,7 +310,6 @@ The recipient properties that have been *confirmed* to work with the _RecipientF |_WhenSoftDeleted_|_msExchWhenSoftDeletedTime_|Dynamic distribution groups: A date/time value using the time zone and regional settings of the Exchange server.
Others: Blank or non-blank.|| |_WindowsEmailAddress_|_mail_|String (wildcards accepted).|| |_WindowsLiveID_|_msExchWindowsLiveID_|String (wildcards accepted).|| -| ## For more information diff --git a/exchange/docs-conceptual/scc-powershell.md b/exchange/docs-conceptual/scc-powershell.md index 95af3adcae..e5ec203673 100644 --- a/exchange/docs-conceptual/scc-powershell.md +++ b/exchange/docs-conceptual/scc-powershell.md @@ -1,27 +1,42 @@ --- -title: "Security & Compliance Center PowerShell" +title: "Security & Compliance PowerShell" ms.author: chrisda author: chrisda -manager: dansimp -ms.date: 9/29/2015 +manager: deniseb +ms.date: 9/1/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-powershell -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2f33bb84-cede-46f6-9d39-d246e8ce3543 search.appverid: MET150 -description: "Learn about using Security & Compliance Center PowerShell." +description: "Learn about the articles that are available for using PowerShell for Microsoft Security & Compliance PowerShell." --- -# Security & Compliance Center PowerShell +# Security & Compliance PowerShell -Security & Compliance Center PowerShell is the administrative interface that enables you to manage the features that are available in the Microsoft 365 Defender portal and the Microsoft 365 compliance center from the command line. For example, you can use Security & Compliance Center PowerShell to perform Compliance Searches. The following articles provide information about using Security & Compliance Center PowerShell: +Security & Compliance PowerShell is the administrative interface that enables you to manage compliance and some security features of your Microsoft 365 organization from the command line (mostly Microsoft Purview risk and compliance features that were formerly part of Microsoft 365 compliance). For example, you can use Security & Compliance PowerShell to perform Compliance Searches. The following articles provide information about using Security & Compliance PowerShell: -- To create a remote PowerShell session that supports both modern authentication and multi-factor authentication (MFA), see [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md). Note that the connection instructions are different from Exchange Online PowerShell or standalone Exchange Online Protection (EOP) PowerShell (the _ConnectionUri_ value is different). +- To learn about the ExchangeOnlineManagement module that's required to connect to Security & Compliance PowerShell, see [About the Exchange Online PowerShell module](exchange-online-powershell-v2.md). -- To learn about the structure and layout of the cmdlet reference articles in Security & Compliance Center PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). + > [!TIP] + > Version 3.0.0 and later (2022) is known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module). Version 2.0.5 and earlier (2021) was known as the Exchange Online PowerShell V2 module (abbreviated as the EXO V2 module). -Many of the cmdlets that are available in Security & Compliance Center PowerShell correspond to features that are only available in the Microsoft 365 compliance center, so the related cmdlets are exclusive to Security & Compliance Center PowerShell. But, some cmdlets that are available in Security & Compliance Center PowerShell have the same names and functionality as those in Exchange Online PowerShell (for example, [Get-User](/powershell/module/exchange/get-user)). + To learn about what's new in the Exchange Online PowerShell module, see [What's new in the Exchange Online PowerShell module](whats-new-in-the-exo-module.md). -Also, some features that are available in the Microsoft 365 Defender portal (for example, [anti-spam and anti-malware](/microsoft-365/security/office-365-security/anti-spam-and-anti-malware-protection) cmdlets are only available in [Exchange Online PowerShell](exchange-online-powershell.md)). Check the **Applies to** value in the cmdlet reference article to verify where the cmdlet actually resides. +- To connect to Security & Compliance PowerShell, see [Connect to Security & Compliance PowerShell](connect-to-scc-powershell.md). The connection instructions are different from Exchange Online PowerShell or standalone Exchange Online Protection (EOP) PowerShell. + + To connect to Security & Compliance PowerShell for unattended scripts, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](app-only-auth-powershell-v2.md). + +- To learn about the structure and layout of the cmdlet reference articles in Security & Compliance PowerShell, see [Exchange cmdlet syntax](exchange-cmdlet-syntax.md). + +Security & Compliance PowerShell contains the following types of cmdlets: + +- Cmdlets that correspond to features available only in Purview compliance and the Microsoft Purview compliance portal. Most cmdlets in Security & Compliance PowerShell fall into this category. +- Basic cmdlets that are also available in Exchange Online PowerShell (for example, [Get-User](/powershell/module/exchange/get-user), and [Get-RoleGroup](/powershell/module/exchange/get-rolegroup)). +- A few cmdlets that correspond to security features available in Exchange Online Protection (EOP) and Microsoft Defender for Office 365 in the Microsoft Defender portal (for example, [Set-SecOpsOverridePolicy](/powershell/module/exchange/set-secopsoverridepolicy)). + + Cmdlets for most EOP and Defender for Office 365 security features (for example, [anti-spam policies](/defender-office-365/anti-spam-protection-about)) are available only in [Exchange Online PowerShell](exchange-online-powershell.md). + +Check the **Applies to** value in the cmdlet references article to verify the PowerShell environment where the cmdlet actually resides. diff --git a/exchange/docs-conceptual/toc.yml b/exchange/docs-conceptual/toc.yml index fed35046d8..b19c66c699 100644 --- a/exchange/docs-conceptual/toc.yml +++ b/exchange/docs-conceptual/toc.yml @@ -14,8 +14,6 @@ href: find-exchange-cmdlet-permissions.md - name: Exchange cmdlet syntax href: exchange-cmdlet-syntax.md - - name: Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers - href: use-update-exchangehelp.md - name: Recipient filters in Exchange Management Shell commands href: recipient-filters.md items: @@ -28,16 +26,26 @@ - name: Exchange Online PowerShell href: exchange-online-powershell.md items: - - name: About the Exchange Online PowerShell V2 module + - name: About the Exchange Online PowerShell module href: exchange-online-powershell-v2.md - name: Connect to Exchange Online PowerShell - modern auth and MFA href: connect-to-exchange-online-powershell.md + - name: Connect using app-only authentication for unattended scripts + href: app-only-auth-powershell-v2.md + - name: Connect using Azure managed identity + href: connect-exo-powershell-managed-identity.md + - name: Connect using C# + href: connect-to-exo-powershell-c-sharp.md + - name: Workarounds for Invoke-Command in REST API connections + href: invoke-command-workarounds-rest-api.md - name: Enable or disable access to Exchange Online PowerShell href: disable-access-to-exchange-online-powershell.md - name: Exchange cmdlet syntax href: exchange-cmdlet-syntax.md - name: Find the permissions required to run any Exchange cmdlet href: find-exchange-cmdlet-permissions.md + - name: What's new in the Exchange Online PowerShell module + href: whats-new-in-the-exo-module.md - name: Recipient filters in Exchange PowerShell commands href: recipient-filters.md items: @@ -45,33 +53,33 @@ href: filter-properties.md - name: Filterable properties for the RecipientFilter parameter href: recipientfilter-properties.md - - name: Filters in EXO V2 module cmdlets + - name: Filters in Exchange Online PowerShell module cmdlets href: filters-v2.md - - name: App-only authentication for unattended scripts - href: app-only-auth-powershell-v2.md - - name: Property sets in EXO V2 module cmdlets + - name: Property sets in Exchange Online PowerShell module cmdlets href: cmdlet-property-sets.md - - name: V1 module - Connect to Exchange Online PowerShell - href: v1-module-mfa-connect-to-exo-powershell.md - - name: Basic auth - Connect to Exchange Online PowerShell - href: basic-auth-connect-to-exo-powershell.md - - name: Security & Compliance Center PowerShell + - name: Security & Compliance PowerShell href: scc-powershell.md items: - - name: Connect to Security & Compliance Center PowerShell - modern auth and MFA + - name: About the Exchange Online PowerShell module + href: exchange-online-powershell-v2.md + - name: Connect to Security & Compliance PowerShell - modern auth and MFA href: connect-to-scc-powershell.md + - name: App-only authentication for unattended scripts + href: app-only-auth-powershell-v2.md - name: Exchange cmdlet syntax href: exchange-cmdlet-syntax.md - - name: V1 module - Connect to Security & Compliance Center PowerShell - href: v1-module-mfa-connect-to-scc-powershell.md - - name: Basic auth - Connect to Exchange Online Protection PowerShell - href: basic-auth-connect-to-scc-powershell.md + - name: Information protection client advanced settings + href: client-advanced-settings.md + - name: What's new in the Exchange Online PowerShell module + href: whats-new-in-the-exo-module.md - name: Exchange Online Protection PowerShell href: exchange-online-protection-powershell.md items: + - name: About the Exchange Online PowerShell module + href: exchange-online-powershell-v2.md - name: Connect to Exchange Online Protection PowerShell - modern auth and MFA href: connect-to-exchange-online-protection-powershell.md - name: Exchange cmdlet syntax href: exchange-cmdlet-syntax.md - - name: Basic auth - Connect to Exchange Online Protection PowerShell - href: basic-auth-connect-to-eop-powershell.md + - name: What's new in the Exchange Online PowerShell module + href: whats-new-in-the-exo-module.md diff --git a/exchange/docs-conceptual/use-update-exchangehelp.md b/exchange/docs-conceptual/use-update-exchangehelp.md deleted file mode 100644 index 955c8a929f..0000000000 --- a/exchange/docs-conceptual/use-update-exchangehelp.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -title: "Use Update-ExchangeHelp to update Exchange PowerShell help articles on Exchange servers" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: ITPro -audience: ITPro -ms.topic: article -ms.service: exchange-powershell -localization_priority: Normal -ms.assetid: 219f78a3-f0e5-4dc6-9787-9a0b9756ee09 -description: "Administrators can learn how to use Update-ExchangeHelp to update Exchange cmdlet reference articles that are available in Exchange Management Shell in Exchange 2016" ---- - -# Use Update-ExchangeHelp to update Exchange PowerShell help articles on Exchange servers - -Exchange cmdlet reference articles are created and updated all the time, but it's been difficult to get those updates into Exchange code in a timely manner so they're available in the Exchange Management Shell. Now, you can use the **Update-ExchangeHelp** cmdlet in the Exchange Management Shell to get the most up-to-date cmdlet reference articles for the command line in Exchange 2013 or later. - -The **Update-ExchangeHelp** cmdlet automatically connects to a predefined website, compares the version of the local Exchange server and the installed languages to what's available in the update packages, and then downloads and installed the updated Exchange Management Shell help. Typically, the cmdlet connects to the internet, but you can configure it to connect to an intranet source inside your organization. - -## What do you need to know before you begin? - -- Estimated time to complete: - - - Use **Update-ExchangeHelp** on a single internet-connected Exchange server: less than 5 minutes. - - - Configure **Update-ExchangeHelp** to get updates from an internal web server: 30 minutes. - -- You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Exchange server configuration settings" entry in the [Exchange infrastructure and PowerShell permissions](/Exchange/permissions/feature-permissions/infrastructure-permissions) article. - -- You can only use PowerShell to perform this procedure. To learn how to open the Exchange Management Shell in your on-premises Exchange organization, see [Open the Exchange Management Shell](open-the-exchange-management-shell.md). - -> [!TIP] -> Having problems? Ask for help in the [Exchange Server](https://go.microsoft.com/fwlink/p/?linkId=60612) forums. - -## Use Update-ExchangeHelp on a single internet-connected Exchange server - -This method requires that the Exchange server has direct access to the internet. - -Run the following command in the Exchange Management Shell: - -```powershell -Update-ExchangeHelp -Verbose -``` - - **Notes:** - -- The _Verbose_ switch is important because it provides useful information. For example, it tells you if your Exchange server already has the latest version of help installed, or if you've run the command in the last 24 hours. - -- If you want to check for updates again within 24 hours, use the _Force_ switch. - -## Configure Update-ExchangeHelp to get updates from an internal web server - -In some organizations, internal servers don't have access to the internet. If your internal Exchange servers don't have internet access, you can configure **Update-ExchangeHelp** to point to an internal web server to get updates. The steps are as follows: - -1. Download and inspect the ExchangeHelpInfo.xml manifest file. - -2. Download the update packages, publish the update packages on an internal web server, and customize the ExchangeHelpInfo.xml manifest file. - -3. Publish the customized ExchangeHelpInfo.xml manifest file on an internal web server. - -4. Modify the registry of the Exchange servers to point to the customized ExchangeHelpInfo.xml manifest file. - -5. Use and maintenance of **Update-ExchangeHelp**. - -### Step 1. Download and inspect the ExchangeHelpInfo.xml manifest file - -On a computer that has internet access, open , save the ExchangeHelpInfo.xml manifest file in a location that's easy to remember, and open the file in Notepad. - -Each available update package is defined in a **\** section, and each **\** section contains the following keys. - -- **\**: This key identifies the version Exchange that the update package applies to. `15.01.xxxx.xxx` is Exchange 2016. `15.00.xxxx.xxx` is Exchange 2013. Typically, this key specifies a range of versions. - -- **\**: This key identifies the language that the update package applies to. This key might specify only one language or multiple languages. - -- **\**: This key identifies the order that the updated packages were released for the major version of Exchange. In other words, the first update package released for Exchange 2016 is `001`, the second is `002`, etc. And, there's no relationship between the update packages and the order they were released in. For example, `001` might be an English only update, `002` might be an update for all other supported languages, and `003` might be a German-only update. - -- **\**: This key identifies the name and location of the update package for the **\** section. - -The update package that's defined in a **\** section applies to an Exchange server based on the combination of **\** and **\** values. - -You might find that multiple **\** sections apply to your Exchange servers for a given version of Exchange. For example, there might be multiple updates for the same language, or separate updates for different languages that both apply to your Exchange servers because you have multiple languages installed. Either way, you need only the most recent update for your Exchange server version and language based on the **\** key. - -For example, suppose your Exchange servers are running Exchange 2016 version `15.01.0225.040` with English and Spanish installed, and the ExchangeHelpInfo.xml manifest file looks like this: - -```xml - - - - - 15.01.0225.030-15.01.0225.050 - 001 - en - https://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_En.cab - - - 15.01.0225.030-15.01.0225.050 - 002 - de, es, fr, it, ja, ko, pt, pu, ru, zh-HanS, zh-HanT - https://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_Loc.cab - - - 15.01.0225.030-15.01.0225.050 - 003 - en - https://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_En2.cab - - - -``` - -In this example, all the updates apply to you based on the version of Exchange. However, you need only revision `003` for English, and revision `002` for Spanish. You don't need revision `001` for English because revision `003` is newer. - -### Step 2. Download the update packages, publish the update packages on an internal web server, and customize the ExchangeHelpInfo.xml manifest file - -The easiest and least time-consuming approach might be to download every available update package that's defined in the ExchangeHelpInfo.xml manifest file. The benefits to this approach are: - -- **No analysis required**: It's difficult to make a mistake and accidentally miss an update that applies to you, because you're downloading every available update package. The **Update-ExchangeHelp** cmdlet ignores the update packages that don't apply to the Exchange server, so it doesn't hurt to download unneeded update packages. - -- **Easier maintenance**: Whenever a new update package is released, you don't need to spend time determining if the update package applies to you. You just download and customize the new ExchangeHelpInfo.xml manifest file, and download the new cabinet (.cab) file that's defined in it. - -To download all of the update packages, follow these steps: - -1. Download all of the .cab files that are defined in the ExchangeHelpInfo.xml manifest file by using the **\** values. Save the files in a location that's easy to remember. - -2. Publish the .cab files on an internal web server (for example `https://intranet.contoso.com/downloads/exchange`). - -3. Modify the URL values of the **\** keys to point to the internal web server where you published the .cab files. - - For example, change the value `https://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_En.cab` to `https://intranet.contoso.com/downloads/exchange/ExchangePS_Update_En.cab`. - -4. Save the customized ExchangeHelpInfo.xml manifest file. - -The drawback to this approach is you download more .cab files than you actually need, and the unneeded .cab files consume space on your internal web server. - -If you want to identify only the update packages that apply to you, follow these steps. - -1. Find the version details for your Exchange servers. - - To find the version details on a single Exchange server, run the following command: - - ```powershell - Get-Command Exsetup.exe | ForEach {$_.FileVersionInfo} - ``` - - To find the version details for all Exchange servers in your organization, run the following command: - - ```powershell - Get-ExchangeServer | Sort-Object Name | ForEach {Invoke-Command -ComputerName $_.Name -ScriptBlock {Get-Command ExSetup.exe | ForEach{$_.FileVersionInfo}}} | Format-Table -Auto - ``` - - The result for **ProductVersion** will be in the format `15.01.0225.xxx`. - -2. Find the **\** sections in the ExchangeHelpInfo.xml manifest file that apply to your Exchange servers based on the values of the **\**, **\**, and **\** keys. The methodology was described in Step 1. - -After you identify the update packages that apply to you, follow these steps: - -1. Download the applicable .cab files by using the **\** values. Save the files in a location that's easy to remember. - -2. Publish the .cab files on an internal web server (for example `https://intranet.contoso.com/downloads/exchange`). - -3. Modify the URL values of the **\** keys to point to the internal web server where you published the .cab files. - - For example, change the value `https://download.microsoft.com/download/8/7/0/870FC9AB-6D22-4478-BFBF-66CE775BCD18/ExchangePS_Update_En.cab` to `https://intranet.contoso.com/downloads/exchange/ExchangePS_Update_En.cab`. - -4. Optionally, you can delete the **\** sections that don't apply to you. - -5. Save the customized ExchangeHelpInfo.xml manifest file. - -### Step 3. Publish the customized ExchangeHelpInfo.xml manifest file on an internal web server - -Publish the customized ExchangeHelpInfo.xml manifest file from Step 2 on an internal web server that's accessible to your internal Exchange servers. For example, `https://intranet.contoso.com/downloads/exchange/ExchangeHelpInfo.xml`. You'll use the URL value of this location in Step 4. - -Note that there's no relationship between the ExchangeHelpInfo.xml manifest file and .cab file locations. You can have them available at the same URL or on different servers. - -### Step 4. Modify the registry of your Exchange servers to point to the customized ExchangeHelpInfo.xml manifest file - -You need the download location of the customized ExchangeHelpInfo.xml manifest file that you configured in Step 3. This example uses the value `https://intranet.contoso.com/downloads/exchange/ExchangeHelpInfo.xml`. - -1. Copy and paste the following text into Notepad, customize the URL for your environment, and save the file as UpdateExchangeHelp.reg in a location that's easy to remember. - - ```text - Windows Registry Editor Version 5.00 - - [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExchangeServer\v15\UpdateExchangeHelp] - "ManifestUrl"="https://intranet.contoso.com/downloads/exchange/ExchangeHelpInfo.xml" - ``` - -2. Run the UpdateExchangeHelp.reg file on your internal Exchange servers. - -### Step 5. Use and maintenance of Update-ExchangeHelp - -Now, when you run **Update-ExchangeHelp** in the Exchange Management Shell on your internal Exchange servers, the command gets download information and downloads files from the internal locations you specified. - -More interesting is the long-term maintenance of this customized configuration. Basically, you'll need to repeat Step 1 through Step 3 when you discover an update has been made available for Exchange cmdlet reference help, and you want to deploy that updated help to your Exchange servers. - -An easy way to find new update packages is to periodically run **Update-ExchangeHelp** on an internet-connected Exchange server, or computer that has the Exchange management tools installed. - -## Details about Update-ExchangeHelp - -Windows PowerShell has the **Update-Help** and **Save-Help** cmdlets for online and offline updates of cmdlet reference articles. However, these cmdlets don't support Exchange cmdlet help, so a specific Exchange cmdlet is required to update cmdlet reference articles in the Exchange Management Shell. diff --git a/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md b/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md deleted file mode 100644 index 5c4e6d478f..0000000000 --- a/exchange/docs-conceptual/v1-module-mfa-connect-to-exo-powershell.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "V1 module - Connect to Exchange Online PowerShell using MFA" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -localization_priority: Normal -ms.assetid: -search.appverid: MET150 -ROBOTS: NOINDEX -description: "Admins can learn how to use the older Exchange Online Remote PowerShell Module to connect to Exchange Online PowerShell for multi-factor authentication (MFA) or federated authentication." ---- - -# V1 module - Connect to Exchange Online PowerShell using MFA - -> [!NOTE] -> The older Exchange Online Remote PowerShell Module that's described in this article will eventually be retired. The Exchange Online PowerShell V2 module (EXO V2 module) supports MFA, so we suggest using it instead. For instructions, see [Connect to Exchange Online PowerShell](connect-to-exchange-online-powershell.md). - -If you want to use multi-factor authentication (MFA) to connect to Exchange Online PowerShell, you can't use the instructions at [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.md) to use remote PowerShell to connect to Exchange Online. MFA requires you to install the Exchange Online Remote PowerShell Module, and use the **Connect-EXOPSSession** cmdlet to connect. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in Exchange Online](/exchange/permissions-exo/permissions-exo). - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)* - - Windows Server 2008 R2 SP1* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note**: You must temporarily enable WinRM to run the following commands. You can enable it by running the command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -## Install the Exchange Online Remote PowerShell Module - -> [!NOTE] -> The Exchange Online Remote PowerShell Module is not supported in PowerShell Core (macOS, Linux, or Windows Nano Server). As a workaround, you can install the module on a computer that's running a supported version of Windows (physical or virtual), and use remote desktop software to connect. - -You need to do the following steps in a browser that supports ClickOnce (for example, Internet Explorer or Edge): - - **Note**: ClickOnce support is available in the Chromium-based version of Edge at `edge://flags/#edge-click-once`, and might not be enabled by default. - - 1. Open the Exchange admin center (EAC) for your Exchange Online organization. For instructions, see [Exchange admin center in Exchange Online](/exchange/exchange-admin-center). - - 2. In the EAC, go to **Hybrid** > **Setup** and click the appropriate **Configure** button to download the Exchange Online Remote PowerShell Module for multi-factor authentication. - - ![Download the Exchange Online PowerShell Module from the Hybrid tab in the EAC.](media/24645e56-8b11-4c0f-ace4-09bdb2703562.png) - - 3. In the **Application Install** window that opens, click **Install**. - - ![Click Install in the Exchange Online PowerShell Module window.](media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png) - -- When you use the Exchange Online Remote PowerShell Module, your session will end after one hour, which can be problematic for long-running scripts or processes. To avoid this issue, use [Trusted IPs](/azure/active-directory/authentication/howto-mfa-mfasettings#trusted-ips) to bypass MFA for connections from your intranet. Trusted IPs allow you to connect to Exchange Online PowerShell from your intranet using the old instructions at [Basic auth - Connect to Exchange Online PowerShell](basic-auth-connect-to-exo-powershell.md). Also, if you have servers in a datacenter, be sure to add their public IP addresses to Trusted IPs as described [here](/azure/active-directory/authentication/howto-mfa-mfasettings#enable-the-trusted-ips-feature-by-using-service-settings). - -> [!TIP] -> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542) or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351). - -## Connect to Exchange Online PowerShell by using MFA - -1. On your local computer, open the **Exchange Online Remote PowerShell Module** ( **Microsoft Corporation** > **Microsoft Exchange Online Remote PowerShell Module**). - -2. The command that you need to run uses the following syntax: - - ```powershell - Connect-EXOPSSession [-UserPrincipalName -ConnectionUri -AzureADAuthorizationEndPointUri -DelegatedOrganization ] - ``` - - - _\_ is your Microsoft 365 work or school account. - - - The _\_ and _\_ values depend on the nature of your Microsoft 365 organization as described in the following table: - -
- - **** - - |Microsoft 365 offering|_ConnectionUri_ parameter value|_AzureADAuthorizationEndPointUri_ parameter value| - |---|---|---| - |Microsoft 365|Not used|Not used| - |Office 365 Germany|`https://outlook.office.de/PowerShell-LiveID`|`https://login.microsoftonline.de/common`| - |Microsoft 365 GCC High|`https://outlook.office365.us/powershell-liveid`|`https://login.microsoftonline.us/common`| - |Microsoft 365 DoD|`https://webmail.apps.mil/powershell-liveid`|`https://login.microsoftonline.us/common`| - | - - This example connects to Exchange Online in Microsoft 365 using the account chris@contoso.com. - - ```powershell - Connect-EXOPSSession -UserPrincipalName chris@contoso.com - ``` - - This example connects to Exchange Online Germany using the account lukas@fabrikam.com. - - ```powershell - Connect-EXOPSSession -UserPrincipalName lukas@fabrikam.com -ConnectionUri https://outlook.office.de/PowerShell-LiveID -AzureADAuthorizationEndPointUri https://login.microsoftonline.de/common - ``` - - This example connects to Exchange Online to manage another tenant. - - ```powershell - Connect-EXOPSSession -UserPrincipalName chris@contoso.com -DelegatedOrganization fabrikam.onmicrosoft.com - ``` - -3. In the sign-in window that opens, enter your password, and then click **Sign in**. - - ![Enter your password in the Exchange Online Remote PowerShell window.](media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png) - - A verification code is generated and delivered based on the verification response option that's configured for your account (for example, a text message or the Azure Authenticator app on your mobile phone). - -4. In the verification window that opens, enter the verification code, and then click **Sign in**. - - ![Enter your verification code in the Exchange Online Remote PowerShell window.](media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png) - -> [!NOTE] -> Be sure to disconnect the remote PowerShell session when you're finished. If you close the Exchange Online Remote PowerShell Module window without disconnecting the session, you could use up all the remote PowerShell sessions available to you, and you'll need to wait for the sessions to expire. To disconnect all currently open PowerShell sessions in the current window, run the following command: - -```powershell -Get-PSSession | Remove-PSSession -``` - -## Single sign-on - -If your organization has single sign-on (SSO) enabled and you are logged on to a computer as a user in the SSO domain, then **Connect-EXOPSSession** may fail with the following error: - -> New-EXOPSSession : User 'loggedonuser@contoso.com' returned by service does not match user 'userprincipalname@contoso.com' in the request. - -This error occurs because single sign-on overrides the specified user principal name (UPN). As a work-around, use Connect-EXOPSSession without -UserPrincipalName parameter or use -Credential parameter instead. - -## How do you know this worked? - -After Step 4, the Exchange Online cmdlets are imported into your Exchange Online Remote PowerShell Module session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Exchange Online cmdlet, for example, **Get-Mailbox**, and see the results. - -If you receive errors, check the following requirements: - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Exchange Online. - -- The account you use to connect to Exchange Online must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. diff --git a/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md b/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md deleted file mode 100644 index 4187edf675..0000000000 --- a/exchange/docs-conceptual/v1-module-mfa-connect-to-scc-powershell.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -title: "V1 module - Connect to Security & Compliance Center PowerShell using MFA" -ms.author: chrisda -author: chrisda -manager: dansimp -ms.date: -ms.audience: Admin -audience: Admin -ms.topic: article -ms.service: exchange-powershell -localization_priority: Normal -ms.assetid: -search.appverid: MET150 -ROBOTS: NOINDEX -description: "Admins can learn how to use the older Exchange Online Remote PowerShell Module to connect to Security & Compliance Center PowerShell for multi-factor authentication (MFA) or federated authentication." ---- - -# V1 module - Connect to Security & Compliance Center PowerShell using MFA - -> [!NOTE] -> The older Exchange Online Remote PowerShell Module that's described in this article will eventually be retired. The Exchange Online PowerShell V2 module (EXO V2 module) supports MFA, so we suggest using it instead. For instructions, see [Connect to Security & Compliance Center PowerShell](connect-to-scc-powershell.md). - -If your account uses multi-factor authentication (MFA) or federated authentication, you can't use the instructions at [Basic auth - Connect to Security & Compliance Center PowerShell](basic-auth-connect-to-scc-powershell.md) to use remote PowerShell to connect to Security & Compliance Center PowerShell. Instead, you need to install the Exchange Online Remote PowerShell Module, and use the **Connect-IPPSSession** cmdlet to connect to Security & Compliance Center PowerShell. - -**Notes**: - -- Delegated Access Permission (DAP) partners can't use the procedures in this article to connect to their customer tenant organizations in Security & Compliance Center PowerShell. MFA and the Exchange Online Remote PowerShell Module don't work with delegated authentication. - -- The Exchange Online Remote PowerShell Module is not supported in PowerShell Core (macOS, Linux, or Windows Nano Server). As a workaround, you can install the module on a computer that's running a supported version of Windows (physical or virtual), and use remote desktop software to connect. - -## What do you need to know before you begin? - -- Estimated time to complete: 5 minutes - -- After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see After you connect, the cmdlets and parameters that you have or don't have access to is controlled by role-based access control (RBAC). For more information, see [Permissions in the Microsoft 365 Defender portal](/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) and [Permissions in the Microsoft 365 security center](/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -- You can use the following versions of Windows: - - - Windows 10 - - Windows 8.1 - - Windows Server 2019 - - Windows Server 2016 - - Windows Server 2012 or Windows Server 2012 R2 - - Windows 7 Service Pack 1 (SP1)* - - Windows Server 2008 R2 SP1* - - \* This version of Windows has reached end of support, and is now supported only in Azure virtual machines. To use this version of Windows, you need to install the Microsoft .NET Framework 4.5 or later and then an updated version of the Windows Management Framework: 3.0, 4.0, or 5.1 (only one). For more information, see [Install the .NET Framework](/dotnet/framework/install/on-windows-7), [Windows Management Framework 3.0](https://aka.ms/wmf3download), [Windows Management Framework 4.0](https://aka.ms/wmf4download), and [Windows Management Framework 5.1](https://aka.ms/wmf5download). - -- WinRM needs to allow Basic authentication (it's enabled by default). We don't send the username and password combination, but the Basic authentication header is required to send the session's OAuth token, since the client-side WinRM implementation has no support for OAuth. - - **Note**: You must temporarily enable WinRM to run the following commands. You can enable it by running the command: `winrm quickconfig`. - - To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in Windows PowerShell): - - ```dos - winrm get winrm/config/client/auth - ``` - - If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in Windows PowerShell) to enable Basic authentication for WinRM: - - ```dos - winrm set winrm/config/client/auth @{Basic="true"} - ``` - - **Note**: If you'd rather run the command in Windows PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`. - - If Basic authentication for WinRM is disabled, you'll get this error when you try to connect: - - > The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again. - -## Install the Exchange Online Remote PowerShell Module - -> [!NOTE] -> -> - The Exchange Online Remote PowerShell Module is not supported in PowerShell Core (macOS, Linux, or Windows Nano Server). As a workaround, you can install the module on a computer that's running a supported version of Windows (physical or virtual), and use remote desktop software to connect. -> -> - If your installed version of the Exchange Online Remote PowerShell Module doesn't have the **Connect-IPPSSession** cmdlet, you need to install the latest version of the module. - -You need to do the following steps in a browser that supports ClickOnce (for example, Internet Explorer or Edge): - -**Note**: ClickOnce support is available in the Chromium-based version of Edge at `edge://flags/#edge-click-once`, and might not be enabled by default. - -1. Open the Exchange admin center (EAC). For instructions, see [Exchange admin center in Exchange Online](/exchange/exchange-admin-center). - -2. In the EAC, go to **Hybrid** > **Setup** and click the appropriate **Configure** button to download the Exchange Online Remote PowerShell Module for multi-factor authentication. - - ![Download the Exchange Online PowerShell Module from the Hybrid tab in the EAC.](media/24645e56-8b11-4c0f-ace4-09bdb2703562.png) - -3. In the **Application Install** window that opens, click **Install**. - - ![Click Install in the Exchange Online PowerShell Module window.](media/0fd389a1-a32d-4e2f-bf5f-78e9b6407d4c.png) - -## Connect to Security & Compliance Center PowerShell by using MFA or federated authentication - -1. On your local computer, open the **Exchange Online Remote PowerShell Module** (**Microsoft Corporation** > **Microsoft Exchange Online Remote PowerShell Module**). - -2. The command that you need to run uses the following syntax: - - ```powershell - Connect-IPPSSession -UserPrincipalName [-ConnectionUri -AzureADAuthorizationEndPointUri ] - ``` - - - _\_ is your Microsoft 365 work or school account. - - - The _\_ and _\_ values depend on the location of your Microsoft 365 organization as described in the following table: - -
- - **** - - |Microsoft 365 offering|_ConnectionUri_ parameter value|_AzureADAuthorizationEndPointUri_ parameter value| - |---|---|---| - |Microsoft 365|Not used |Not used| - |Office 365 Germany|`https://ps.compliance.protection.outlook.de/PowerShell-LiveID`|`https://login.microsoftonline.de/common`| - |Microsoft 365 GCC High|`https://ps.compliance.protection.office365.us/powershell-liveid/`|`https://login.microsoftonline.us/common`| - |Microsoft 365 DoD|`https://l5.ps.compliance.protection.office365.us/powershell-liveid/`|`https://login.microsoftonline.us/common`| - | - - This example connects to Security & Compliance Center PowerShell in Microsoft 365 using the account chris@contoso.com. - - ```powershell - Connect-IPPSSession -UserPrincipalName chris@contoso.com - ``` - - This example connects to Security & Compliance Center PowerShell in Office 365 Germany using the account lukas@fabrikam.com. - - ```powershell - Connect-IPPSSession -UserPrincipalName lukas@fabrikam.com -ConnectionUri https://ps.compliance.protection.outlook.de/PowerShell-LiveID -AzureADAuthorizationEndPointUri https://login.microsoftonline.de/common - ``` - -3. In the sign-in window that opens, enter your password, and then click **Sign in**. - - ![Enter your password in the Exchange Online Remote PowerShell window.](media/b85d80d9-1043-4c7c-8f14-d87d8d56b188.png) - - For MFA, a verification code is generated and delivered based on the verification response option that's configured for your account (for example, a text message or the Azure Authenticator app on your mobile phone). - -4. **(MFA only)**: In the verification window that opens, enter the verification code, and then click **Sign in**. - - ![Enter your verification code in the Exchange Online Remote PowerShell window.](media/d3a405ce-5364-4732-a7bb-2cc9c678da2d.png) - -5. **(Optional)**: If you want to connect to an Exchange Online PowerShell module session in the same window, you need to run - - ```powershell - $EXOSession=New-ExoPSSession -UserPrincipalName [-ConnectionUri -AzureADAuthorizationEndPointUri ] - ``` - - and then import the Exchange Online session into the current one using an specific prefix - - ```powershell - Import-PSSession $EXOSession -Prefix EXO - ``` - -## How do you know this worked? - -After you sign in, the Security & Compliance Center PowerShell cmdlets are imported into your Exchange Online Remote PowerShell Module session and tracked by a progress bar. If you don't receive any errors, you connected successfully. A quick test is to run an Security & Compliance Center cmdlet, for example, **Get-RetentionCompliancePolicy**, and see the results. - -If you receive errors, check the following requirements: - -- To help prevent denial-of-service (DoS) attacks, you're limited to five open remote PowerShell connections to Security & Compliance Center PowerShell. - -- The account you use to connect to Security & Compliance Center PowerShell must be enabled for remote PowerShell. For more information, see [Enable or disable access to Exchange Online PowerShell](disable-access-to-exchange-online-powershell.md). - -- TCP port 80 traffic needs to be open between your local computer and Microsoft 365. It's probably open, but it's something to consider if your organization has a restrictive Internet access policy. - -- The **Connect-IPPSSession** command (Step 2) might fail to connect if your client IP address changes during the connection request. This can happen if your organization uses a source network address translation (SNAT) pool that contains multiple IP addresses. The connection error looks like this: - - `The request for the Windows Remote Shell with ShellId failed because the shell was not found on the server. Possible causes are: the specified ShellId is incorrect or the shell no longer exists on the server. Provide the correct ShellId or create a new shell and retry the operation.` - - To fix the issue, use an SNAT pool that contains a single IP address, or force the use of a specific IP address for connections to the Security & Compliance PowerShell endpoint. diff --git a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md index 8beeca4c5f..ea729cff90 100644 --- a/exchange/docs-conceptual/values-for-custompropertynames-parameter.md +++ b/exchange/docs-conceptual/values-for-custompropertynames-parameter.md @@ -2,19 +2,19 @@ title: Values for the CustomPropertyNames parameter ms.author: chrisda author: chrisda -manager: dansimp -ms.date: +manager: deniseb +ms.date: 9/7/2023 ms.audience: Admin audience: Admin ms.topic: article ms.service: exchange-online ms.reviewer: -localization_priority: Priority +ms.localizationpriority: high ms.collection: Strat_EX_Admin ms.custom: ms.assetid: search.appverid: MET150 -description: "Learn about the valid values for the CustomPropertyNames parameter on the the Get-CalendarDiagnosticsLog cmdlet in Exchange Online PowerShell." +description: "Learn about the valid values for the CustomPropertyNames parameter on the Get-CalendarDiagnosticsLog cmdlet in Exchange Online PowerShell." --- # Values for the CustomPropertyNames parameter in Exchange Online PowerShell @@ -23,196 +23,191 @@ The _CustomPropertyNames_ parameter on the [Get-CalendarDiagnosticObjects](/powe The article describes the valid values for the _CustomPropertyNames_ parameter. -
- -**** - |CustomPropertyNames|Description| |---|---| |AddOnlineMeetingOnFinalize|Add online meeting on finalize flag.| -|AllAttachmentsHidden|The AllAttachmentsHidden property displays whether or not there are non-inline attachments inside the protected message.| +|AllAttachmentsHidden|Displays whether there are non-inline attachments inside a protected message.| |AppointmentAuxiliaryFlags|Detect whether the meeting request is a forwarded meeting (for example, IsForwardedMeeting or AttendeeCount).| -|AppointmentClass|AppointmentClass is the MessageClass of the calendar item from which a meeting message is created.| +|AppointmentClass|The MessageClass of the calendar that the meeting message is created from.| |AppointmentCounterEndWhole|End time proposal.| |AppointmentCounterProposalCount|Current counter proposal count.| |AppointmentCounterProposal|Indicates whether a Meeting Response object is a counter proposal.| |AppointmentCounterStartWhole|Start time proposal.| -|AppointmentLastSequenceNumber|If AppointmentSequenceNumber doesn't match, then use AppointmentLastSequenceNumber to decide if this stale incoming request.| +|AppointmentLastSequenceNumber|If AppointmentSequenceNumber doesn't match, use AppointmentLastSequenceNumber to decide if this is a stale incoming request.| |AppointmentProposedDuration|Proposed duration of the meeting in total minutes.| |AppointmentRecurrenceBlob|Holds a copy of recurring information only from Recurring Masters.| -|AppointmentRecurring|Shows Bool True or False whether an Appointment is recurring.| +|AppointmentRecurring|Boolean value indicating whether an Appointment is recurring.| |AppointmentReplyName|The calendar item appointment reply name.| |AppointmentReplyTime|Gets the time when the attendee replied to the meeting request.| |AppointmentSequenceNumber|Gets the sequence number of this appointment.| -|AppointmentSequenceTime|Every appointment has a sequence number that is incremented on every modification.| -|AppointmentStateInternal|Gets the state of this appointment (for example, Meeting or Received).| -|AppointmentState|Gets the state of this appointment (for example, Meeting or Received).| +|AppointmentSequenceTime|A sequence number that's incremented on every modification.| +|AppointmentStateInternal|The state of this appointment (for example, Meeting or Received).| +|AppointmentState|The state of this appointment (for example, Meeting or Received).| |AttendeeCriticalChangeTime|The attendee's critical change time.| -|BirthdayContactAttributionDisplayName|Property used to indicate the name of the contact associated with the birthday event.| +|BirthdayContactAttributionDisplayName|Indicates the name of the contact that's associated with the birthday event.| |BirthdayContactId|Represents the birthday contact ID property.| -|BirthdayPersonId|Represents the birthday person ID property used to associate multiple contact object to a single, aggregate person.| +|BirthdayPersonId|Represents the birthday person ID property that's used to associate multiple contact objects to a single, aggregate person.| |Birthday|Birthday of the contact.| -|CalendarItemExperienceTypeInternal|Experience type for a calendar item, used by client to render custom user experiences for different types of calendar items.| +|CalendarItemExperienceTypeInternal|Experience type for a calendar item. Used by the client to render custom user experiences for different types of calendar items.| |CalendarItemType|The Calendar Item Type (for example, RecurringMaster).| -|CalendarLogTriggerAction|The action thats taken on the item (for example, Create or Update).| +|CalendarLogTriggerAction|The action that's taken on the item (for example, Create or Update).| |CalendarOriginatorId|Identification of the organizer to prevent unintentional takeover of a meeting by other users.| -|CalendarProcessed|Check if the meeting message has been processed by XSO.| -|CalendarProcessingSteps|This is a set of flags for the various steps we completed in the stages of processing.| +|CalendarProcessed|Check if XSO has processed the meeting message.| +|CalendarProcessingSteps|A set of flags for the various steps that were completed in the stages of processing.| |ChangeHighlight|Encapsulates information on the change highlights of a meeting request.| |ChangeList|Add item to change list.| |Charm|Charm on a calendar folder or item.| -|CleanGlobalObjectId|CleanGlobalObjectID is just the GlobalObjectId with the Instance Date segment zeroed out. This property will be the same for all meeting objects of all exceptions and masters belonging to the same series.| +|CleanGlobalObjectId|The GlobalObjectId with the Instance Date segment zeroed out. This property is the same for all meeting objects of all exceptions and masters belonging to the same series.| |ClientBuildVersion|Outlook client build version.| |ClientInfoString|The entity that made the change (for example, `Client=OWA;, Client=WebServices;;`, or `Client=TBA;Service=MSExchangeMailboxAssistants;Action=ELCAssistant;`).| -|ClientIntent|What the intent of the client is from any changes that are made to the item.| +|ClientIntent|The intent of the client from any changes that are made to the item.| |ClientProcessName|Client process name (for example, OUTLOOK.EXE).| -|ConferenceInfo|ConferenceInfo property is used by legacy online meeting and by calling the UCWA APIs we've updated the meeting.| -|ConferenceTelURI|The conference tel uri for online meeting.| -|ConferenceType|The type of conferencing that will be used during the meeting.| -|ConnectedCalendarEventSourceData|Property that contains the data of a connected calendar event as received from source.| +|ConferenceInfo|Used by legacy online meetings and by calling the UCWA APIs.| +|ConferenceTelURI|The conference telephone URI for online meeting.| +|ConferenceType|The type of conferencing that's used during the meeting.| +|ConnectedCalendarEventSourceData|Contains the data of a connected calendar event as received from the source.| |CreationHash|A hash that identifies the original request to create an event.| |CreationTime|Creation time of the item.| |DisallowNewTimeProposal|Specifies whether recipients of the meeting request can propose a new time for the meeting.| -|DisplayAttendeesAll|List of All the Attendees.| -|DisplayAttendeesCc|Who to display the Attendees list CC line.| -|DisplayAttendeesTo|Who to display the Attendees list in To line.| +|DisplayAttendeesAll|List of all attendees.| +|DisplayAttendeesCc|Display the Attendees list in the Cc line.| +|DisplayAttendeesTo|Display the Attendees list in the To line.| |DoNotForward|Organizer wants to prevent attendees from inviting others.| |Duration|Duration in minutes.| |EndTimeZoneId|Time zone of the end of the meeting.| |EndTimeZone|Defines the EndTimeZone property.| |EndTime|End time of a calendar item.| |EndWallClock|The end time of the meeting expressed in the time zone of the meeting.| -|EnhancedLocation|Indicates that Enhanced Location data is present, has value : Microsoft.Exchange.Data.Storage.EnhancedLocation.| -|EntryId|The store entry id or PR_ENTRYID (MAPI).| -|EstimatedAcceptCount|An estimated count of the number of attendees which accepted a meeting.| -|EstimatedAttendeeCount|An estimated count of the number of attendees of a meeting.| -|EstimatedDeclineCount|An estimated count of the number of attendees which declined a meeting.| -|EstimatedTentativeCount|An estimated count of the number of attendees which tentatively accepted a meeting.| -|EventClientId|Client-generated string representing id for series of calendar events.| -|EventDraft|Flag indicating whether calendar event is in the draft state.| +|EnhancedLocation|Indicates that Enhanced Location data is present. Has value Microsoft.Exchange.Data.Storage.EnhancedLocation.| +|EntryId|The store entry ID or PR_ENTRYID (MAPI).| +|EstimatedAcceptCount|An estimated count of the number of attendees who accepted the meeting.| +|EstimatedAttendeeCount|An estimated count of the number of attendees of the meeting.| +|EstimatedDeclineCount|An estimated count of the number of attendees who declined the meeting.| +|EstimatedTentativeCount|An estimated count of the number of attendees who tentatively accepted the meeting.| +|EventClientId|Client-generated string representing the ID for a series of calendar events.| +|EventDraft|Indicates whether the calendar event is in the draft state.| |EventResponseTrackingSource|Event response tracking status.| -|EventTimeBasedInboxRemindersState|Property that contains the state for time-based inbox reminders pertaining to calendar events.| -|EventTimeBasedInboxReminders|Property that contains time-based inbox reminders pertaining to calendar events.| +|EventTimeBasedInboxRemindersState|Contains the state for time-based Inbox reminders pertaining to calendar events.| +|EventTimeBasedInboxReminders|Contains time-based Inbox reminders pertaining to calendar events.| |ExceptionReplaceTime|The exception replace time.| -|ExceptionalAttendees|Bool value whether there are Exceptional Attendees.| -|ExceptionalBody|Bool value whether there are Exceptional Body is changed.| -|ExternalSharingMasterId|If copy of remote calendar in shared in calendar do not set organizer as it is not simply owner of a current mailbox It will sync back from master copy where it will be evaluated properly at save.| +|ExceptionalAttendees|Boolean value indicating whether there are Exceptional Attendees.| +|ExceptionalBody|Boolean value indicating whether there are Exceptional Body is changed.| +|ExternalSharingMasterId|If a copy of a remote calendar in shared in the calendar, don't set the organizer, because the organizer isn't simply the owner of the current mailbox. It syncs back from master copy where it's properly evaluated when saved.| |ForwardNotificationRecipients|List of Forwarded Recipients.| |FreeBusyStatus|Free/busy status associated with the event.| -|From|From e-mail address.| -|GlobalObjectId|GlobalObjectId is a binary blob used to correlate the meeting requests/responses/cancellations in the Inbox with the meeting item in the Calendar.| -|HasAttachment|Value indicating whether the item has attachments.| -|HasExceptionalInboxReminders|Whether a series has any exceptional inbox reminders.| -|HijackedMeeting|Indicates if the meeting request was hijacked, useful to identify if if specific meetings aren't processed, because another user Hijacked the meeting.| +|From|From email address.| +|GlobalObjectId|A binary blob used to correlate the meeting requests/responses/cancellations in the Inbox with the meeting item in the Calendar.| +|HasAttachment|Indicates whether the item has attachments.| +|HasExceptionalInboxReminders|Whether a series has any exceptional Inbox reminders.| +|HijackedMeeting|Indicates whether the meeting request was hijacked. Useful to identify specific meetings that weren't processed because another user hijacked the meeting.| |Importance|Importance status of the email (for example, Normal).| -|InboundICalStream|Contains the contents of the iCalendar MIME part of the original MIME message.| +|InboundICalStream|The contents of the iCalendar MIME part of the original MIME message.| |InstanceCreationIndex|The index of this instance when the series was originally created.| -|IntendedFreeBusyStatus|Value representing the intended free/busy status of the meeting.| -|InternetMessageId|Internet Message Id of the e-mail message.| -|IsAllDayEvent|Value indicating whether this appointment is an all day event.| -|IsBirthdayContactWritable|Property used to indicate whether or not the contact associated with the birthday event is writable.| -|IsCancelled|Bool value whether or not the meeting is cancelled.| +|IntendedFreeBusyStatus|The intended free/busy status of the meeting.| +|InternetMessageId|Internet Message ID of the e-mail message.| +|IsAllDayEvent|Indicates whether this appointment is an all day event.| +|IsBirthdayContactWritable|Indicates whether the contact that's associated with the birthday event is writable.| +|IsCancelled|Boolean value indicating whether the meeting is canceled.| |IsCopyOnWriteItem|Indicator for Calendar Logging items.| -|IsDraft|Bool value indicating whether the item is is a draft. An item is a draft when it has not yet been sent.| -|IsEvent|Indicates if the meeting should be displayed in banner for event, not calendar grid area.| -|IsException|Value indicating whether the calendar event is an exception in a recurring series.| -|IsHiddenFromLegacyClients|Flag deciding whether modern calendar item should be hidden for legacy clients.| -|IsMeetingPollEvent|Is meeting poll event boolean flag.| -|IsMeeting|Value indicating whether the calendar event is a meeting.| -|IsProcessed|True if the message has been processed either by XSO or by Outlook.| -|IsPublishedCalendarItem|Whether a calendar event (schedule) has been published.| -|IsRecurring|Value indicating whether the calendar event is recurring.| -|IsResponseRequested|Value indicating whether responses are requested when invitations are sent for this meeting.| -|IsSeriesCancelled|Expected to be true for the attendee if the recurring master is cancelled.| -|IsSilent|Returns True if the response doesn't contain any body text.| -|IsSingleBodyICal|Indicates that the original MIME message contained a single MIME part.| -|IsSoftDeleted|True only if the object is soft-deleted.| -|ItemClass|Contains a text string that identifies the sender-defined message class, such as IPM.Note.| +|IsDraft|Boolean value indicating whether the item is a draft. An item is a draft when it hasn't yet been sent.| +|IsEvent|Indicates if the meeting should be displayed in a banner for the event, not in the calendar grid area.| +|IsException|Indicates whether the calendar event is an exception in a recurring series.| +|IsHiddenFromLegacyClients|Decides whether the modern calendar item should be hidden for legacy clients.| +|IsMeetingPollEvent|Boolean value indicating whether the item is a meeting poll event.| +|IsMeeting|Boolean value indicating whether the calendar event is a meeting.| +|IsProcessed|Boolean value indicating whether the message was processed by XSO or by Outlook.| +|IsPublishedCalendarItem|Boolean value indicating whether a calendar event (schedule) has been published.| +|IsRecurring|Boolean value indicating whether the calendar event is recurring.| +|IsResponseRequested|Boolean value indicating whether responses are requested when invitations are sent for this meeting.| +|IsSeriesCancelled|Boolean value indicating whether the recurring master is canceled. Expected to be True for the attendee.| +|IsSilent|Boolean value indicating if the response doesn't contain message body text.| +|IsSingleBodyICal|Boolean value indicating that the original MIME message contained a single MIME part.| +|IsSoftDeleted|Boolean value indicating if the object is soft-deleted.| +|ItemClass|A text string that identifies the sender-defined message class (for example, IPM.Note).| |ItemId|Object Store ItemId.| |ItemVersion|Version of the item.| -|LastModifiedTime|Gets the date and time this item was last modified.| +|LastModifiedTime|The date/time that this item was last modified.| |LocationAddressInternal|One of the properties that define the enhanced location and their corresponding default values.| |Location|Gets the location of the calendar event.| |MFNAddedRecipients|The list of recipients that were explicitly forwarded.| -|MailboxDatabaseName|Mailbox Database Exchange DistinguishedName.| +|MailboxDatabaseName|The distinguished name (DN) of the mailbox database.| |MapiEndTime|EndTime of Meeting.| |MapiIsAllDayEvent|An all-day event is midnight to midnight.| |MapiPREndDate|MapiPR(Pattern Recurrence) EndDate of Meeting.| |MapiPRStartDate|MapiPR(Pattern Recurrence) StartDate of Meeting.| |MapiStartTime|StartTime of Meeting.| -|MasterGlobalObjectId|Holds the original GUID of the item in case another process needs to change it.| +|MasterGlobalObjectId|The original GUID of the item if another process needs to change it.| |MeetingRequestType|Defines the type of meeting request.| -|MeetingRequestWasSent|Value indicating whether the meeting request has already been sent.| -|MeetingUniqueId|Meeting unique ID used to link meeting history to master meeting item.| -|MeetingWorkspaceUrl|URL of the meeting workspace. A meeting workspace is a shared Web site for planning meetings and tracking results.| +|MeetingRequestWasSent|Indicates whether the meeting request has already been sent.| +|MeetingUniqueId|Unique meeting ID that's used to link meeting history to the master meeting item.| +|MeetingWorkspaceUrl|URL of the meeting workspace. A meeting workspace is a shared website for planning meetings and tracking results.| |MiddleTierProcessName|ProcessName handling the request (for example, w3wp).| |MiddleTierServerBuildVersion|EXO Build Version.| |MiddleTierServerName|Backend Mailbox ServerName.| |NormalizedSubject|Subject of the meeting.| |OccurrencesExceptionalViewProperties|Blob representing the exceptional properties of instances of an NPR.| -|OldLocation|Saved old location before updating new location.| +|OldLocation|Saved old location before updating the new location.| |OldStartWhole|Old time properties on the updated meeting request.| |OnlineMeetingConfLink|The online meeting link.| |OnlineMeetingExternalLink|The online meeting external link.| |OnlineMeetingInformation|The online meeting information.| -|OnlineMeetingInternalLink|Represents the https uri for joining the Lync online meeting. Deprecated.| -|OriginalClientInfoString|Some processes are touching the ClientInfoString, so we need to backup the original value for Calendar Logging items.| +|OnlineMeetingInternalLink|The HTTPS URI for joining the Lync online meeting. Deprecated.| +|OriginalClientInfoString|Some processes are touching the ClientInfoString, so we need to back up the original value for Calendar Logging items.| |OriginalCreationTime|Creation time of the item.| -|OriginalEntryId|Original `PR_ENTRYID` (MAPI), unique Id identifier in store.| -|OriginalFolderId|Original `PR_FOLDERID` (MAPI), unique Id identifier in store.| -|OriginalGlobalObjectId|Holds the original GUID of the item in case we have to change it.| -|OriginalICal|Holds the original iCal of an imported item.| +|OriginalEntryId|Original `PR_ENTRYID` (MAPI), unique ID identifier in store.| +|OriginalFolderId|Original `PR_FOLDERID` (MAPI), unique ID identifier in store.| +|OriginalGlobalObjectId|The original GUID of the item in case we have to change it.| +|OriginalICal|The original iCal of an imported item.| |OriginalLastModifiedTime|Used as the primary sort field to order the events.| |OriginalMeetingType|Retains the original MeetingType in case the original meeting type is reset.| -|OriginalStoreEntryId|Maintains a copy of the store entry id if the original gets modified.| -|OwnerAppointmentID|This property is supposed to be a number that is unique to the sender's calendar. Outlook uses this number to correlate meeting messages with calendar items.| +|OriginalStoreEntryId|Maintains a copy of the store entry ID if the original gets modified.| +|OwnerAppointmentID|A number that's unique to the sender's calendar. Outlook uses this number to correlate meeting messages with calendar items.| |OwnerCriticalChangeTime|DateTime tracking value for Owner Critical Change Time.| |ParentDisplayName|ParentDisplayName of the Folder.| -|ParkedCorrelationId|Holds correlation id of parked message.| -|ParkedMessagesFolderEntryId|Holds the entry id of ParkedMessages folder.| -|Preview|Preview of the Email.| +|ParkedCorrelationId|The correlation ID of parked message.| +|ParkedMessagesFolderEntryId|The entry ID of the ParkedMessages folder.| +|Preview|Preview of the email message.| |PropertyChangeMetadataProcessingFlags|Flags representing property change metadata processing behavior.| |PropertyChangeMetadataRaw|Blob representing property change metadata for Series exception management purposes.| -|PublishedCalendarItemUrl|The url for a published calendar event (schedule).| -|RawAttendeeInformation|Stores raw attendee information provided by a client, to help troubleshoot and debug attendee translation issues.| -|ReceivedBy|Gets the ReceivedBy property of the e-mail message.| -|ReceivedRepresenting|Returns received on behalf display name for delegate meeting message own meeting.| -|RecipientType|Represents the recipient type of a recipient on the message.| +|PublishedCalendarItemUrl|The URL of a published calendar event (schedule).| +|RawAttendeeInformation|Raw attendee information provided by a client. Used to help troubleshoot and debug attendee translation issues.| +|ReceivedBy|The ReceivedBy property of the email message.| +|ReceivedRepresenting|Returns the received on behalf display name for delegate meeting message own meeting.| +|RecipientType|The recipient type of a recipient on the message.| |RecurrencePattern|A date for which this pattern should be created.| -|ReminderIsSetInternal|True or False.| +|ReminderIsSetInternal|Boolean value indicating whether the reminder is set internally.| |ReminderMinutesBeforeStartInternal|Reminder in minutes before the meeting starts.| -|ResponseState|Accepted, Tentative, Declined Response State.| +|ResponseState|Values are Accepted, Tentative, or Declined.| |ResponseType|Gets the type of response the attendee gave to the meeting invitation it received.| |ResponsibleUserName|The LegacyExchangeDN value of the user who made the change (for example, `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=BN6PR11MB1587/cn=Microsoft System Attendant` or `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=696eea97d3c449eab648920d03385efb-admin`).| -|SenderEmailAddress|SMTP Address who sent it.| -|Sensitivity|Defines the sensitivity of an item.| +|SenderEmailAddress|SMTP address of who sent it.| +|Sensitivity|The sensitivity of an item.| |SentRepresentingDisplayName|The display name of the sent representing person.| |SentRepresentingEmailAddress|Represents sent representing email address.| -|SentRepresentingEntryId|The entry id of the the sent representing person.| +|SentRepresentingEntryId|The entry ID of the sent representing person.| |SentRepresentingType|The address type of the sent representing person.| -|SeriesId|String representing id for series of calendar events.| -|SeriesReminderIsSet|Flag indicating whether reminder is set for the whole series.| -|Size|Size in Bytes of the Meeting Message.| -|SkypeTeamsMeetingUrl|The meeting url for Teams meeting.| -|SkypeTeamsProperties|The relevant properties for Teams meeting.| +|SeriesId|Representing ID for series of calendar events.| +|SeriesReminderIsSet|Flag indicating whether a reminder is set for the whole series.| +|Size|Size in bytes of the Meeting Message.| +|SkypeTeamsMeetingUrl|The meeting URL for a Teams meeting.| +|SkypeTeamsProperties|The relevant properties for a Teams meeting.| |StartTimeZoneId|Time zone of the start of the meeting.| |StartTimeZone|Start timezone of a calendar item.| |StartTime|Start time of a calendar item.| |StartWallClock|The start time of the meeting expressed in the time zone of the meeting.| -|SuggestionCategory|Represents the suggestion category for the message.| -|TimeZoneBlob|Outlook time zone blob (from registry) for recurrence.| +|SuggestionCategory|The suggestion category for the message.| +|TimeZoneBlob|Outlook time zone blob (from the registry) for recurrence.| |TimeZoneDefinitionEnd|Legacy time zone (ExchangeTimeZoneTime) blob for end time.| |TimeZoneDefinitionRecurring|Legacy time zone (ExchangeTimeZoneTime) blob for recurrence.| |TimeZoneDefinitionStart|Legacy time zone (ExchangeTimeZoneTime) blob for start time.| |TimeZone|TimeZone value.| |TransportMessageHeaders|Transport Message Header Information.| -|UCCapabilities|Represents the XML blob of OCS capabilities for the Lync online meeting.| -|UCInband|Represents the XML blob of Inband data for the Lync online meeting.| -|UCMeetingSettingSent|Represents the XML blob of all information related to the Lync online meeting.| -|UCMeetingSetting|Represents the XML blob of all information related to the Lync online meeting.| -|UCOpenedConferenceID|Represents the guid associated with this online meeting.| -|UnsendableRecipients|This property contains the recipient data for all unsendable recipients.| +|UCCapabilities|The XML blob of OCS capabilities for the Lync online meeting.| +|UCInband|The XML blob of Inband data for the Lync online meeting.| +|UCMeetingSettingSent|The XML blob of all information related to the Lync online meeting.| +|UCMeetingSetting|The XML blob of all information related to the Lync online meeting.| +|UCOpenedConferenceID|RThe guid associated with this online meeting.| +|UnsendableRecipients|Recipient data for all unsendable recipients.| |ViewEndTime|End time of a calendar item.| |ViewStartTime|Start time of a calendar item.| -|When|The text returned by When is localized using the Exchange Server culture or using the culture specified in the PreferredCulture property of the ExchangeService object this appointment is bound to.| -| +|When|Localized text using the Exchange Server culture or the culture specified in the PreferredCulture property of the ExchangeService object that this appointment is bound to.| diff --git a/exchange/docs-conceptual/whats-new-in-the-exo-module.md b/exchange/docs-conceptual/whats-new-in-the-exo-module.md new file mode 100644 index 0000000000..64e027b733 --- /dev/null +++ b/exchange/docs-conceptual/whats-new-in-the-exo-module.md @@ -0,0 +1,126 @@ +--- +title: What's new in the Exchange Online PowerShell module +ms.author: chrisda +author: chrisda +manager: deniseb +ms.date: 03/26/2025 +ms.audience: Admin +audience: Admin +ms.topic: article +ms.service: exchange-online +ms.reviewer: +ms.localizationpriority: medium +ms.collection: Strat_EX_Admin +ms.custom: +ms.assetid: +search.appverid: MET150 +keywords: what's new in exchange online powershell, what's new in security & compliance powershell, EXO V2 module, EXO V3 module +description: "Learn about the new features and functionality available in the latest release of the Exchange Online PowerShell module." +--- + +# What's new in the Exchange Online PowerShell module + +This article lists new features in the Exchange Online PowerShell module that's used for connecting to Exchange Online PowerShell, Security & Compliance PowerShell, and standalone Exchange Online Protection (EOP) PowerShell. Features that are currently in preview are denoted with **(preview)**. + +## March 2025 + +- [Version 3.7.2](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.7.1) + + For information about what's in this release, see [Version 3.7.2](exchange-online-powershell-v2.md#version-372). + +## January 2025 + +- [Version 3.7.1](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.7.1) + + For information about what's in this release, see [Version 3.7.1](exchange-online-powershell-v2.md#version-371). + +## December 2024 + +- [Version 3.7.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.7.0) + + Starting with this version of the module, command line help for Exchange Online PowerShell cmdlets is no longer loaded by default. Use the _LoadCmdletHelp_ parameter in the **Connect-ExchangeOnline** command so help for Exchange Online PowerShell cmdlets is available to the **Get-Help** cmdlet. + + For information about what's in this release, see [Version 3.7.0](exchange-online-powershell-v2.md#version-370). + +## September 2024 + +- [Version 3.6.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.6.0) + + For information about what's in this release, see [Version 3.6.0](exchange-online-powershell-v2.md#version-360). + +## July 2024 + +- [Version 3.5.1](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.5.1) has been released. + + For information about what's in this release, see [Version 3.5.1](exchange-online-powershell-v2.md#version-351). + +## May 2024 + +- [Version 3.5.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.5.0) has been released. + + For information about what's in this release, see [Version 3.5.0](exchange-online-powershell-v2.md#version-350). + +## October 2023 + +- [Version 3.4.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.4.0) + + For information about what's in this release, see [Version 3.4.0](exchange-online-powershell-v2.md#version-340). + +## September 2023 + +- [Version 3.3.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.3.0) has been released. + + For information about what's in this release, see [Version 3.3.0](exchange-online-powershell-v2.md#version-330). + +## June 2023 + +- [Version 3.2.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0) has been released. + +- [Virtually all](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432) Security & Compliance PowerShell cmdlets are now backed by the REST API, and REST API is used by default. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. + + For information about what's in this release, see [Version 3.2.0](exchange-online-powershell-v2.md#version-320). + +## May 2023 + +- The end of support for remote PowerShell in Security & Compliance PowerShell has been announced. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). + +- [Version 3.2.0-Preview4](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview4) has been released. + + This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Some, but not all cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets. + + > [!NOTE] + > The default value of the _UseRPSSession_ switch in **Connect-IPSSession** is now the same as **Connect-ExchangeOnline**. To connect in REST API mode, don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. + > + > REST API connections in the EXO V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + +## April 2023 + +- [Version 3.2.0-Preview3](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.2.0-Preview3) has been released. + + This version supports the Preview of Security & Compliance cmdlets backed by the REST API. Some, but not all cmdlets are supported. Basic authentication in WinRM is not required in Security & Compliance PowerShell for REST API cmdlets. + + > [!NOTE] + > The default value of the _UseRPSSession_ switch in **Connect-IPSSession** is opposite of **Connect-ExchangeOnline**. To connect in REST API mode, use `-UseRPSSession:$false` in the **Connect-IPPSSession** command. To connect using remote PowerShell mode (which requires [Basic authentication in WinRM](exchange-online-powershell-v2.md#turn-on-basic-authentication-in-winrm)), don't use the _UseRPSSession_ switch in the **Connect-IPPSSession** command. The default behavior will change in a later version of the module as more Security & Compliance cmdlets are available in REST API mode. + +## January 2023 + +- [Version 3.1.0](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/3.1.0) has been released. + + For information about what's in this release, see [Version 3.1.0](exchange-online-powershell-v2.md#version-310). + +## December 2022 + +- The end of support for remote PowerShell in Exchange Online PowerShell (not in Security & Compliance PowerShell) has been announced. For more information, see [Announcing Deprecation of Remote PowerShell (RPS) Protocol in Exchange Online PowerShell](https://aka.ms/RPSDeprecation). + +## September 2022 + +- Version 3.0.0 has been released, and is now known as the Exchange Online PowerShell V3 module (abbreviated as the EXO V3 module): + - Version 3.0.0 is the Generally Availability (GA) release of the 2.0.6-PreviewX versions of the module. + - All Exchange Online PowerShell cmdlets are now backed by the REST API. Basic authentication in WinRM is not required in Exchange Online PowerShell for REST API cmdlets. + + > [!TIP] + > REST API connections in the EXO V3 module require the PowerShellGet and PackageManagement modules. For more information, see [PowerShellGet for REST-based connections in Windows](exchange-online-powershell-v2.md#powershellget-for-rest-api-connections-in-windows). + + - Certificate based authentication (also known as CBA or app-only authentication) is available for Security & Compliance PowerShell. + + For more information, see [REST API connections in the EXO V3 module](exchange-online-powershell-v2.md#rest-api-connections-in-the-exo-v3-module) and [Version 3.0.0](exchange-online-powershell-v2.md#version-300-preview-versions-known-as-v206-previewx). diff --git a/exchange/exchange-ps/exchange/Add-ADPermission.md b/exchange/exchange-ps/exchange/Add-ADPermission.md index 206ff3125d..c1daf4b98b 100644 --- a/exchange/exchange-ps/exchange/Add-ADPermission.md +++ b/exchange/exchange-ps/exchange/Add-ADPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-adpermission +online version: https://learn.microsoft.com/powershell/module/exchange/add-adpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Add-ADPermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Add-ADPermission cmdlet to add permissions to an Active Directory object. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -63,9 +63,9 @@ Add-ADPermission [[-Identity] ] -Instance -Type ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://docs.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -147,12 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md index 9254bc96d0..aedd7aee1a 100644 --- a/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/exchange/Add-AvailabilityAddressSpace.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-availabilityaddressspace +online version: https://learn.microsoft.com/powershell/module/exchange/add-availabilityaddressspace applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Add-AvailabilityAddressSpace schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Add-AvailabilityAddressSpace cmdlet to create availability address space The maximum number off Availability address spaces returned by Active Directory to Exchange is 100. We recommend using 100 or fewer address spaces in order for Availability lookups to work properly. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,6 +29,8 @@ Add-AvailabilityAddressSpace -AccessMethod -ForestNam [-DomainController ] [-ProxyUrl ] [-TargetAutodiscoverEpr ] + [-TargetServiceEpr ] + [-TargetTenantId ] [-UseServiceAccount ] [-WhatIf] [] @@ -37,30 +39,37 @@ Add-AvailabilityAddressSpace -AccessMethod -ForestNam ## DESCRIPTION In Exchange Online, you need to run the New-AvailabilityConfig cmdlet before you run the Add-AvailabilityAddressSpace cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Add-AvailabilityAddressSpace -ForestName example.contoso.com -AccessMethod OrgWideFB -Credentials (Get-Credential) +Add-AvailabilityAddressSpace -ForestName contoso.com -AccessMethod OrgWideFB -Credentials (Get-Credential) ``` -This example is useful with an untrusted cross-forest Availability service, or if detailed cross-forest free/busy service isn't desired. Enter a username and password when you're prompted by the command. For an untrusted cross-forest configuration, make sure that the user doesn't have a mailbox. +In on-premises Exchange, this example is useful with an untrusted cross-forest Availability service, or if detailed cross-forest free/busy service isn't desired. Enter a username and password when you're prompted by the command. For an untrusted cross-forest configuration, make sure that the user doesn't have a mailbox. ### Example 2 ```powershell -Add-AvailabilityAddressSpace -ForestName example.contoso.com -AccessMethod PerUserFB -Credentials (Get-Credential) +Add-AvailabilityAddressSpace -ForestName contoso.com -AccessMethod PerUserFB -Credentials (Get-Credential) ``` -This example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest, and the specified account connects to the contoso.com forest. The specified account must be an existing account in the contoso.com forest. +In on-premises Exchange, this example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest, and the specified account connects to the contoso.com forest. The specified account must be an existing account in the contoso.com forest. ### Example 3 ```powershell -Add-AvailabilityAddressSpace -ForestName example.contoso.com -AccessMethod PerUserFB -UseServiceAccount $true +Add-AvailabilityAddressSpace -ForestName contoso.com -AccessMethod PerUserFB -UseServiceAccount $true ``` -This example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest and uses the service account (typically the local system account or the computer account) to connect to the contoso.com forest. Because the service is trusted, there is no issue with authorization when the current forest tries to retrieve free/busy information from contoso.com. +In on-premises Exchange, this example is useful with a trusted cross-forest Availability service. The contoso.com forest trusts the current forest and uses the service account (typically the local system account or the computer account) to connect to the contoso.com forest. Because the service is trusted, there is no issue with authorization when the current forest tries to retrieve free/busy information from contoso.com. + +### Example 4 +```powershell +Add-AvailabilityAddressSpace -ForestName contoso.onmicrosoft.com -AccessMethod OrgWideFBToken -TargetTenantId "9d341953-da1f-41b0-8810-76d6ef905273" -TargetServiceEpr "outlook.office.com" +``` + +In Exchange Online, this example sets up the sharing of free/busy information with contoso.onmicrosoft.com (tenant ID value 9d341953-da1f-41b0-8810-76d6ef905273), which is a regular Microsoft 365 organization. ## PARAMETERS @@ -69,8 +78,8 @@ The AccessMethod parameter specifies how the free/busy data is accessed. Valid v - PerUserFB: Per-user free/busy information can be requested. The free/busy data is accessed in the defined per-user free/busy proxy account or group, or in the All Exchange Servers group. This value requires a trust between the two forests, and requires you to use either the UseServiceAccount parameter or Credentials parameter. - OrgWideFB: Only default free/busy for each user can be requested. The free/busy data is accessed in the per-user free/busy proxy account or group in the target forest. This value requires you to use either the UseServiceAccount parameter or Credentials parameter. -- OrgWideFBBasic: This value is reserved for internal Microsoft use. -- InternalProxy: The request is proxied to an Exchange in the site that has a later version of Exchange. +- OrgWideFBBasic: Free/busy sharing between tenants that are all in Exchange Online. +- InternalProxy: The request is proxied to an Exchange server in the site that's running a later version of Exchange. - PublicFolder: This value was used to access free/busy data on Exchange Server 2003 servers. ```yaml @@ -87,7 +96,7 @@ Accept wildcard characters: False ``` ### -ForestName -The ForestName parameter specifies the SMTP domain name of the target forest for users whose free/busy data must be retrieved. If your users are distributed among multiple SMTP domains in the target forest, run the Add-AvailabilityAddressSpace command once for each SMTP domain. +The ForestName parameter specifies the SMTP domain name of the target forest that contains the users you're trying to read free/busy information from. If users are distributed among multiple SMTP domains in the target forest, run the Add-AvailabilityAddressSpace command once for each SMTP domain. ```yaml Type: String @@ -124,7 +133,7 @@ Accept wildcard characters: False ### -Credentials The Credentials parameter specifies the username and password that's used to access the Availability services in the target forest. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -160,9 +169,9 @@ Accept wildcard characters: False ### -ProxyUrl This parameter is available only in on-premises Exchange. -The ProxyUrl parameter was used to specify the URL that directed an Exchange 2007 Client Access server to proxy its free/busy requests through an Exchange 2010 or Exchange 2013 Client Access server when requesting federated free/busy data for a user in another organization. When you used this parameter, you needed to set the value of the AccessMethod parameter to InternalProxy. +The ProxyUrl parameter was used to specify the URL that directed an Exchange 2007 Client Access server to proxy free/busy requests through an Exchange 2010 or Exchange 2013 Client Access server when requesting federated free/busy data for a user in another organization. When you used this parameter, you needed to set the AccessMethod parameter value to InternalProxy. -This parameter required that you created the proper trust relationships and sharing relationships between the Exchange organizations. For more information, see [New-FederationTrust](https://docs.microsoft.com/powershell/module/exchange/new-federationtrust). +This parameter required that you created the proper trust relationships and sharing relationships between the Exchange organizations. For more information, see [New-FederationTrust](https://learn.microsoft.com/powershell/module/exchange/new-federationtrust). ```yaml Type: Uri @@ -178,7 +187,7 @@ Accept wildcard characters: False ``` ### -TargetAutodiscoverEpr -The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, `https://contoso.com/autodiscover/autodiscover.xml`. Exchange uses Autodiscover to automatically detect the correct server endpoint for external requests. +The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization that you're trying to read free/busy information from. For example, `https://contoso.com/autodiscover/autodiscover.xml`. Exchange uses Autodiscover to automatically detect the correct server endpoint for external requests. ```yaml Type: Uri @@ -193,6 +202,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetServiceEpr +This parameter is available only in the cloud-based service. + +The TargetServiceEpr parameter specifies the Exchange Online Calendar Service URL of the external Microsoft 365 organization that you're trying to read free/busy information from. Valid values are: + +- Microsoft 365 or Microsoft 365 GCC: outlook.office.com +- Office 365 operated by 21Vianet: partner.outlook.cn +- Microsoft 365 GCC High or DoD: outlook.office365.us + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetTenantId +This parameter is available only in the cloud-based service. + +The TargetTenantID parameter specifies the tenant ID of the external Microsoft 365 organization that you're trying to read free/busy information from. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UseServiceAccount This parameter is available only in on-premises Exchange. @@ -235,12 +284,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md index a0a324b063..ddec608aad 100644 --- a/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Add-ComplianceCaseMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-compliancecasemember -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/add-compliancecasemember +applicable: Security & Compliance title: Add-ComplianceCaseMember schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Add-ComplianceCaseMember ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Add-ComplianceCaseMember cmdlet to add an individual member to an eDiscovery case in the Microsoft 365 compliance center. To replace all existing members, use the Update-ComplianceCaseMember cmdlet. +Use the Add-ComplianceCaseMember cmdlet to add an individual member to an eDiscovery case in the Microsoft Purview compliance portal. To replace all existing members, use the Update-ComplianceCaseMember cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ To add a member of an eDiscovery case, the user needs to be a member of the Revi - Create and edit compliance searches associated with a case. - Perform compliance actions (for example, export) on the results of a compliance search. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -58,7 +58,7 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -79,7 +79,7 @@ The Member parameter specifies the user that you want to add to the eDiscovery c Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -98,7 +98,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -108,13 +108,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -128,12 +128,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md index 8eb5a66996..72bcef12ec 100644 --- a/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md +++ b/exchange/exchange-ps/exchange/Add-ContentFilterPhrase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-contentfilterphrase +online version: https://learn.microsoft.com/powershell/module/exchange/add-contentfilterphrase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Add-ContentFilterPhrase schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Add-ContentFilterPhrase cmdlet to define custom words for the Content Filter agent. A custom word is a word or phrase that the administrator sets for the Content Filter agent to evaluate the content of an message and apply appropriate filter processing. +Use the Add-ContentFilterPhrase cmdlet to define custom words for the Content Filter agent. A custom word is a word or phrase that the administrator sets for the Content Filter agent to evaluate the content of an message and apply appropriate filter processing. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Add-ContentFilterPhrase [-Phrase] -Influence ## DESCRIPTION The Add-ContentFilterPhrase cmdlet adds phrases to the Allow or Block phrases list. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -136,12 +136,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md b/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md index ea4414b59b..d1e4a31542 100644 --- a/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md +++ b/exchange/exchange-ps/exchange/Add-DatabaseAvailabilityGroupServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-databaseavailabilitygroupserver +online version: https://learn.microsoft.com/powershell/module/exchange/add-databaseavailabilitygroupserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Add-DatabaseAvailabilityGroupServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Add-DatabaseAvailabilityGroupServer cmdlet to add a Mailbox server to a database availability group (DAG). A DAG is a set of Mailbox servers that use continuous replication and managed availability to provide automatic database-level recovery from database, server, or network failures. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ To add a Mailbox server to a DAG, the Mailbox server must be running the Windows To add the first server to a DAG and create a computer object for the DAG, the Exchange Windows Permissions security group must have the appropriate rights to add computer accounts to the domain. Alternatively, a computer account can be created and disabled prior to adding the server. Adding the first server to the DAG enables the computer account for the DAG. Thus, the account used for the task doesn't need permissions to add a computer account to the domain. If you're pre-creating the computer account, the name of the account must match the name for the DAG. For example, if the DAG is named DAG1, the computer account must be named DAG1. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,7 +122,7 @@ Accept wildcard characters: False ``` ### -SkipDagValidation -The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when adding members to the DAG. +The SkipDagValidation switch specifies whether to bypass the validation of the DAG's quorum model and the health check on the DAG's witness when adding members to the DAG. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -158,12 +158,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md index 231c034452..90029ad72b 100644 --- a/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Add-DistributionGroupMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-distributiongroupmember +online version: https://learn.microsoft.com/powershell/module/exchange/add-distributiongroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Add-DistributionGroupMember schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Add-DistributionGroupMember cmdlet to add a single recipient to distribution groups and mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Add-DistributionGroupMember [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,13 +68,13 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -171,12 +171,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-FederatedDomain.md b/exchange/exchange-ps/exchange/Add-FederatedDomain.md index 46e0fb768c..1a193dfead 100644 --- a/exchange/exchange-ps/exchange/Add-FederatedDomain.md +++ b/exchange/exchange-ps/exchange/Add-FederatedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-federateddomain +online version: https://learn.microsoft.com/powershell/module/exchange/add-federateddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Add-FederatedDomain schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Add-FederatedDomain cmdlet to configure a secondary domain with the fede The domains being added to the federation trust must exist as accepted domains in the Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,9 +33,9 @@ Add-FederatedDomain [[-Identity] ] -DomainName -ItemType -AccessRights ## DESCRIPTION To modify the permissions that are assigned to the user on a mailbox folder, use the Set-MailboxFolderPermission cmdlet. To remove all permissions that are assigned to a user on a mailbox folder, use the Remove-MailboxFolderPermission cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -98,6 +98,7 @@ You can specify individual folder permissions or roles, which are combinations o The following individual permissions are available: +- None: The user has no access to view or interact with the folder or its contents. - CreateItems: The user can create items within the specified folder. - CreateSubfolders: The user can create subfolders in the specified folder. - DeleteAllItems: The user can delete all items in the specified folder. @@ -114,7 +115,6 @@ The roles that are available, along with the permissions that they assign, are d - Author: CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems - Contributor: CreateItems, FolderVisible - Editor: CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems -- None: FolderVisible - NonEditingAuthor: CreateItems, DeleteOwnedItems, FolderVisible, ReadItems - Owner: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems - PublishingAuthor: CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems @@ -126,6 +126,8 @@ The following roles apply specifically to calendar folders: - AvailabilityOnly: View only availability data - LimitedDetails: View availability data with subject and location +When the Editor role is applied to calendar folders, delegates can accept or decline meetings by manually selecting the meeting request in the mailbox. In Exchange Online, to send meeting requests to delegates where they can accept or decline meetings, also use the SharingPermissionFlags parameter with the value Delegate. + ```yaml Type: MailboxFolderAccessRight[] Parameter Sets: (All) @@ -144,9 +146,14 @@ The User parameter specifies who's granted permission to the mailbox folder. Val - User mailboxes - Mail users -- Mail-enabled security groups +- Mail-enabled security groups (including nested mail-enabled security groups) + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. -You can use any value that uniquely identifies the user or group. For example: +Otherwise, you can use any value that uniquely identifies the user or group. For example: - Name - Alias @@ -244,7 +251,7 @@ The SharingPermissionFlags parameter assigns calendar delegate permissions. This You can specify multiple values separated by commas. -**Note**: You can't configure the **Deliver meeting requests addressed to me and responses to meeting requests where I am the organizer to** Outlook setting in PowerShell. But, you can configure the setting using Exchange Web Services (EWS). For more information, see [MeetingRequestsDeliveryScope Enum](https://docs.microsoft.com/dotnet/api/microsoft.exchange.webservices.data.meetingrequestsdeliveryscope). +**Note**: You can't configure the **Deliver meeting requests addressed to me and responses to meeting requests where I am the organizer to** Outlook setting in PowerShell. But, you can configure the setting using Exchange Web Services (EWS). For more information, see [MeetingRequestsDeliveryScope Enum](https://learn.microsoft.com/dotnet/api/microsoft.exchange.webservices.data.meetingrequestsdeliveryscope). ```yaml Type: MailboxFolderPermissionFlags @@ -280,22 +287,22 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS -[Get-MailboxFolderPermission](Get-MailboxFolderPermission.md) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](Set-MailboxFolderPermission.md) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](Remove-MailboxFolderPermission.md) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](Get-EXOMailboxFolderPermission.md) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Add-MailboxPermission.md b/exchange/exchange-ps/exchange/Add-MailboxPermission.md index a3f15e6b88..07ab0e946e 100644 --- a/exchange/exchange-ps/exchange/Add-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Add-MailboxPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-mailboxpermission +online version: https://learn.microsoft.com/powershell/module/exchange/add-mailboxpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Add-MailboxPermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Add-MailboxPermission cmdlet to add permissions to a mailbox or to an Exchange Server 2016, Exchange Server 2019, or Exchange Online mail user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,9 +62,11 @@ Add-MailboxPermission [[-Identity] ] -Instance [!NOTE] +> You can use this cmdlet to add a maximum of 500 permission entries (ACEs) to a mailbox. To grant permissions to more than 500 users, use security groups instead of individual users for the User parameter. Security groups contain many members, but only count as one entry. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -238,9 +240,16 @@ The User parameter specifies who gets the permissions on the mailbox. You can sp - Mailbox users - Mail users -- Security groups +- Mail-enabled security groups (non-mail-enabled security groups are selectable, but they don't work) -You can use any value that uniquely identifies the user or group. For example: +**Note**: When a mail-enabled security group is used to specify Full Access permissions, the auto-mapping feature won't automatically add the mailbox in Outlook for the group member. For more information, see [Mailboxes to which your account has full access aren't automapped to Outlook profile](https://learn.microsoft.com/outlook/troubleshoot/profiles-and-accounts/full-access-mailbox-not-automapped-outlook-profile). + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: - Name - Alias @@ -282,12 +291,12 @@ Accept wildcard characters: False ``` ### -AutoMapping -The AutoMapping parameter specifies whether to enable or disable the auto-mapping feature in Microsoft Outlook that uses Autodiscover to automatically open other mailboxes for the user. Valid values are: +The AutoMapping parameter includes or excludes the mailbox from the auto-mapping feature in Microsoft Outlook. Auto-mapping uses Autodiscover to automatically add mailboxes to a user's Outlook profile if the user has Full Access permission to the mailbox. However, Autodiscover won't enumerate security groups that are given Full Access permission to the mailbox. Valid values are: -- $true: Outlook automatically opens the mailbox where the user is assigned Full Access permission. This is the default value. -- $false: Outlook doesn't automatically open the mailbox where the user is assigned Full Access permission. +- $true: The mailbox is automatically added to the user's Outlook profile if the user has Full Access permission. This is the default value. +- $false: The mailbox is not automatically added to the user's Outlook profile if the user has Full Access permission. -If you've already assign the user Full Access to the mailbox, and you want to prevent the mailbox from automatically opening in the user's Outlook, you need to remove the user's Full Access permission by using the Remove-MailboxPermission cmdlet, and then assign the permission to the user on the mailbox again, but this time include -AutoMapping $false in the command. +**Note**: To disable auto-mapping for a mailbox where the user was already assigned Full Access permission, you need to remove the user's Full Access permission by using the Remove-MailboxPermission cmdlet, and then reassign the user Full Access permission on the mailbox using the AutoMapping parameter with the value $false. ```yaml Type: Boolean @@ -322,7 +331,7 @@ Accept wildcard characters: False ``` ### -Deny -The Deny switch specifies whether to deny the specified permissions to the user on the mailbox. You don't need to specify a value with this switch. +The Deny switch specifies that the permissions you're adding are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -374,9 +383,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -397,9 +406,10 @@ Accept wildcard characters: False ### -InheritanceType The InheritanceType parameter specifies how permissions are inherited by folders in the mailbox. Valid values are: -- All +- None +- All (this is the default value) - Children -- Descendents[sic] +- Descendents [sic] - SelfAndChildren ```yaml @@ -410,7 +420,7 @@ Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Ex Required: False Position: Named -Default value: None +Default value: All Accept pipeline input: False Accept wildcard characters: False ``` @@ -436,12 +446,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md index c267d450c5..6b98323cb7 100644 --- a/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Add-ManagementRoleEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-managementroleentry +online version: https://learn.microsoft.com/powershell/module/exchange/add-managementroleentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Add-ManagementRoleEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Add-ManagementRoleEntry cmdlet to add management role entries to an existing management role. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -51,9 +51,9 @@ The cmdlet and its parameters that you add to a role entry must exist in the par You can only add a role entry to a management role if the role entry exists in the role's parent role. For example, if you try to add the Search-Mailbox role entry to a role that's a child of the Mail Recipients role, you'll receive an error. This error occurs because the Search-Mailbox role entry doesn't exist in the Mail Recipients role. To add the Search-Mailbox role entry to a role, you need to create a role that's a child of the Mailbox Import Export role, which contains the Search-Mailbox role entry. Then you can use the Add-ManagementRoleEntry cmdlet to add the Search-Mailbox role entry to the new child role. -For more information about management role entries, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about management role entries, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,7 +90,7 @@ In on-premises Exchange, this example adds the MailboxAudit script with the Depa ### -Identity The Identity parameter specifies the role entry that you want to add. This parameter uses the syntax: `Management role\role entry name` (for example, `CustomRole\Set-Mailbox`). -For more information about how management role entries work, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). The role entry you want to add must exist in the parent role. If the role entry name contains spaces, you must enclose the name in quotation marks ("). @@ -179,7 +179,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -195,7 +197,7 @@ Accept wildcard characters: False ``` ### -Overwrite -The Overwrite parameter causes existing role entries to be overwritten by the role entries being added. +The Overwrite switch causes existing role entries to be overwritten by the role entries being added. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -261,13 +263,13 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. +This parameter is available only in on-premises Exchange. -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). The UnScopedTopLevel switch specifies that you're adding the role entry to an unscoped top-level management role. You don't need to specify a value with this switch. -Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). You can't use this switch with the ParentRoleEntry parameter. @@ -305,12 +307,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md index f8e3218a75..153ba0c086 100644 --- a/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/exchange/Add-PublicFolderAdministrativePermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-publicfolderadministrativepermission +online version: https://learn.microsoft.com/powershell/module/exchange/add-publicfolderadministrativepermission applicable: Exchange Server 2010 title: Add-PublicFolderAdministrativePermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Add-PublicFolderAdministrativePermission cmdlet to add administrative permissions to a public folder or a public folder hierarchy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -57,7 +57,7 @@ Add-PublicFolderAdministrativePermission [-Identity] - ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -271,7 +271,7 @@ Accept wildcard characters: False ``` ### -Deny -The Deny switch specifies whether to deny the permission specified. You don't need to specify a value with this switch. +The Deny switch specifies that the permissions you're adding are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -303,13 +303,13 @@ Accept wildcard characters: False ``` ### -InheritanceType -The InheritanceType parameter specifies the type of inheritance. Valid values are: +The InheritanceType parameter specifies how permissions are inherited. Valid values are: - None -- All -- Descendents -- SelfAndChildren +- All (this is the default value) - Children +- Descendents [sic] +- SelfAndChildren ```yaml Type: ActiveDirectorySecurityInheritance @@ -368,12 +368,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md index 8c4dc3b6e2..059bc10445 100644 --- a/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/exchange/Add-PublicFolderClientPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-publicfolderclientpermission +online version: https://learn.microsoft.com/powershell/module/exchange/add-publicfolderclientpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Add-PublicFolderClientPermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Add-PublicFolderClientPermission cmdlet to add permissions to public folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Add-PublicFolderClientPermission [-Identity] -AccessRi ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -112,7 +112,12 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the user principal name (UPN), domain\\user, or alias of the user for whom rights are being added. +The User parameter specifies the user for whom rights are being added. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. ```yaml Type: PublicFolderUserIdParameter @@ -165,7 +170,7 @@ Accept wildcard characters: False ``` ### -Server -This parameter is available only in on-premises Exchange 2010. +This parameter is available only in Exchange Server 2010. The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -210,12 +215,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-RecipientPermission.md b/exchange/exchange-ps/exchange/Add-RecipientPermission.md index 9f62b8ea7c..06dfc9280a 100644 --- a/exchange/exchange-ps/exchange/Add-RecipientPermission.md +++ b/exchange/exchange-ps/exchange/Add-RecipientPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-recipientpermission +online version: https://learn.microsoft.com/powershell/module/exchange/add-recipientpermission applicable: Exchange Online title: Add-RecipientPermission schema: 2.0.0 @@ -16,17 +16,12 @@ This cmdlet is available only in the cloud-based service. Use the Add-RecipientPermission cmdlet to add SendAs permission to users in a cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Add-RecipientPermission [-Identity] -AccessRights -Trustee - [-SkipDomainValidationForMailContact] - [-SkipDomainValidationForMailUser] - [-SkipDomainValidationForSharedMailbox] [-Confirm] [-WhatIf] [] @@ -35,7 +30,7 @@ Add-RecipientPermission [-Identity] -AccessRights -StartTime ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,7 +66,7 @@ This example replays the redundant copies of messages delivered from 6:00 PM Jun ### -EndTime The EndTime parameter specifies the delivery time of the latest messages that need to be resubmitted from Safety Net. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The date and time specified by the EndTime parameter must be later than the date and time specified by the StartTime parameter. The date and time specified by both parameters must be in the past. @@ -86,7 +86,7 @@ Accept wildcard characters: False ### -StartTime The StartTime parameter specifies the delivery time of the oldest messages that need to be resubmitted from Safety Net. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The date and time specified by the StartTime parameter must be earlier than the date and time specified by the EndTime parameter. The date and time specified by both parameters must be in the past. @@ -300,12 +300,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md index d8e7548dcf..5f64ff5636 100644 --- a/exchange/exchange-ps/exchange/Add-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Add-RoleGroupMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-rolegroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/add-rolegroupmember +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Add-RoleGroupMember schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Add-RoleGroupMember cmdlet to add members to a management role group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,9 +36,9 @@ If the ManagedBy property has been populated with role group managers, the user In on-premises Exchange, if the role group is a linked role group, you can't use the Add-RoleGroupMember cmdlet to add members to the role group. Instead, you need to add members to the foreign universal security group (USG) that's linked to the linked role group. To find the foreign USG that's linked to a role group, use the Get-RoleGroup cmdlet. -For more information about role groups, see [Understanding management role groups](https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). +For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,8 +60,8 @@ After you've verified that the correct members will be added to the role group, For more information about pipelining and the WhatIf parameter, see the following topics: -- [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) -- WhatIf, Confirm and ValidateOnly switches +- [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) +- [WhatIf, Confirm and ValidateOnly switches](https://learn.microsoft.com/exchange/whatif-confirm-and-validateonly-switches-exchange-2013-help) ### Example 3 ```powershell @@ -79,7 +79,7 @@ The Identity parameter specifies the role group to add a member to. If the role Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -93,7 +93,7 @@ The Member parameter specifies who you want to add to the role group. You can sp - Mailbox users - Mail users -- Mail-enabled security groups (don't use in Security & Compliance Center PowerShell) +- Mail-enabled security groups - Security groups (on-premises Exchange only) You can use any value that uniquely identifies the user or group. For example: @@ -113,7 +113,7 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -123,7 +123,12 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch enables a user who hasn't been added to the ManagedBy property to add a member to a role group. The user must be a member of the Organization Management role group or be assigned, either directly or indirectly, the Role Management role. +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. ```yaml Type: SwitchParameter @@ -148,7 +153,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -176,7 +181,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -184,7 +189,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -198,12 +203,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md index 999438d3f9..97858e26e8 100644 --- a/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Add-ServerMonitoringOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-servermonitoringoverride +online version: https://learn.microsoft.com/powershell/module/exchange/add-servermonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Add-ServerMonitoringOverride schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Add-ServerMonitoringOverride cmdlet to override the thresholds and parameters of managed availability probes, monitors, and responders on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ Add-ServerMonitoringOverride [-Identity] -ItemType [!NOTE] +> You can't use this cmdlet to modify Microsoft 365 Group members, owners, or subscribers if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see [Group resource type](https://learn.microsoft.com/graph/api/resources/group). +> +> Using this cmdlet, only group members can be owners of the group. Add users as members before you add them as owners. This limitation doesn't apply in web management portals where you can add non-members as group owners. Guest users can never be group owners. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +35,7 @@ Add-UnifiedGroupLinks [-Identity] -Links -IsFeatureEnabled -ModuleId -Name + [-Confirm] + [-Everyone] + [-GroupIds ] + [-IsUserControlEnabled ] + [-IsUserOptedInByDefault ] + [-ResultSize ] + [-UserIds ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Add-VivaModuleFeaturePolicy cmdlet to add a new access policy for a specific feature in Viva. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role or the roles that have been assigned at the feature level to run this cmdlet. + +To learn more about assigned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management). + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name DisableFeatureForAll -IsFeatureEnabled $false -Everyone +``` + +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for all users in the organization. + +### Example 2 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 +``` + +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for all users in the specified groups. + +### Example 3 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name MultipleUsers -IsFeatureEnabled $false -UserIds user1@contoso.com,user2@contoso.com +``` + +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users. + +### Example 4 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -Name UsersAndGroups -IsFeatureEnabled $false -GroupIds group1@contoso.com,group2@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -UserIds user1@contoso.com,user2@contoso.com +``` + +This example adds a policy for the Reflection feature in Viva Insights. The policy disables the feature for the specified users and group members. + +### Example 5 +```powershell +Add-VivaModuleFeaturePolicy -ModuleId PeopleSkills -FeatureId ShowAISkills -Name SoftDisableShowAISkillsPolicy -IsFeatureEnabled $true -IsUserControlEnabled $true -IsUserOptedInByDefault $false -UserIds user1@contoso.com,user2@contoso.com +``` + +This example adds a policy for the ShowAISkills feature in Viva Skills. The policy enables the feature for the specified users, allows user controls, and opted out users by default (Soft Disable policy). + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to add the policy for. + +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFeatureEnabled +The IsFeatureEnabled parameter specifies whether or not the feature is enabled by the policy. Valid values are: + +- $true: The feature is enabled by the policy. +- $false: The feature is not enabled by the policy. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module that you want to add the feature policy for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the name of the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +Valid characters are English letters, numbers, commas, periods, and spaces. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +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`. +- 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Everyone +The Everyone switch specifies that the policy applies to all users in the organization. You don't need to specify a value with this switch. + +Don't use this switch with the GroupIds or UserIds parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupIds +The GroupIds parameter specifies the email addresses or security group object IDs (GUIDs) of groups that the updated policy applies to. Both [Mail-enabled and non-mail-enabled Microsoft Entra groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the policy apply to all users in the organization, use the Everyone switch. + +**Note**: In v3.5.1-Preview2 or later of the module, this parameter supports security group object IDs (GUIDs). Previous versions of the module accept only email addresses for this parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserControlEnabled +This parameter is available in version 3.3.0 or later of the module. + +The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: + +- $true: User control is enabled by the policy. Users can opt out of the feature. +- $false: User control isn't enabled by the policy. Users can't opt of the feature. + +Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserOptedInByDefault +This parameter is available in version 3.8.0-Preview2 or later of the module. + +The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: + +- $true: By default, users are opted in by the policy if the user hasn't set a preference. +- $false: By default, users are opted out by the policy if the user hasn't set a preference. + +This parameter is optional and can be used to override the default user opt-in value set in the feature metadata. + +This parameter can be set only when the IsUserControlEnabled parameter is set to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIds +The UserIds parameter specifies the user principal names (UPNs) of the users that the policy applies to. You can enter multiple values separated by commas. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the policy apply to all users in the organization, use the Everyone switch. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..0bd5527745 --- /dev/null +++ b/exchange/exchange-ps/exchange/Add-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/add-vivaorginsightsdelegatedrole +title: Add-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Add-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Add-VivaOrgInsightsDelegatedRole cmdlet to add delegate access to the specified account (the delegate) so they can view organizational insights like the leader (the delegator). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Add-VivaOrgInsightsDelegatedRole -Delegate -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Add-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example adds the organization insights viewing capability of the specified delegator account to the specified delegate account. + +## PARAMETERS + +### -Delegate +The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). + +A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegator +The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter. + +A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md index 762d89057b..ddb6eb30ff 100644 --- a/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Add-eDiscoveryCaseAdmin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/add-ediscoverycaseadmin -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/add-ediscoverycaseadmin +applicable: Security & Compliance title: Add-eDiscoveryCaseAdmin schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Add-eDiscoveryCaseAdmin ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Add-eDiscoveryCaseAdmin cmdlet to add an eDiscovery Administrator in the Microsoft 365 security center. To replace all existing eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. +Use the Add-eDiscoveryCaseAdmin cmdlet to add an eDiscovery Administrator in the Microsoft Purview compliance portal. To replace all existing eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,11 +28,11 @@ Add-eDiscoveryCaseAdmin -User ``` ## DESCRIPTION -An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. +An eDiscovery Administrator is a member of the eDiscovery Manager role group who can view and access all eDiscovery cases in the organization. To make a user an eDiscovery Administrator, add them to the eDiscovery Manager role group by running the following command in Security & Compliance PowerShell: `Add-RoleGroupMember -Identity "eDiscovery Manager" -Member ""`. -To make a user an eDiscovery Administrator, the user must be assigned the Case Management role. By default, this role is assigned to the Organization Management and eDiscovery Manager role groups. +After the user is a member of the eDiscovery Manager role group, you can then use this cmdlet to add them to the list of eDiscovery Administrators. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The User parameter specifies the user that you want to add to the list of eDisco Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +86,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -106,12 +106,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md b/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md index 6c6612baff..9e3829eb4e 100644 --- a/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Clean-MailboxDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/clean-mailboxdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/clean-mailboxdatabase applicable: Exchange Server 2010 title: Clean-MailboxDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Clean-MailboxDatabase cmdlet to scan Active Directory for disconnected mailboxes that aren't yet marked as disconnected in the Microsoft Exchange store and update the status of those mailboxes in the Exchange store. This cmdlet isn't able to update the Exchange store unless the Microsoft Exchange Information Store service is running and the database is mounted. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ If you want to reconnect a disconnected mailbox to an Active Directory user acco Under normal circumstances, it isn't necessary to run the Clean-MailboxDatabase cmdlet because a mailbox is marked as disconnected immediately after the Disable-Mailbox or Remove-Mailbox command completes. If you used the Disable-Mailbox cmdlet or the Remove-Mailbox cmdlet while the Microsoft Exchange Information Store service was stopped, or if a mailbox was disabled by an external means other than the Disable-Mailbox cmdlet or Remove-Mailbox cmdlet, you may want to use the Clean-MailboxDatabase cmdlet to scan for disconnected mailboxes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -126,12 +126,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md index df2877e7d3..f729195ad5 100644 --- a/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md +++ b/exchange/exchange-ps/exchange/Clear-ActiveSyncDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/clear-activesyncdevice +online version: https://learn.microsoft.com/powershell/module/exchange/clear-activesyncdevice applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Clear-ActiveSyncDevice schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Clear-ActiveSyncDevice cmdlet to delete all data from a mobile device. **Note**: In Exchange 2013 or later, use the Clear-MobileDevice cmdlet instead. If you have scripts that use Clear-ActiveSyncDevice, update them to use Clear-MobileDevice. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ The Clear-ActiveSyncDevice cmdlet deletes all user data from a mobile device the After you run this cmdlet, you receive a warning that states: "This command will force all the data on the device to be permanently deleted. Do you want to continue?" You must respond to the warning for the cmdlet to run on the mobile phone. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,7 +81,7 @@ Accept wildcard characters: False ``` ### -Cancel -The Cancel switch specifies whether the command should be canceled. If you use the Cancel switch, a cancellation request is issued for the remote device wipe. +The Cancel switch specifies whether to issue a cancellation request for a pending remote device wipe. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -102,6 +102,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -170,12 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Clear-MobileDevice.md b/exchange/exchange-ps/exchange/Clear-MobileDevice.md index 6f0a963e15..9a5eda7425 100644 --- a/exchange/exchange-ps/exchange/Clear-MobileDevice.md +++ b/exchange/exchange-ps/exchange/Clear-MobileDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/clear-mobiledevice +online version: https://learn.microsoft.com/powershell/module/exchange/clear-mobiledevice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Clear-MobileDevice schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Clear-MobileDevice cmdlet to delete all data from a mobile phone. This action is often called a remote device wipe. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,38 +36,39 @@ The Clear-MobileDevice cmdlet deletes all user data from a mobile device the nex After you run this cmdlet, you receive a warning that states: "This command will force all the data on the device to be permanently deleted. Do you want to continue?" You must respond to the warning for the cmdlet to run on the mobile phone. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Clear-MobileDevice -Identity WM_JeffHay +Clear-MobileDevice -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac ``` -This example clears all data from the mobile device with the Identity WM\_JeffHay. +This example clears all data from the specified mobile device. ### Example 2 ```powershell -Clear-MobileDevice -Identity WM_TonySmith -NotificationEmailAddresses "tony@contoso.com" +Clear-MobileDevice -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac -NotificationEmailAddresses "chris@contoso.com" ``` -This example clears all data from the mobile device for Tony Smith and sends a confirmation email message to tony@contoso.com. +This example clears all data from the specified mobile device and sends a confirmation email message to chris@contoso.com. ### Example 3 ```powershell -Clear-MobileDevice -Identity WM_TonySmith -Cancel +Clear-MobileDevice -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac -Cancel ``` -This example cancels a previously sent Clear-MobileDevice command request for Tony Smith's mobile device. +This example cancels a previously sent Clear-MobileDevice command request for the specified mobile device. ## PARAMETERS ### -Identity -The Identity parameter specifies the mobile device that you want to reset. You can use any value that uniquely identifies the mobile device. For example: +The Identity parameter specifies the mobile device that you want to reset. You can use the following values that uniquely identifies the mobile device: -- GUID -- DeviceID +- Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) +- Distinguished name (DN) +- GUID (same as ExchangeObjectId) ```yaml Type: MobileDeviceIdParameter @@ -85,7 +86,7 @@ Accept wildcard characters: False ### -AccountOnly The AccountOnly switch specifies whether to perform an account-only remote device wipe where only Exchange mailbox data is removed from the device. You don't need to specify a value with this switch. -You don't need to use this switch for the DeviceType value Outlook, because an account-only remote devices wipe is the only type of wipe that's used on Outlook devices. +You don't need to use this switch for the DeviceType value Outlook, because an account-only remote device wipe is the only type of wipe that's used on Outlook devices. ```yaml Type: SwitchParameter @@ -101,7 +102,7 @@ Accept wildcard characters: False ``` ### -Cancel -The Cancel switch cancels a pending remote device wipe request. You don't need to specify a value with this switch. +The Cancel switch specifies whether to issue a cancellation request for a pending remote device wipe. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -122,6 +123,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -190,12 +193,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md index f342690de3..0cfbdb03d1 100644 --- a/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md +++ b/exchange/exchange-ps/exchange/Clear-TextMessagingAccount.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/clear-textmessagingaccount +online version: https://learn.microsoft.com/powershell/module/exchange/clear-textmessagingaccount applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Clear-TextMessagingAccount schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. The Clear-TextMessagingAccount cmdlet allows a user to remove the text messaging settings from their own mailbox. An administrator can't use this cmdlet to remove the text messaging settings from another user's mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Clear-TextMessagingAccount [-Identity] ## DESCRIPTION The Clear-TextMessagingAccount cmdlet clears all of a user's text messaging settings, including communication and notification settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -110,9 +110,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -151,12 +151,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md b/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md index 22eb08c4e4..c536c48908 100644 --- a/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md +++ b/exchange/exchange-ps/exchange/Compare-TextMessagingVerificationCode.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/compare-textmessagingverificationcode +online version: https://learn.microsoft.com/powershell/module/exchange/compare-textmessagingverificationcode applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Compare-TextMessagingVerificationCode schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Compare-TextMessagingVerificationCode cmdlet to verify the text messaging verification code that the user specified as part of configuring text message notifications on the mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Compare-TextMessagingVerificationCode cmdlet returns the value true if the c When text messaging notifications are enabled on a mailbox, you can configure calendar notifications, voice mail notifications, and email notifications using an inbox rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -161,12 +161,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Complete-MigrationBatch.md b/exchange/exchange-ps/exchange/Complete-MigrationBatch.md index 9ddcbe3050..922eeca5b8 100644 --- a/exchange/exchange-ps/exchange/Complete-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Complete-MigrationBatch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/complete-migrationbatch +online version: https://learn.microsoft.com/powershell/module/exchange/complete-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Complete-MigrationBatch schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Complete-MigrationBatch cmdlet to finalize a migration batch for a local move, cross-forest move, or remote move migration that has successfully finished initial synchronization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,13 +39,13 @@ After a migration batch for a local or cross-forest move has successfully run an - Configures the user's Microsoft Outlook profile to point to the new target domain. - Converts the source mailbox to a mail-enabled user in the source domain. -In the cloud-based service, this cmdlet sets the value of CompleteAfter to the current time. It is important to remember that any CompleteAfter setting that has been applied to the individual users within the batch will override the setting on the batch, so the completion for some users may be delayed until their configured time. +In the cloud-based service, this cmdlet sets the value of CompleteAfter to the current time. It is important to remember that any CompleteAfter setting that has been applied to the individual users within the batch will override the setting on the batch, so the completion for some users may be delayed until their configured time. When the finalization process is complete, you can remove the batch by using the Remove-MigrationBatch cmdlet. If a migration batch has a status of Completed with Errors, you can re-attempt to finalize the failed users. In Exchange Online, use the Start-MigrationBatch cmdlet to retry migration for failed users. In Exchange 2013 or Exchange 2016, use the Complete-MigrationBatch to retry these failed users. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,7 +77,7 @@ Accept wildcard characters: False ### -CompletePublicFolderMigrationWithDataLoss This parameter is available only in the cloud-based service. -{{ Fill CompletePublicFolderMigrationWithDataLoss Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter @@ -98,6 +98,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -204,12 +206,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md index 830c4f9db6..96f0891ba3 100644 --- a/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Connect-ExchangeOnline.md @@ -1,25 +1,25 @@ --- external help file: ExchangeOnlineManagement-help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/connect-exchangeonline +online version: https://learn.microsoft.com/powershell/module/exchange/connect-exchangeonline applicable: Exchange Online title: Connect-ExchangeOnline schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Connect-ExchangeOnline ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell using modern authentication. This cmdlet works for MFA or non-MFA enabled accounts. +Use the Connect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to connect to Exchange Online PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. This cmdlet works for accounts with or without multi-factor authentication (MFA). -To connect to other PowerShell environments (for example, Security & Compliance Center PowerShell or standalone Exchange Online Protection PowerShell), use the [Connect-IPPSSession](https://docs.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet. +To connect to Security & Compliance PowerShell, use the [Connect-IPPSSession](https://learn.microsoft.com/powershell/module/exchange/connect-ippssession) cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,6 +33,7 @@ Connect-ExchangeOnline [[-Prefix] ] [[-CommandName] ] [[-FormatTypeName] ] + [-AccessToken ] [-AppId ] [-BypassMailboxAnchoring] [-Certificate ] @@ -41,101 +42,84 @@ Connect-ExchangeOnline [-CertificateThumbprint ] [-Credential ] [-Device] + [-DisableWAM] [-EnableErrorReporting] [-InlineCredential] + [-LoadCmdletHelp] [-LogDirectoryPath ] [-LogLevel ] + [-ManagedIdentity] + [-ManagedIdentityAccountId ] [-Organization ] [-PageSize ] [-ShowBanner] [-ShowProgress ] + [-SigningCertificate ] + [-SkipLoadingCmdletHelp] + [-SkipLoadingFormatData] [-TrackPerformance ] [-UseMultithreading ] [-UserPrincipalName ] + [-UseRPSSession] [] ``` ## DESCRIPTION -This cmdlet allows you to create a remote PowerShell connection to your Exchange Online organization. You can use this cmdlet to authenticate for the new REST API-backed cmdlets in the Exchange Online PowerShell V2 module, and also for all existing Exchange Online PowerShell cmdlets (remote PowerShell cmdlets). +This cmdlet creates a PowerShell connection to your Exchange Online organization. -For details about the current and past public versions of the EXO V2 module, see [Release notes](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2#release-notes). This topic is written for the current public version. Features or parameters that are only available in a Preview version of the module are specifically noted. +Connect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. ## EXAMPLES ### Example 1 ```powershell -$UserCredential = Get-Credential -Connect-ExchangeOnline -Credential $UserCredential -``` - -This example connects to Exchange Online PowerShell using modern authentication for an account that doesn't use multi-factor authentication (MFA). - -The first command gets the username and password and stores them in the $UserCredential variable. - -The second command connects the current PowerShell session using the credentials in $UserCredential. - -After the Connect-ExchangeOnline command is complete, the password key in the $UserCredential variable is emptied, and you can run Exchange Online PowerShell cmdlets. - -### Example 2 -```powershell Connect-ExchangeOnline -UserPrincipalName chris@contoso.com ``` -This example connects to Exchange Online PowerShell using modern authentication for the account chris@contoso.com, which uses MFA. - -After the command is successful, you can run ExO V2 module cmdlets and older remote PowerShell cmdlets. +This example connects to Exchange Online PowerShell using modern authentication, with or without multi-factor authentication (MFA). The connection uses REST API mode and doesn't require Basic authentication to be enabled in WinRM on the local computer. -### Example 3 -```powershell -Connect-ExchangeOnline -AppId <%App_id%> -CertificateFilePath "C:\users\navin\Documents\TestCert.pfx" -Organization "contoso.onmicrosoft.com" -``` - -This example connects to Exchange Online in an unattended scripting scenario using the public key of a certificate. - -### Example 4 +### Example 2 ```powershell Connect-ExchangeOnline -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" ``` -This example connects to Exchange Online in an unattended scripting scenario using a certificate thumbprint. +This example connects to Exchange Online PowerShell in an unattended scripting scenario using a certificate thumbprint. -### Example 5 +### Example 3 ```powershell Connect-ExchangeOnline -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" ``` -This example connects to Exchange Online in an unattended scripting scenario using a certificate file. This method is best suited for scenarios where the certificate is stored in remote machines and fetched at runtime. For example, the certificate is stored in the Azure Key Vault. +This example connects to Exchange Online PowerShell in an unattended scripting scenario using a certificate file. This method is best suited for scenarios where the certificate is stored in remote machines and fetched at runtime. For example, the certificate is stored in the Azure Key Vault. -### Example 6 +### Example 4 ```powershell Connect-ExchangeOnline -Device ``` -In PowerShell 7.0.3 or later using the EXO V2 module version 2.0.4 or later, this example connects to Exchange Online in interactive scripting scenarios on computers that don't have web browsers. +In PowerShell 7.0.3 or later using version 2.0.4 or later of the module, this example connects to Exchange Online PowerShell in interactive scripting scenarios on computers that don't have web browsers. -The command returns a URL and unique code that's tied to the session. You need to open the URL in a browser on any computer, and then enter the unique code. After you complete the login in the web browser, the session in the Powershell 7 window is authenticated via the regular Azure AD authentication flow, and the Exchange Online cmdlets are imported after few seconds. +The command returns a URL and unique code that's tied to the session. You need to open the URL in a browser on any computer, and then enter the unique code. After you complete the login in the web browser, the session in the Powershell 7 window is authenticated via the regular Microsoft Entra authentication flow, and the Exchange Online cmdlets are imported after few seconds. -### Example 7 +### Example 6 ```powershell Connect-ExchangeOnline -InlineCredential ``` -In PowerShell 7.0.3 or later using the EXO V2 module version 2.0.4 or later, this example connects to Exchange Online in interactive scripting scenarios by passing credentials directly in the PowerShell window. +In PowerShell 7.0.3 or later using version 2.0.4 or later of the module, this example connects to Exchange Online PowerShell in interactive scripting scenarios by passing credentials directly in the PowerShell window. ## PARAMETERS ### -ConnectionUri **Note**: If you use the ExchangeEnvironmentName parameter, you don't need to use the AzureADAuthorizationEndpointUri or ConnectionUri parameters. -The ConnectionUri parameter specifies the connection endpoint for the remote Exchange Online PowerShell session. The following Exchange Online PowerShell environments and related values are supported: +The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following Exchange Online PowerShell environments and related values are supported: - Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://outlook.office365.com/powershell-liveid/`, but that's also the default value, so you don't need to use this parameter. - Office 365 Germany: `https://outlook.office.de/PowerShell-LiveID` - Office 365 operated by 21Vianet: `https://partner.outlook.cn/PowerShell` -- Microsoft 365 GCC High: `https://outlook.office365.us/powershell-liveid` -- Microsoft 365 DoD: `https://webmail.apps.mil/powershell-liveid` - -**Note**: If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection, use the this cmdlet without the _ConnectionUri_ parameter to connect to EOP PowerShell (the same connection instructions as Exchange Online PowerShell in Microsoft 365 or Microsoft GCC). +- Microsoft 365 GCC High: `https://outlook.office365.us/powershell-liveID` +- Microsoft 365 DoD: `https://webmail.apps.mil/powershell-liveID` ```yaml Type: String @@ -153,7 +137,7 @@ Accept wildcard characters: False ### -AzureADAuthorizationEndpointUri **Note**: If you use the ExchangeEnvironmentName parameter, you don't need to use the AzureADAuthorizationEndpointUri or ConnectionUri parameters. -The AzureADAuthorizationEndpointUri parameter specifies the Azure AD Authorization endpoint that can issue OAuth2 access tokens. The following Exchange Online PowerShell environments and related values are supported: +The AzureADAuthorizationEndpointUri parameter specifies the Microsoft Entra Authorization endpoint that can issue OAuth2 access tokens. The following Exchange Online PowerShell environments and related values are supported: - Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://login.microsoftonline.com/common`, but that's also the default value, so you don't need to use this parameter. - Office 365 Germany: `https://login.microsoftonline.de/common` @@ -199,11 +183,11 @@ Accept wildcard characters: False ``` ### -PSSessionOption -The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. You store the output of the [New-PSSessionOption](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption) command in a variable, for example: +**Note**: This parameter doesn't work in REST API connections. -`$Options = New-PSSessionOption ` +The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. This parameter works only if you also use the UseRPSSession switch in the same command. -And you use the variable name as the value for this parameter (for example, `$Options`). +Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption) command in a variable (for example, `$PSOptions = New-PSSessionOption `), and use the variable name as the value for this parameter (for example, `$PSOptions`). ```yaml Type: PSSessionOption @@ -219,7 +203,9 @@ Accept wildcard characters: False ``` ### -DelegatedOrganization -The DelegatedOrganization parameter specifies the customer organization that you want to manage (for example, contosoelectronics.onmicrosoft.com). This parameter only works if the customer organization has agreed to your delegated management via the CSP program. +The DelegatedOrganization parameter specifies the customer organization that you want to manage. A valid value for this parameter is the primary .onmicrosoft.com domain or tenant ID of the customer organization. + +This parameter works only if the customer organization has agreed to your delegated management via the CSP program. After you successfully authenticate, the cmdlets in this session are mapped to the customer organization, and all operations in this session are done on the customer organization. @@ -237,7 +223,11 @@ Accept wildcard characters: False ``` ### -Prefix -The Prefix parameter specifies an alias to add to nouns in the names of older remote PowerShell cmdlets (cmdlet with nouns that don't already start with EXO). A valid value is a text string without spaces or special characters like underscrores, asterisks etc, and you can't use the value EXO (this prefix is reserved for PowerShell V2 module cmdlets). +The Prefix parameter specifies a text value to add to the names of Exchange Online PowerShell cmdlets when you connect. For example, Get-InboundConnector becomes Get-ContosoInboundConnector when you use the value Contoso for this parameter. + +- The Prefix value can't contain spaces or special characters like underscores or asterisks. +- You can't use the Prefix value EXO. That value is reserved for the nine exclusive **Get-EXO\*** cmdlets that are built into the module. +- The Prefix parameter affects only imported Exchange Online cmdlet names. It doesn't affect the names of cmdlets that are built into the module (for example, Disconnect-ExchangeOnline). ```yaml Type: String @@ -284,10 +274,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AccessToken +**Note**: This parameter is available in version 3.1.0 or later of the module. + +The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Exchange Online. + +Depending on the type of access token, you need to use this parameter with the Organization, DelegatedOrganization, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AppId The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example, `36ee4c6c-0812-40a2-b820-b22ebd02bce3`. -For more information, see [App-only authentication for unattended scripts in the EXO V2 module](https://aka.ms/exov2-cba). +For more information, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). ```yaml Type: String @@ -319,11 +329,11 @@ Accept wildcard characters: False ``` ### -Certificate -The Certificate parameter specifies the certificate that's used for CBA. A valid value is the X509Certificate2 object value of the certificate. +The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate. Don't use this parameter with the CertificateFilePath or CertificateThumbprint parameters. -For more information about CBA, see [App-only authentication for unattended scripts in the EXO V2 module](https://aka.ms/exov2-cba). +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). ```yaml Type: X509Certificate2 @@ -339,11 +349,11 @@ Accept wildcard characters: False ``` ### -CertificateFilePath -The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. +The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. Don't use this parameter with the Certificate or CertificateThumbprint parameters. -For more information about CBA, see [App-only authentication for unattended scripts in the EXO V2 module](https://aka.ms/exov2-cba). +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). ```yaml Type: String @@ -361,9 +371,15 @@ Accept wildcard characters: False ### -CertificatePassword The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). -For more information about CBA, see [App-only authentication for unattended scripts in the EXO V2 module](https://aka.ms/exov2-cba). +**Note**: Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. ```yaml Type: SecureString @@ -383,7 +399,9 @@ The CertificateThumbprint parameter specifies the certificate that's used for CB Don't use this parameter with the Certificate or CertificateFilePath parameters. -For more information about CBA, see [App-only authentication for unattended scripts in the EXO V2 module](https://aka.ms/exov2-cba). +**Note**: The CertificateThumbprint parameter is supported only in Microsoft Windows. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). ```yaml Type: String @@ -421,11 +439,33 @@ Accept wildcard characters: False ``` ### -Device -**Note**: This parameter is available only in version 2.0.4 or later, and only in PowerShell 7. +**Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7. + +The Device switch is typically used on computers without web browsers. You don't need to specify a value with this switch. + +Using this switch results in an on-screen message that contains the URL and a unique code. On any other device with a web browser and internet access, open the URL, enter the unique code, and enter your credentials in the subsequent pages. + +If your login was successful, the PowerShell connection continues. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The Device switch specifies whether to authenticate interactively computers that don't have web browsers to support single sign-on (SSO). You don't need to specify a value with this switch. +### -DisableWAM +**Note**: This parameter is available in version 3.7.2-Preview1 or later of the module. -The command returns a URL and unique code that's tied to the session. You need to open the URL in a browser on any computer, and then enter the unique code. After you complete the login in the web browser, the session in the Powershell 7 window is authenticated via the regular Azure AD authentication flow, and the Exchange Online cmdlets are imported after few seconds. +The DisableWAM switch disables Web Account Manager (WAM). You don't need to specify a value with this switch. + +Starting in version 3.7.0, WAM is enabled by default when connecting to Exchange Online. If you encounter WAM-related issues during sign in, you can use this switch to disable WAM. ```yaml Type: SwitchParameter @@ -457,7 +497,7 @@ Accept wildcard characters: False ``` ### -InlineCredential -**Note**: This parameter is available only in version 2.0.4 or later, and only in PowerShell 7. +**Note**: This parameter is available in version 2.0.4 or later of the module, and only in PowerShell 7. The InlineCredential switch specifies whether to pass credentials directly in the Windows PowerShell window. You don't need to specify a value with this switch. @@ -478,6 +518,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LoadCmdletHelp +**Note**: This parameter is available in version 3.7.0-Preview1 or later of the module. + +The LoadCmdletHelp switch downloads cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. + +Starting in v3.7.0-Preview1, help files for the command line aren't downloaded by default. Use this switch to download the files for cmdlet help at the command line. + +**Tip**: This parameter replaces the SkipLoadingCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer works, because cmdlet help files are no longer downloaded by default. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LogDirectoryPath The LogDirectoryPath parameter specifies the location of the log files. The default location is `%TMP%\EXOCmdletTelemetry\EXOCmdletTelemetry-yyyymmdd-hhmmss.csv`. @@ -512,8 +574,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ManagedIdentity +The ManagedIdentity switch specifies that you're using managed identity to connect. You don't need to specify a value with this switch. + +Managed identity connections are currently supported for the following types of Azure resources: + +- Azure Automation runbooks +- Azure Virtual Machines +- Azure Virtual Machine Scale Sets +- Azure Functions + +You must use this switch with the Organization parameter. + +For user-assigned managed identity, you must also use this switch with the ManagedIdentityAccountId parameter. + +For more information about connecting with managed identity, see [Use Azure managed identities to connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-exo-powershell-managed-identity). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedIdentityAccountId +The ManagedIdentityAccountId parameter specifies the user-assigned managed identity that you're using to connect. A valid value for this parameter is the application ID (GUID) of the service principal that corresponds to the user-assigned managed identity in Azure. + +You must use this parameter with the Organization parameter and the ManagedIdentity switch. + +For more information about connecting with managed identity, see [Use Azure managed identities to connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-exo-powershell-managed-identity). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Organization -The Organization parameter specifies the organization that's used in app-only authentication. Be sure to use an .onmicrosoft.com domain for the parameter value. Otherwise, you might encounter cryptic permission issues when you run commands in the app context. +The Organization parameter specifies the organization when you connect using CBA or managed identity. A valid value for this parameter is the primary .onmicrosoft.com domain or tenant ID of the organization. + +For more information about connecting with CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +For more information about connecting with managed identity, see [Use Azure managed identities to connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-exo-powershell-managed-identity). ```yaml Type: String @@ -529,7 +644,7 @@ Accept wildcard characters: False ``` ### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 1000. The default value is 1000. ```yaml Type: UInt32 @@ -567,7 +682,7 @@ Accept wildcard characters: False The ShowProgress parameter specifies whether to show or hide the progress bar of imported cmdlets when you connect. Valid values are: - $true: The progress bar is displayed. This is the default value. -- $false: Currently, this value has no effect. +- $false: Currently, this value has no effect. ```yaml Type: Boolean @@ -582,13 +697,81 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SigningCertificate +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The SigningCertificate parameter specifies the client certificate that's used to sign the format files (\*.Format.ps1xml) or script module files (.psm1) in the temporary module that Connect-ExchangeOnline creates. + +A valid value for this parameter is a variable that contains the certificate, or a command or expression that gets the certificate. + +To find the certificate, use the Get-PfxCertificate cmdlet in the Microsoft.PowerShell.Security module or use the Get-ChildItem cmdlet in the certificate (Cert:) drive. If the certificate isn't valid or doesn't have sufficient authority, the command will fail. + +```yaml +Type: X509Certificate2 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipLoadingCmdletHelp +**Note**: This parameter is available in version 3.3.0 or later of the module. + +In version 3.7.0-Preview1 or later, this parameter is replaced by the LoadCmdletHelp parameter. The SkipLoadingCmdletHelp parameter is no longer required and no longer does anything, because cmdlet help files are no longer downloaded by default. Eventually, this parameter will be retired, so remove it from any scripts. + +The SkipLoadingCmdletHelp switch prevents downloading the cmdlet help files for the Get-Help cmdlet in REST API connections. You don't need to specify a value with this switch. + +When you use this switch, you don't get local help files for any cmdlet at the command line. + +This switch doesn't work with the UseRPSSession switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipLoadingFormatData +The SkipLoadingFormatData switch prevents downloading the format data for REST API connections. You don't need to specify a value with this switch. + +When you use this switch, the output of any Exchange cmdlet will be unformatted. + +Use this switch to avoid errors when connecting to Exchange Online PowerShell from within a Windows service or the Windows PowerShell SDK. + +This switch doesn't work with the UseRPSSession switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TrackPerformance The TrackPerformance parameter measures additional events (for example, CPU load and memory consumed). Valid values are: - $true: Performance tracking is enabled. - $false: Performance tracking is disabled. This is the default value. -This parameter only when works when logging is enabled. +This parameter works only when logging is enabled. ```yaml Type: Boolean @@ -604,10 +787,10 @@ Accept wildcard characters: False ``` ### -UseMultithreading -The UseMultithreading parameter specifies whether to disable or enable multi-threading in the EXO V2 module. Valid values are: +The UseMultithreading parameter specifies whether to disable or enable multi-threading in the Exchange Online PowerShell module. Valid values are: - $true: Enable multi-threading. This is the default value. -- $false: Disable multi-threading. Note this value will degrade performance of V2 cmdlets. +- $false: Disable multi-threading. This value will degrade the performance of the nine exclusive **Get-EXO\*** cmdlets in the module. ```yaml Type: Boolean @@ -623,7 +806,7 @@ Accept wildcard characters: False ``` ### -UserPrincipalName -The UserPrincipalName parameter specifies the account that you want to use to connect (for example, navin@contoso.onmicrosoft.com). Using this parameter allows you to skip the username dialog in the modern authentication prompt for credentials (you only need to enter your password). +The UserPrincipalName parameter specifies the account that you want to use to connect (for example, `navin@contoso.onmicrosoft.com`). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password). If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both). @@ -640,17 +823,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseRPSSession +**Note**: Remote PowerShell connections to Exchange Online PowerShell are deprecated. For more information, see [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). + +The UseRPSSession switch allows you to connect to Exchange Online PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch. + +This switch requires that Basic authentication is enabled in WinRM on the local computer. For more information, see [Turn on Basic authentication in WinRM](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm). + +If you don't use this switch, REST API mode is used for the connection, so Basic authentication in WinRM isn't required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Connect-IPPSSession.md b/exchange/exchange-ps/exchange/Connect-IPPSSession.md index 8f4ebc3ca2..a260cad194 100644 --- a/exchange/exchange-ps/exchange/Connect-IPPSSession.md +++ b/exchange/exchange-ps/exchange/Connect-IPPSSession.md @@ -1,25 +1,25 @@ --- external help file: ExchangeOnlineManagement-help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/connect-ippssession +online version: https://learn.microsoft.com/powershell/module/exchange/connect-ippssession applicable: Exchange Online title: Connect-IPPSSession schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Connect-IPPSSession ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell V2 module to connect to Security & Compliance Center PowerShell or standalone Exchange Online Protection PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. +Use the Connect-IPPSSession cmdlet in the Exchange Online PowerShell module to connect to Security & Compliance PowerShell using modern authentication. The cmdlet works for MFA or non-MFA enabled accounts. -**Note**: If your organization is on-premises Exchange, and you have Exchange Enterprise CAL with Services licenses for Exchange Online Protection (EOP), use the [Connect-ExchangeOnline](https://docs.microsoft.com/powershell/module/exchange/connect-exchangeonline) cmdlet in the [Exchange Online PowerShell connection instructions](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) to connect to your EOP PowerShell environment. +**Note**: Version 3.2.0 or later of the module supports REST API mode for virtually all Security & Compliance PowerShell cmdlets (Basic authentication in WinRM on the local computer isn't required for REST API mode). For more information, see [Prerequisites for the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#prerequisites-for-the-exchange-online-powershell-module). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,50 +32,62 @@ Connect-IPPSSession [[-Prefix] ] [[-CommandName] ] [[-FormatTypeName] ] + [-AccessToken ] + [-AppId ] [-BypassMailboxAnchoring] + [-Certificate ] + [-CertificateFilePath ] + [-CertificatePassword ] + [-CertificateThumbprint ] [-Credential ] + [-Organization ] [-UserPrincipalName ] + [-UseRPSSession] [] ``` ## DESCRIPTION -This cmdlet allows you to create a remote PowerShell session to Exchange-related PowerShell environments other than Exchange Online PowerShell. For example, Security & Compliance Center PowerShell or standalone Exchange Online Protection PowerShell (for organizations without Exchange Online mailboxes). - -For details about the current and past public versions of the EXO V2 module, see [Release notes](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2#release-notes). This topic is written for the current public version. Features or parameters that are only available in a Preview version of the module are specifically noted. +For detailed connection instructions, including prerequisites, see [Connect to Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-scc-powershell). ## EXAMPLES ### Example 1 ```powershell -$UserCredential = Get-Credential -Connect-IPPSSession -Credential $UserCredential +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com ``` -This example connects to Security & Compliance Center PowerShell in a Microsoft 365 organization. +This example connects to Security & Compliance PowerShell using the specified account and modern authentication, with or without MFA. In v3.2.0 or later of the module, we're connecting in REST API mode, so Basic authentication in WinRM isn't required on the local computer. -The first command gets the user credentials and stores them in the $UserCredential variable. +### Example 2 +```powershell +Connect-IPPSSession -UserPrincipalName michelle@contoso.onmicrosoft.com -UseRPSSession +``` -The second command connects the current PowerShell session using the credentials in the $UserCredential, which isn't MFA enabled. +This example connects to Security & Compliance PowerShell using the specified account and modern authentication, with or without MFA. In v3.2.0 or later of the module, we're connecting in remote PowerShell mode, so Basic authentication in WinRM is required on the local computer. -After the Connect-IPPSSession command is complete, the password key in the $UserCredential variable is emptied, and you can run Security & Compliance Center PowerShell cmdlets. +### Example 3 +```powershell +Connect-IPPSSession -AppId <%App_id%> -CertificateThumbprint <%Thumbprint string of certificate%> -Organization "contoso.onmicrosoft.com" +``` -### Example 2 +This example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate thumbprint. + +### Example 4 ```powershell -Connect-IPPSSession -Credential (Get-Credential) -ConnectionUri https://ps.protection.outlook.com/powershell-liveid/ +Connect-IPPSSession -AppId <%App_id%> -Certificate <%X509Certificate2 object%> -Organization "contoso.onmicrosoft.com" ``` -This example connects to standalone Exchange Online Protection PowerShell in an organization that doesn't have Exchange Online mailboxes. +This example connects to Security & Compliance PowerShell in an unattended scripting scenario using a certificate file. This method is best suited for scenarios where the certificate is stored in remote machines and fetched at runtime. For example, the certificate is stored in the Azure Key Vault. ## PARAMETERS ### -ConnectionUri -The ConnectionUri parameter specifies the connection endpoint for the remote PowerShell session. The following PowerShell environments and related values are supported: +The ConnectionUri parameter specifies the connection endpoint for the PowerShell session. The following PowerShell environments and related values are supported: -- Security & Compliance Center PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://ps.compliance.protection.outlook.com/powershell-liveid/`, but that's also the default value, so you don't need to use this parameter. -- Security & Compliance Center PowerShell in Office 365 Germany: `https://ps.compliance.protection.outlook.de/PowerShell-LiveID` -- Security & Compliance Center PowerShell in Microsoft GCC High: `https://ps.compliance.protection.office365.us/powershell-liveid/` -- Security & Compliance Center PowerShell in Microsoft DoD: `https://l5.ps.compliance.protection.office365.us/powershell-liveid/` -- Exchange Online Protection PowerShell in standalone EOP organizations without Exchange Online mailboxes: `https://ps.protection.outlook.com/powershell-liveid/` +- Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://ps.compliance.protection.outlook.com/powershell-liveid/`, but that's also the default value, so you don't need to use this parameter. +- Security & Compliance PowerShell in Office 365 operated by 21Vianet: `https://ps.compliance.protection.partner.outlook.cn/powershell-liveid` +- Security & Compliance PowerShell in Microsoft GCC High: `https://ps.compliance.protection.office365.us/powershell-liveid/` +- Security & Compliance PowerShell in Microsoft DoD: `https://l5.ps.compliance.protection.office365.us/powershell-liveid/` ```yaml Type: String @@ -91,11 +103,11 @@ Accept wildcard characters: False ``` ### -AzureADAuthorizationEndpointUri -The AzureADAuthorizationEndpointUri parameter specifies the Azure AD Authorization endpoint that can issue OAuth2 access tokens. The following PowerShell environments and related values are supported: +The AzureADAuthorizationEndpointUri parameter specifies the Microsoft Entra Authorization endpoint that can issue OAuth2 access tokens. The following PowerShell environments and related values are supported: -- Security & Compliance Center PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://login.microsoftonline.com/common`, but that's also the default value, so you don't need to use this parameter. -- Security & Compliance Center PowerShell in Office 365 Germany: `https://login.microsoftonline.de/common` -- Security & Compliance Center PowerShell in Microsoft GCC High or Microsoft DoD: `https://login.microsoftonline.us/common` +- Security & Compliance PowerShell in Microsoft 365 or Microsoft 365 GCC: Don't use this parameter. The required value is `https://login.microsoftonline.com/common`, but that's also the default value, so you don't need to use this parameter. +- Security & Compliance PowerShell in Office 365 operated by 21Vianet: `https://login.chinacloudapi.cn/common` +- Security & Compliance PowerShell in Microsoft GCC High or Microsoft DoD: `https://login.microsoftonline.us/common` If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both). @@ -113,7 +125,14 @@ Accept wildcard characters: False ``` ### -DelegatedOrganization -This parameter is reserved for internal Microsoft use. +The DelegatedOrganization parameter specifies the customer organization that you want to manage (for example, contosoelectronics.onmicrosoft.com). This parameter works only if the customer organization has agreed to your delegated management via the CSP program. + +After you successfully authenticate, the cmdlets in this session are mapped to the customer organization, and all operations in this session are done on the customer organization. + +**Notes**: + +- Use the primary .onmicrosoft.com domain of the delegated organization for the value of this parameter. +- You must use the AzureADAuthorizationEndpointUri parameter with this parameter. ```yaml Type: String @@ -129,11 +148,11 @@ Accept wildcard characters: False ``` ### -PSSessionOption -The PSSessionOption parameter specifies the PowerShell session options to use in your connection to Exchange Online. You store the output of the [New-PSSessionOption](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption) command in a variable, for example: +**Note**: This parameter doesn't work in REST API connections. -`$Options = New-PSSessionOption ` +The PSSessionOption parameter specifies the remote PowerShell session options to use in your connection to Security & Compliance PowerShell. This parameter works only if you also use the UseRPSSession switch in the same command. -And you use the variable name as the value for this parameter (for example, `$Options`). +Store the output of the [New-PSSessionOption](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/new-pssessionoption) command in a variable (for example, `$PSOptions = New-PSSessionOption `), and use the variable name as the value for this parameter (for example, `$PSOptions`). ```yaml Type: PSSessionOption @@ -149,7 +168,11 @@ Accept wildcard characters: False ``` ### -Prefix -The Prefix parameter specifies an alias to add to nouns in the names of older remote PowerShell cmdlets (cmdlet with nouns that don't already start with EXO). A valid value is a text string without spaces, and you can't use the value EXO (this prefix is reserved for PowerShell V2 module cmdlets). +The Prefix parameter specifies a text value to add to the names of Security & Compliance PowerShell cmdlets when you connect. For example, Get-ComplianceCase becomes Get-ContosoComplianceCase when you use the value Contoso for this parameter. + +- The Prefix value can't contain spaces or special characters like underscores or asterisks. +- You can't use the Prefix value EXO. That value is reserved for the nine exclusive **Get-EXO\*** cmdlets that are built into the module. +- The Prefix parameter affects only imported Security & Compliance cmdlet names. It doesn't affect the names of cmdlets that are built into the module (for example, Disconnect-ExchangeOnline). ```yaml Type: String @@ -196,6 +219,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AccessToken +**Note**: This parameter is available in version 3.8.0-Preview1 or later of the module. + +The AccessToken parameter specifies the OAuth JSON Web Token (JWT) that's used to connect to Security and Compliance PowerShell. + +Depending on the type of access token, you need to use this parameter with the Organization, DelegatedOrganization, or UserPrincipalName parameters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppId +The AppId parameter specifies the application ID of the service principal that's used in certificate based authentication (CBA). A valid value is the GUID of the application ID (service principal). For example, `36ee4c6c-0812-40a2-b820-b22ebd02bce3`. + +For more information, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BypassMailboxAnchoring The BypassMailboxAnchoring switch bypasses the use of the mailbox anchoring hint. You don't need to specify a value with this switch. @@ -212,6 +273,94 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Certificate +The Certificate parameter specifies the certificate that's used for certificate-based authentication (CBA). A valid value is the X509Certificate2 object value of the certificate. + +Don't use this parameter with the CertificateFilePath or CertificateThumbprint parameters. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: X509Certificate2 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateFilePath +The CertificateFilePath parameter specifies the certificate that's used for CBA. A valid value is the complete public path to the certificate file. Use the CertificatePassword parameter with this parameter. + +Don't use this parameter with the Certificate or CertificateThumbprint parameters. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificatePassword +The CertificatePassword parameter specifies the password that's required to open the certificate file when you use the CertificateFilePath parameter to identify the certificate that's used for CBA. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +**Note**: Using a **ConvertTo-SecureString** command to store the password of the certificate locally defeats the purpose of a secure connection method for automation scenarios. Using a **Get-Credential** command to prompt you for the password of the certificate securely isn't ideal for automation scenarios. In other words, there's really no automated _and_ secure way to connect using a local certificate. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CertificateThumbprint +The CertificateThumbprint parameter specifies the certificate that's used for CBA. A valid value is the thumbprint value of the certificate. For example, `83213AEAC56D61C97AEE5C1528F4AC5EBA7321C1`. + +Don't use this parameter with the Certificate or CertificateFilePath parameters. + +**Note**: The CertificateThumbprint parameter is supported only in Microsoft Windows. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Credential The Credential parameter specifies the username and password that's used to connect to Exchange Online PowerShell. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. Don't use this parameter for accounts that use multi-factor authentication (MFA). @@ -232,8 +381,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Organization +The Organization parameter specifies the organization when you connect using CBA. You must use the primary .onmicrosoft.com domain of the organization for the value of this parameter. + +For more information about CBA, see [App-only authentication for unattended scripts in the Exchange Online PowerShell module](https://aka.ms/exo-cba). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UserPrincipalName -The UserPrincipalName parameter specifies the account that you want to use to connect (for example, navin@contoso.onmicrosoft.com). Using this parameter allows you to skip the username dialog in the modern authentication prompt for credentials (you only need to enter your password). +The UserPrincipalName parameter specifies the account that you want to use to connect (for example, navin@contoso.onmicrosoft.com). Using this parameter allows you to skip entering a username in the modern authentication credentials prompt (you're prompted to enter a password). If you use the UserPrincipalName parameter, you don't need to use the AzureADAuthorizationEndpointUri parameter for MFA or federated users in environments that normally require it (UserPrincipalName or AzureADAuthorizationEndpointUri is required; OK to use both). @@ -250,17 +417,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseRPSSession +This parameter is available in version 3.2.0 or later of the module. + +**Note**: Remote PowerShell connections to Security & Compliance are deprecated. For more information, see [Deprecation of Remote PowerShell in Security and Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). + +The UseRPSSession switch allows you to connect to Security & Compliance PowerShell using traditional remote PowerShell access to all cmdlets. You don't need to specify a value with this switch. + +This switch requires that Basic authentication is enabled in WinRM on the local computer. For more information, see [Turn on Basic authentication in WinRM](https://aka.ms/exov3-module#turn-on-basic-authentication-in-winrm). + +If you don't use this switch, Basic authentication in WinRM is not required. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Connect-Mailbox.md b/exchange/exchange-ps/exchange/Connect-Mailbox.md index 8871c0b31b..87bea6279a 100644 --- a/exchange/exchange-ps/exchange/Connect-Mailbox.md +++ b/exchange/exchange-ps/exchange/Connect-Mailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/connect-mailbox +online version: https://learn.microsoft.com/powershell/module/exchange/connect-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Connect-Mailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Connect-Mailbox cmdlet to connect disconnected mailboxes to existing user accounts that don't already have mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -131,7 +131,7 @@ Use the Remove-Mailbox cmdlet to: - Keep the mailbox in the disabled state before it's permanently deleted, subject to the deleted mailbox retention period (except if you use the Permanent or StoreMailboxIdentity parameters, which immediately deletes the mailbox from the database). - Remove the user account. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -246,7 +246,7 @@ Accept wildcard characters: False ``` ### -LinkedMasterAccount -The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. This parameter is required only if you're creating a linked mailbox. You can use any value that uniquely identifies the master account. For example: For example: +The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. This parameter is required only if you're creating a linked mailbox. You can use any value that uniquely identifies the master account. For example: - Name - Distinguished name (DN) @@ -305,7 +305,9 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. No changes are made when the ValidateOnly switch is used. +The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. You don't need to specify a value with this switch. + +No changes are made when you use this switch. ```yaml Type: SwitchParameter @@ -349,7 +351,7 @@ The AddressBookPolicy parameter specifies the address book policy that's applied - Distinguished name (DN) - GUID -For more information about address book policies, see [Address book policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). +For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). ```yaml Type: AddressBookMailboxPolicyIdParameter @@ -365,15 +367,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -461,7 +468,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -479,7 +488,7 @@ Accept wildcard characters: False ### -LinkedCredential The LinkedCredential parameter specifies the credentials used to access the domain controller that's specified by the LinkedDomainController parameter. This parameter is optional, even if you're connecting a linked mailbox. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -549,7 +558,14 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the user object in Active Directory that you want to connect the mailbox to. You can use any value that uniquely identifies the user. For example: For example: +The User parameter specifies the user object in Active Directory that you want to connect the mailbox to. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user. For example: - Name - Distinguished name (DN) @@ -592,12 +608,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md index b8bb73b373..3dc21e421f 100644 --- a/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Delete-QuarantineMessage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/delete-quarantinemessage -applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/delete-quarantinemessage +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Delete-QuarantineMessage schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Delete-QuarantineMessage cmdlet to delete quarantine messages from your cloud-based organization -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,6 +25,9 @@ For information about the parameter sets in the Syntax section below, see [Excha Delete-QuarantineMessage -Identities [-Identity ] [-Confirm] + [-EntityType ] + [-HardDelete] + [-RecipientAddress ] [-WhatIf] [] ``` @@ -35,12 +36,15 @@ Delete-QuarantineMessage -Identities ``` Delete-QuarantineMessage -Identity [-Confirm] + [-EntityType ] + [-HardDelete] + [-RecipientAddress ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,14 +58,16 @@ This example deletes the quarantined message with the specified Identity value. ### Example 2 ```powershell $ids = Get-QuarantineMessage | select -ExpandProperty Identity + Delete-QuarantineMessage -Identity $ids[4] ``` -This example deletes the 5th quarantined message in the list of results from Get-QuarantineMessage. The first message has the index number 0, the second has the index number 1 and so on). +This example deletes the 5th quarantined message in the list of results from Get-QuarantineMessage. The first message has the index number 0, the second has the index number 1 and so on. ### Example 3 ```powershell $ids = Get-QuarantineMessage | select -ExpandProperty Identity + Delete-QuarantineMessage -Identities $ids -Identity 000 ``` @@ -70,9 +76,9 @@ This example deletes all quarantined messages. The Identity parameter is require ## PARAMETERS ### -Identities -The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. The value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). +The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. Each value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). -You can find the identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. +You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. When you use this parameter, the Identity parameter is required, but the value is ignored. For example, use the value 000 for the Identity parameter. @@ -80,7 +86,7 @@ When you use this parameter, the Identity parameter is required, but the value i Type: QuarantineMessageIdentity[] Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -98,7 +104,7 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -130,7 +136,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -139,16 +145,69 @@ 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. +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HardDelete +The HardDelete switch specifies the message is permanently deleted and isn't recoverable. You don't need to specify a value with this switch. + +If you don't use this switch, the message is deleted, but is potentially recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -162,12 +221,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..fe87141f2e --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-atpprotectionpolicyrule +applicable: Exchange Online +title: Disable-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-ATPProtectionPolicyRule and Disable-EOPProtectionPolicyRule cmdlets together to turn off the Standard preset security policy or the Strict preset security policy in organizations with Microsoft Defender for Office 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-ATPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled. + +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations with Defender for Office 365, this example turns off the Standard preset security policy. The State property value of both rules is now Disabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md b/exchange/exchange-ps/exchange/Disable-AddressListPaging.md index ae542e9d83..45471267d2 100644 --- a/exchange/exchange-ps/exchange/Disable-AddressListPaging.md +++ b/exchange/exchange-ps/exchange/Disable-AddressListPaging.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-addresslistpaging +online version: https://learn.microsoft.com/powershell/module/exchange/disable-addresslistpaging applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-AddressListPaging schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-AddressListPaging cmdlet to disable Active Directory virtual list view for address lists. Virtual list view displays address lists in your organization as pages instead of loading and viewing the entire directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Disable-AddressListPaging [-Confirm] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,6 +47,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -97,12 +99,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md b/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md index e6c1a557d9..df08fecd4f 100644 --- a/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/Disable-AntiPhishRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-antiphishrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-antiphishrule applicable: Exchange Online, Exchange Online Protection title: Disable-AntiPhishRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Disable-AntiPhishRule cmdlet to disable antiphish rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Disable-AntiPhishRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +67,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -103,12 +103,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-App.md b/exchange/exchange-ps/exchange/Disable-App.md index 5f8a4960d6..881f7f9195 100644 --- a/exchange/exchange-ps/exchange/Disable-App.md +++ b/exchange/exchange-ps/exchange/Disable-App.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-app +online version: https://learn.microsoft.com/powershell/module/exchange/disable-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Disable-App schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-App cmdlet to disable (turn off) a specific app for a specific user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Disable-App [-Identity] ## DESCRIPTION The Disable-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). -For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://docs.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://docs.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). +For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://learn.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://learn.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +83,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -164,12 +166,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md index 3b9e4ea6e6..071e1f83ec 100644 --- a/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/exchange/Disable-CmdletExtensionAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-cmdletextensionagent +online version: https://learn.microsoft.com/powershell/module/exchange/disable-cmdletextensionagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-CmdletExtensionAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-CmdletExtensionAgent cmdlet to disable existing cmdlet extension agents. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and When you disable a cmdlet extension agent, the agent is disabled for the entire organization. When an agent is disabled, it's not made available to cmdlets. Cmdlets can no longer use the agent to perform additional operations. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +72,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -122,12 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md b/exchange/exchange-ps/exchange/Disable-DistributionGroup.md index 716b40b57d..e773646d76 100644 --- a/exchange/exchange-ps/exchange/Disable-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Disable-DistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-distributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/disable-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-DistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-DistributionGroup cmdlet to remove email capabilities from existing mail-enabled security groups and distribution groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Disable-DistributionGroup [-Identity] ## DESCRIPTION The Disable-DistributionGroup cmdlet mail-disables existing mail-enabled security groups and distribution groups by removing the email attributes that are required by Exchange. Mail-disabled groups are invisible to the \*-DistributionGroup cmdlets (with the exception of Enable-DistributionGroup). All groups (mail-enabled or not) are visible to the Get-Group and Set-Group cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +74,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -104,9 +106,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -145,12 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md b/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md new file mode 100644 index 0000000000..9b1751508e --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-DnssecForVerifiedDomain.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-dnssecforverifieddomain +applicable: Exchange Online +title: Disable-DnssecForVerifiedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-DnssecForVerifiedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-DnssecForVerifiedDomain cmdlet to disable Domain Name System Security (DNSSEC) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-DnssecForVerifiedDomain [-DomainName] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-DnssecForVerifiedDomain -DomainName contoso.com +``` + +This example disables DNSSEC for mail sent to contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to disable DNSSEC (for example, contoso.com). Use the Get-DnssecForVerifiedDomain cmdlet to see information about DNSSEC for the domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..b611fc63b1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: Disable-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-EOPProtectionPolicyRule cmdlet to turn off the Standard preset security policy or the Strict preset security policy. If your organization has Defender for Office 365, you also need to use the Disable-ATPProtectionPolicyRule cmdlet to turn off the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-EOPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled. + +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations without Defender for Office 365, this example turns off the Standard preset security policy. The State property value of the rule is now Disabled. + +### Example 2 +```powershell +Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Disable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations with Defender for Office 365, this example turns off the Standard preset security policy. The State property value of both rules is now Disabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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. +- 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md index 8d0d0c7fe4..7adfa0cbae 100644 --- a/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/Disable-HostedContentFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-hostedcontentfilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection title: Disable-HostedContentFilterRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Disable-HostedContentFilterRule cmdlet to disable spam filter rules (content filter rules) in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Disable-HostedContentFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +67,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -103,12 +103,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md index 07defc0559..442273d3c0 100644 --- a/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/exchange/Disable-HostedOutboundSpamFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-hostedoutboundspamfilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection title: Disable-HostedOutboundSpamFilterRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Disable-HostedOutboundSpamFilterRule cmdlet to disable outbound spam filter rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Disable-HostedOutboundSpamFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +67,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -103,12 +103,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md b/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md new file mode 100644 index 0000000000..59ff3a79b1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-IPv6ForAcceptedDomain.md @@ -0,0 +1,105 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/disable-ipv6foraccepteddomain +applicable: Exchange Online +title: Disable-IPv6ForAcceptedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-IPv6ForAcceptedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-IPv6ForAcceptedDomain cmdlet to disable or opt-out of support for mail delivery to accepted domains in Exchange Online using IPv6. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-IPv6ForAcceptedDomain [[-Domain] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Online organization to use with this cmdlet. + +If IPv6 is enabled for an accepted domain in Exchange Online, IPv4 and IPv6 addresses are returned in DNS queries for mail flow records of the domain. If IPv6 is disabled, only IPv4 addresses are returned in DNS queries for mail flow records of the domain. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-IPv6ForAcceptedDomain -Domain contoso.com +``` + +This example disables IPv6 support for mail sent to contoso.com. Mail can be delivered to the domain using IPv4 only. + +## PARAMETERS + +### -Domain +The Domain parameter specifies the accepted domain that you want to disable mail delivery using IPv6 for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-InboxRule.md b/exchange/exchange-ps/exchange/Disable-InboxRule.md index 9beb4072d2..7bc6e6bce3 100644 --- a/exchange/exchange-ps/exchange/Disable-InboxRule.md +++ b/exchange/exchange-ps/exchange/Disable-InboxRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-inboxrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Disable-InboxRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-InboxRule cmdlet to disable existing Inbox rules in mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Disable-InboxRule [-Identity] ## DESCRIPTION When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,7 +69,7 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob parameter suppresses a warning that end users or administrators get if they use Outlook Web App or Windows PowerShell to modify Inbox rules. +The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -90,6 +90,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -122,7 +124,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -187,12 +191,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-JournalArchiving.md b/exchange/exchange-ps/exchange/Disable-JournalArchiving.md index d92b27be03..a1bf697510 100644 --- a/exchange/exchange-ps/exchange/Disable-JournalArchiving.md +++ b/exchange/exchange-ps/exchange/Disable-JournalArchiving.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-journalarchiving +online version: https://learn.microsoft.com/powershell/module/exchange/disable-journalarchiving applicable: Exchange Online title: Disable-JournalArchiving schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Disable-JournalArchiving cmdlet to disable journal archiving for specific users. Microsoft 365 journal archiving uses mailboxes in Exchange Online to record or journal messages for mailboxes in on-premises organizations. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +35,7 @@ The Disable-JournalArchiving cmdlet removes the mail user and converts the journ In hybrid organizations that use DirSync, this cmdlet doesn't remove the mail user. Removal of the mail user is handled by DirSync. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -130,12 +128,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-JournalRule.md b/exchange/exchange-ps/exchange/Disable-JournalRule.md index d097755953..f36f1eaaaa 100644 --- a/exchange/exchange-ps/exchange/Disable-JournalRule.md +++ b/exchange/exchange-ps/exchange/Disable-JournalRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-journalrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Disable-JournalRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-JournalRule cmdlet to disable a journal rule on a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Disable-JournalRule -Identity ## DESCRIPTION You can enable or disable specific journal rules in your organization at any time using the Disable-JournalRule and Enable-JournalRule cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +73,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -125,12 +127,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-MailContact.md b/exchange/exchange-ps/exchange/Disable-MailContact.md index 6e55d6e188..97902c5fd6 100644 --- a/exchange/exchange-ps/exchange/Disable-MailContact.md +++ b/exchange/exchange-ps/exchange/Disable-MailContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-mailcontact +online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-MailContact schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-MailContact cmdlet to remove email capabilities from existing mail contacts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Disable-MailContact [-Identity] ## DESCRIPTION The Disable-MailContact cmdlet mail-disables existing mail contacts by removing the email attributes that are required by Exchange. Mail-disabled contacts are invisible to the \*-MailContact cmdlets (with the exception of Enable-MailContact). All contacts (mail-enabled or not) are visible to the Get-Contact and Set-Contact cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +74,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -104,9 +106,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -145,12 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md b/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md index bfa2eec50a..a4aadbbe70 100644 --- a/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Disable-MailPublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-mailpublicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailpublicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Disable-MailPublicFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-MailPublicFolder cmdlet to mail-disable a public folder. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Disable-MailPublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +67,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -144,12 +146,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-MailUser.md b/exchange/exchange-ps/exchange/Disable-MailUser.md index 00eeecf3e4..c0728ff91a 100644 --- a/exchange/exchange-ps/exchange/Disable-MailUser.md +++ b/exchange/exchange-ps/exchange/Disable-MailUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-mailuser +online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-MailUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-MailUser cmdlet to remove email capabilities from existing mail users. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Disable-MailUser [-Identity] ## DESCRIPTION The Disable-MailUser cmdlet mail-disables existing mail users by removing the email attributes that are required by Exchange. Mail-disabled users are invisible to the \*-MailUser cmdlets (with the exception of Enable-MailUser). All users (mail-enabled or not) are visible to the Get-User and Set-User cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,6 +75,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -105,9 +107,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -126,7 +128,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch. +The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. + +When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. @@ -164,12 +168,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-Mailbox.md b/exchange/exchange-ps/exchange/Disable-Mailbox.md index 2a61eb808b..8997b03b35 100644 --- a/exchange/exchange-ps/exchange/Disable-Mailbox.md +++ b/exchange/exchange-ps/exchange/Disable-Mailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailbox +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Disable-Mailbox schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-Mailbox cmdlet to disable the mailbox of existing users who already have mailboxes. For this cmdlet, a user could also be a public folder mailbox or an InetOrgPerson object. The user account that's associated with the mailbox remains, but it's no longer associated with a mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -78,7 +78,7 @@ The Disable-Mailbox cmdlet also performs the clean-up task on the individual mai Under normal circumstances, a mailbox is marked as disconnected immediately after the Disable-Mailbox or Remove-Mailbox command completes. However, if the mailbox was disabled or removed while the Exchange Information Store service was stopped, or if it was disabled or removed by an external means other than Exchange management interfaces, the status of the mailbox object in the Exchange mailbox database won't be marked as disconnected. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,7 +99,7 @@ This example disables the remote archive for the on-premises user named John Woo ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox that you want to mailbox-disable. You can use any value that uniquely identifies the mailbox. For example: For example: +The Identity parameter specifies the mailbox that you want to mailbox-disable. You can use any value that uniquely identifies the mailbox. For example: - Name - Alias @@ -116,7 +116,7 @@ The Identity parameter specifies the mailbox that you want to mailbox-disable. Y Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -154,7 +154,7 @@ You can't use this switch with the RemoteArchive switch. Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -169,11 +169,13 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -239,9 +241,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -262,7 +264,9 @@ Accept wildcard characters: False ### -IgnoreLegalHold This parameter is available only in on-premises Exchange. -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch. +The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. + +When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. @@ -349,7 +353,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,12 +367,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md b/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md index 295e9af1d0..98aaf73776 100644 --- a/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md +++ b/exchange/exchange-ps/exchange/Disable-MailboxQuarantine.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-mailboxquarantine +online version: https://learn.microsoft.com/powershell/module/exchange/disable-mailboxquarantine applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-MailboxQuarantine schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-MailboxQuarantine cmdlet to release quarantined mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -69,7 +69,7 @@ Disable-MailboxQuarantine -Server ## DESCRIPTION Mailboxes are quarantined when they affect the availability of the mailbox database. Typically a software fix from Microsoft is required before releasing a mailbox from quarantine. If a fix isn't deployed before releasing the mailbox, the quarantine on the mailbox will be re-enabled if the condition recurs. The default quarantine duration is 24 hours. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -233,6 +233,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -283,12 +285,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md index 7423965b6d..127a8f0542 100644 --- a/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Disable-MalwareFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-malwarefilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Disable-MalwareFilterRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-MalwareFilterRule cmdlet to disable malware filter rules in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Disable-MalwareFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +64,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -116,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md b/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md index da36a5bc39..87451f2763 100644 --- a/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md +++ b/exchange/exchange-ps/exchange/Disable-MetaCacheDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-metacachedatabase +online version: https://learn.microsoft.com/powershell/module/exchange/disable-metacachedatabase applicable: Exchange Server 2019 title: Disable-MetaCacheDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-MetaCacheDatabase cmdlet to disable the metacache database on Exchange 2019 Mailbox servers. The metacache database stores mailbox database indexes and secondary copies of metadata on solid state drives (SSDs) to improve search latency and user logons. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Disable-MetaCacheDatabase -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -104,12 +104,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md index e2d36da7d2..30685164f7 100644 --- a/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Disable-OutlookAnywhere.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-outlookanywhere +online version: https://learn.microsoft.com/powershell/module/exchange/disable-outlookanywhere applicable: Exchange Server 2010 title: Disable-OutlookAnywhere schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Disable-OutlookAnywhere cmdlet to disable Outlook Anywhere on Exchange Server 2010 Client Access servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ When you run this cmdlet, it can take as long as an hour for the settings to bec After the Client Access server is disabled for Outlook Anywhere, you may want to remove the RPC over HTTP proxy Windows networking component. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -166,12 +166,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md index 4ed64f23d1..6032b60587 100644 --- a/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/Disable-OutlookProtectionRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-outlookprotectionrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Disable-OutlookProtectionRule schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-OutlookProtectionRule cmdlet to disable an existing Microsoft Outlook protection rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,9 +33,9 @@ Disable-OutlookProtectionRule [-Identity] ## DESCRIPTION Outlook protection rules are administrator-created rules applied before a user sends a message using Outlook. Outlook protection rules are used to automatically Information Rights Management (IRM)-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. -For more information, see [Outlook protection rules](https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). +For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,6 +70,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -122,12 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md index 3aa3b4c51f..ade8f3935d 100644 --- a/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md +++ b/exchange/exchange-ps/exchange/Disable-PushNotificationProxy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-pushnotificationproxy +online version: https://learn.microsoft.com/powershell/module/exchange/disable-pushnotificationproxy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-PushNotificationProxy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-PushNotificationProxy cmdlet to disable the push notification proxy that's configured between an on-premises Microsoft Exchange organization and a Microsoft 365 organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Disable-PushNotificationProxy [-Confirm] ## DESCRIPTION The push notification proxy relays event notifications (for example, new email or calendar updates) for on-premises mailboxes through Microsoft 365 to Outlook on the web for devices on the user's device. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +48,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -82,12 +84,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md b/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md index 860e1a36c0..8039e5d1fd 100644 --- a/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Disable-RemoteMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-remotemailbox +online version: https://learn.microsoft.com/powershell/module/exchange/disable-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-RemoteMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-RemoteMailbox cmdlet to remove user mailboxes from the cloud-based service but keep the associated user objects in the on-premises Active Directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,8 +46,7 @@ Directory synchronization must be configured correctly for a mailbox to be remov - If you are deprovisioning a cloud mailbox and its associated online archive, you must first disable the online archive with the command `Disable-RemoteMailbox -Archive` and then perform a directory synchronization prior to disabling the remote mailbox. Attempting to disable both the online archive and cloud mailbox without a sync between them may result in an ArchiveGuid mismatch and validation error. - Due to the current service architecture, you need to convert shared mailboxes to user mailboxes prior to running the Disable-RemoteMailbox cmdlet. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,6 +115,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -146,9 +147,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -167,7 +168,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the remote user. This switch disables the instance of the remote object in the on-premises organization, and the request to disable the mailbox is synchronized to the cloud. However, if the cloud mailbox is on hold, the request to disable the mailbox is blocked, and an error is returned. +The IgnoreLegalHold switch ignores the legal hold status of the remote user. You don't need to specify a value with this switch. + +This switch disables the instance of the remote object in the on-premises organization, and the request to disable the mailbox is synchronized to the cloud. However, if the cloud mailbox is on hold, the request to disable the mailbox is blocked, and an error is returned. ```yaml Type: SwitchParameter @@ -203,12 +206,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md new file mode 100644 index 0000000000..8e8073a184 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-ReportSubmissionRule.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-reportsubmissionrule +applicable: Exchange Online +title: Disable-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-ReportSubmissionRule cmdlet to disable the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-ReportSubmissionRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-ReportSubmissionRule -Identity DefaultReportSubmissionRule. +``` + +This example disables the report submission rule if it's already enabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to disable. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md index b3ce3e9454..35ef4b854d 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Disable-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/disable-safeattachmentrule +applicable: Exchange Online title: Disable-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Disable-SafeAttachmentRule cmdlet to disable safe attachment rules in your cloud-based organization. This cmdlet is also responsible for disabling complete Safe Attachments policies in the admin center, which consist of the safe attachment rule and the corresponding assigned safe attachment policy in PowerShell. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +28,9 @@ Disable-SafeAttachmentRule [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -73,11 +71,13 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +93,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -107,12 +107,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md index de660c5c06..fa714bf72f 100644 --- a/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Disable-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-safelinksrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/disable-safelinksrule +applicable: Exchange Online title: Disable-SafeLinksRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Disable-SafeLinksRule cmdlet to disable enabled Safe Links rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Disable-SafeLinksRule [-Identity] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -73,11 +71,13 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +93,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -107,12 +107,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md b/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md index 3b72e82e56..13a29e56ed 100644 --- a/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md +++ b/exchange/exchange-ps/exchange/Disable-ServiceEmailChannel.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-serviceemailchannel +online version: https://learn.microsoft.com/powershell/module/exchange/disable-serviceemailchannel applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-ServiceEmailChannel schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-ServiceEmailChannel cmdlet to disable the .NET service channel for a specific user. The .NET service channel enables Microsoft Exchange to store information that it later forwards to applications or devices that aren't permanently connected to the server running Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Disable-ServiceEmailChannel [-Identity] ## DESCRIPTION The Disable-ServiceEmailChannel cmdlet deletes the receive folder in the user's mailbox under the root folder. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,6 +93,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -143,12 +145,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md b/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md new file mode 100644 index 0000000000..927fd4cd53 --- /dev/null +++ b/exchange/exchange-ps/exchange/Disable-SmtpDaneInbound.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/disable-smtpdaneinbound +applicable: Exchange Online +title: Disable-SmtpDaneInbound +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Disable-SmtpDaneInbound + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Disable-SMTPDaneInbound cmdlet to disable SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Disable-SmtpDaneInbound [-DomainName] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Disable-SmtpDaneInbound -DomainName contoso.com +``` + +This example disables SMTP DANE for mail sent to contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to disable SMTP DANE (for example, contoso.com). Use the Get-SmtpDaneInboundStatus cmdlet to see information about SMTP DNAME for the domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-SweepRule.md b/exchange/exchange-ps/exchange/Disable-SweepRule.md index e91c8f9811..225c628693 100644 --- a/exchange/exchange-ps/exchange/Disable-SweepRule.md +++ b/exchange/exchange-ps/exchange/Disable-SweepRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-sweeprule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Disable-SweepRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-SweepRule cmdlet to disable Sweep rules in mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Disable-SweepRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -155,12 +155,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Disable-TransportAgent.md b/exchange/exchange-ps/exchange/Disable-TransportAgent.md index 7cff28b6b0..5ccd3fab73 100644 --- a/exchange/exchange-ps/exchange/Disable-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Disable-TransportAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-transportagent +online version: https://learn.microsoft.com/powershell/module/exchange/disable-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Disable-TransportAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-TransportAgent cmdlet to disable a transport agent. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Disable-TransportAgent [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +65,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -139,12 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-TransportRule.md b/exchange/exchange-ps/exchange/Disable-TransportRule.md index 01a05540a7..03d4189525 100644 --- a/exchange/exchange-ps/exchange/Disable-TransportRule.md +++ b/exchange/exchange-ps/exchange/Disable-TransportRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-transportrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Disable-TransportRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Disable-TransportRule cmdlet to disable transport rules (mail flow rules) in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Disable-TransportRule [-Identity] ## DESCRIPTION To enable rules that are disabled, use the Enable-TransportRule cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,6 +70,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -124,12 +126,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md index d377e9597e..9a332903c9 100644 --- a/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/Disable-UMAutoAttendant.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-umautoattendant +online version: https://learn.microsoft.com/powershell/module/exchange/disable-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Disable-UMAutoAttendant schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-UMAutoAttendant cmdlet to disable an existing Unified Messaging (UM) auto attendant that's enabled. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Disable-UMAutoAttendant cmdlet disables an existing UM auto attendant that's After this task is completed, the UM auto attendant is disabled and won't accept incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md index 3971248705..d9f8154eaf 100644 --- a/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/exchange/Disable-UMCallAnsweringRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-umcallansweringrule +online version: https://learn.microsoft.com/powershell/module/exchange/disable-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 title: Disable-UMCallAnsweringRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-UMCallAnsweringRule cmdlet to disable a call answering rule that has been created within a UM-enabled mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ The Disable-UMCallAnsweringRule cmdlet disables the call answering rule by modif When the call answering rule is created, you should disable the call answering rule when you're setting up conditions and actions. This prevents the call answering rule from being processed when an incoming call is received until you've correctly configured the call answering rule. After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,6 +83,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -162,12 +164,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-UMIPGateway.md b/exchange/exchange-ps/exchange/Disable-UMIPGateway.md index aeee802d11..f0738b7185 100644 --- a/exchange/exchange-ps/exchange/Disable-UMIPGateway.md +++ b/exchange/exchange-ps/exchange/Disable-UMIPGateway.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-umipgateway +online version: https://learn.microsoft.com/powershell/module/exchange/disable-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Disable-UMIPGateway schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-UMIPGateway cmdlet to disable a Unified Messaging (UM) IP gateway. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Disable-UMIPGateway [-Identity] ## DESCRIPTION The status variable for a UM IP gateway can be used to enable or disable call answering destined for the IP gateway. The Disable-UMIPGateway cmdlet disables a UM IP gateway in Active Directory by modifying its status variable. After this task is completed, the UM IP gateway no longer answers incoming calls or makes outgoing calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +74,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -140,12 +142,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-UMMailbox.md b/exchange/exchange-ps/exchange/Disable-UMMailbox.md index 0e0987e3ef..f9ea3dd8ba 100644 --- a/exchange/exchange-ps/exchange/Disable-UMMailbox.md +++ b/exchange/exchange-ps/exchange/Disable-UMMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-ummailbox +online version: https://learn.microsoft.com/powershell/module/exchange/disable-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Disable-UMMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Disable-UMMailbox cmdlet to disable Unified Messaging (UM) for UM-enabled mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Disable-UMMailbox [-Identity] ## DESCRIPTION After the mailbox is disabled for Unified Messaging, the user can no longer use the UM features that are included in Microsoft Exchange and the Microsoft Exchange Unified Messaging service no longer handle calls for the associated extension number. The mailbox continues to function normally for all other operations that are unrelated to Unified Messaging. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,9 +109,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -169,12 +169,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-UMServer.md b/exchange/exchange-ps/exchange/Disable-UMServer.md index 722880178d..2b34bd0f25 100644 --- a/exchange/exchange-ps/exchange/Disable-UMServer.md +++ b/exchange/exchange-ps/exchange/Disable-UMServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-umserver +online version: https://learn.microsoft.com/powershell/module/exchange/disable-umserver applicable: Exchange Server 2010 title: Disable-UMServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Disable-UMServer cmdlet to set the status of an Exchange Server 2010 Unified Messaging (UM) server to disabled. This prevents the Unified Messaging server from processing UM calls. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ After this task is completed, the UM server can no longer: - Be used to manage UM-enabled mailboxes - Be queried when a diagnostic task is used -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -147,12 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disable-UMService.md b/exchange/exchange-ps/exchange/Disable-UMService.md index e764f29bc7..48cc82a85b 100644 --- a/exchange/exchange-ps/exchange/Disable-UMService.md +++ b/exchange/exchange-ps/exchange/Disable-UMService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/disable-umservice +online version: https://learn.microsoft.com/powershell/module/exchange/disable-umservice applicable: Exchange Server 2013, Exchange Server 2016 title: Disable-UMService schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Disable-UMService cmdlet to set the status of an Exchange Server 2010 Un You can run this cmdlet in Exchange 2013 or Exchange 2016, but the target server must be an Exchange 2010 UM server. You can't use this cmdlet to disable the UM service on Exchange 2013 or Exchange 2016 Mailbox servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ After this task is completed, the UM server can no longer: - Be used to manage UM-enabled mailboxes. - Be queried when a diagnostic task is used. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -154,12 +154,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md index c0e3298b28..c2a6bb1153 100644 --- a/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md +++ b/exchange/exchange-ps/exchange/Disconnect-ExchangeOnline.md @@ -1,36 +1,56 @@ --- external help file: ExchangeOnlineManagement-help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/disconnect-exchangeonline +online version: https://learn.microsoft.com/powershell/module/exchange/disconnect-exchangeonline applicable: Exchange Online title: Disconnect-ExchangeOnline schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Disconnect-ExchangeOnline ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Disconnect-ExchangeOnline cmdlet in the Exchange Online PowerShell V2 module to disconnect from remote PowerShell sessions that you opened using the Connect-ExchangeOnline or Connect-IPPSSession cmdlets. +Use the Disconnect-ExchangeOnline cmdlet in the Exchange Online PowerShell module to disconnect the connections that you created using the Connect-ExchangeOnline or Connect-IPPSSession cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### DefaultParameterSet (Default) ``` -Disconnect-ExchangeOnline [-Confirm] +Disconnect-ExchangeOnline + [-Confirm] + [-WhatIf] + [] +``` + +### ConnectionId +``` +Disconnect-ExchangeOnline -ConnectionId + [-Confirm] + [-WhatIf] + [] +``` + +### ModulePrefix +``` +Disconnect-ExchangeOnline -ModulePrefix + [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION -The Connect-ExchangeOnline cmdlet establishes a connection to the Exchange Online organization of the logged-in admin user. This cmdlet is the counterpart to Connect-ExchangeOnline. +This cmdlet is the counterpart to the Connect-ExchangeOnline and Connect-IPPSSession cmdlets. -Disconnect-ExchangeOnline closes any active session and clears the cache. After a successful disconnect, you can't run any of the V2 cmdlets or older remote PowerShell cmdlets. +This cmdlet disconnects any connections and clears the cache. After a successful disconnect, you can't successfully run any cmdlets for your organization. + +Disconnect commands will likely fail if the profile path of the account that you used to connect contains special PowerShell characters (for example, `$`). The workaround is to connect using a different account that doesn't have special characters in the profile path. ## EXAMPLES @@ -39,21 +59,28 @@ Disconnect-ExchangeOnline closes any active session and clears the cache. After Disconnect-ExchangeOnline ``` -This example asks for confirmation before disconnecting the current Exchange Online PowerShell session. +This example asks for confirmation before disconnecting from Exchange Online PowerShell or Security & Compliance PowerShell. ### Example 2 ```powershell Disconnect-ExchangeOnline -Confirm:$false ``` -This example disconnects the current Exchange Online PowerShell session without a confirmation prompt. Note that the following notification text is still displayed: `Removed the PSSession connected to outlook.office365.com Disconnected successfully !`. +This example silently disconnects from Exchange Online PowerShell or Security & Compliance PowerShell without a confirmation prompt or any notification text. ### Example 3 ```powershell -Disconnect-ExchangeOnline -Confirm:$false -InformationAction Ignore -ErrorAction SilentlyContinue +Disconnect-ExchangeOnline -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85 +``` + +This example disconnects the REST-based Exchange Online PowerShell connection with the specified ConnectionId value. Any other remote PowerShell connections to Exchange Online PowerShell or Security & Compliance PowerShell in the same Windows PowerShell window are also disconnected. + +### Example 4 +```powershell +Disconnect-ExchangeOnline -ModulePrefix Contoso,Fabrikam ``` -This example silently disconnects the current Exchange Online PowerShell session, without a confirmation prompt or any notification text. +This example disconnects the REST-based Exchange Online PowerShell connections that are using the specified prefix values. Any other remote PowerShell connections to Exchange Online PowerShell or Security & Compliance PowerShell in the same Windows PowerShell window are also disconnected. ## PARAMETERS @@ -76,6 +103,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectionId +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The ConnectionId parameter specifies the REST API connections to disconnect by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas. + +Don't use this parameter with the ModulePrefix parameter. + +```yaml +Type: String[] +Parameter Sets: ConnectionId +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulePrefix +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The ModulePrefix parameter specifies the REST API connections to disconnect by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas. + +Don't use this parameter with the ConnectionId parameter. + +```yaml +Type: String[] +Parameter Sets: ModulePrefix +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +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. @@ -97,12 +164,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Dismount-Database.md b/exchange/exchange-ps/exchange/Dismount-Database.md index 2a5a8816de..7159912a4e 100644 --- a/exchange/exchange-ps/exchange/Dismount-Database.md +++ b/exchange/exchange-ps/exchange/Dismount-Database.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/dismount-database +online version: https://learn.microsoft.com/powershell/module/exchange/dismount-database applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Dismount-Database schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Dismount-Database cmdlet to dismount databases. You can run this command only if the Microsoft Exchange Information Store service is running. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Dismount-Database [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md b/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md index e69dd3e8ed..b16e9a249e 100644 --- a/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md +++ b/exchange/exchange-ps/exchange/Dump-ProvisioningCache.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/dump-provisioningcache +online version: https://learn.microsoft.com/powershell/module/exchange/dump-provisioningcache applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Dump-ProvisioningCache schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Dump-ProvisioningCache cmdlet to return a list of the cached keys and values for the specified server and Windows PowerShell application. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,7 +46,7 @@ The Dump-ProvisioningCache cmdlet is for diagnostic purposes only and is rarely The Dump-ProvisioningCache cmdlet displays a list of the Windows PowerShell provisioning cache keys. Use the value of these cache keys with the Reset-ProvisioningCache cmdlet to reset provisioning cache data. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,7 +99,7 @@ Accept wildcard characters: False ``` ### -GlobalCache -The GlobalCache switch specifies that all cache keys are cleared. +The GlobalCache switch specifies that all cache keys are cleared. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -152,7 +152,7 @@ Accept wildcard characters: False ``` ### -CurrentOrganization -The CurrentOrganization switch specifies that the provision cache is reset for this organization. +The CurrentOrganization switch specifies that the provision cache is reset for this organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -204,12 +204,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..af887e025f --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-atpprotectionpolicyrule +applicable: Exchange Online +title: Enable-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-ATPProtectionPolicyRule and Enable-EOPProtectionPolicyRule cmdlets together to turn on the Standard preset security policy or the Strict preset security policy in organizations with Microsoft Defender for Office 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-ATPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled. + +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations with Defender for Office 365, this example turns on the Standard preset security policy. The State value of both rules is now Enabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-AddressListPaging.md b/exchange/exchange-ps/exchange/Enable-AddressListPaging.md index 7030c376fa..7bdc8deb33 100644 --- a/exchange/exchange-ps/exchange/Enable-AddressListPaging.md +++ b/exchange/exchange-ps/exchange/Enable-AddressListPaging.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-addresslistpaging +online version: https://learn.microsoft.com/powershell/module/exchange/enable-addresslistpaging applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-AddressListPaging schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-AddressListPaging cmdlet to enable Active Directory virtual list view for address lists. Virtual list view allows you to display the address lists in your organization as pages instead of loading and viewing the entire directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Enable-AddressListPaging [-Confirm] ## DESCRIPTION The Enable-AddressListPaging cmdlet creates the Address List container in Active Directory. Recipient cmdlets, such as Get-Recipient, use the information written to the container to quickly retrieve recipient data. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,12 +99,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md b/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md index 28457210aa..55bc463ac2 100644 --- a/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/Enable-AntiPhishRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-antiphishrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-antiphishrule applicable: Exchange Online, Exchange Online Protection title: Enable-AntiPhishRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Enable-AntiPhishRule cmdlet to enable antiphish rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Enable-AntiPhishRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md b/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md index 4c3056db16..40a8ec1a57 100644 --- a/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md +++ b/exchange/exchange-ps/exchange/Enable-AntispamUpdates.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-antispamupdates +online version: https://learn.microsoft.com/powershell/module/exchange/enable-antispamupdates applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-AntispamUpdates schema: 2.0.0 @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS The Enable-AntispamUpdates cmdlet was deprecated in Microsoft Exchange Server 2010 Service Pack 1 and is no longer used. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -109,12 +109,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-App.md b/exchange/exchange-ps/exchange/Enable-App.md index a7c9a19ac3..788dc99c86 100644 --- a/exchange/exchange-ps/exchange/Enable-App.md +++ b/exchange/exchange-ps/exchange/Enable-App.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-app +online version: https://learn.microsoft.com/powershell/module/exchange/enable-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Enable-App schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-App cmdlet to enable (turn on) a specific app for a specific user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Enable-App [-Identity] ## DESCRIPTION The Enable-App cmdlet requires that the specified app has already been installed (for example, that it has been installed with the New-App cmdlet, or that it's a default app for Microsoft Outlook). -For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://docs.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://docs.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). +For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://learn.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://learn.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ Enable-App -Identity -Mailbox Tony This example enables the administrator-installed app FinanceTestApp for user Tony. -### Example 1 +### Example 3 ```powershell Enable-App -Identity 545d8236-721a-468f-85d8-254eca7cb0da -Mailbox Tony ``` @@ -162,12 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md index 856d054b54..588d8f1d9a 100644 --- a/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/exchange/Enable-CmdletExtensionAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-cmdletextensionagent +online version: https://learn.microsoft.com/powershell/module/exchange/enable-cmdletextensionagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-CmdletExtensionAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-CmdletExtensionAgent cmdlet to enable existing cmdlet extension agents. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ When you enable a cmdlet extension agent, the agent is run on every Exchange ser Before you enable agents, be sure that you're aware of how the agent works and what impact the agent will have on your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,12 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md index 3b0d8a2c0f..c2a69f5215 100644 --- a/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md +++ b/exchange/exchange-ps/exchange/Enable-ComplianceTagStorage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-compliancetagstorage -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/enable-compliancetagstorage +applicable: Security & Compliance title: Enable-ComplianceTagStorage schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Enable-ComplianceTagStorage ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Enable-ComplianceTagStorage cmdlet to create the retention label policy in the Microsoft 365 security center. This is a one-time operation. Retention labels apply retention settings to content. +Use the Enable-ComplianceTagStorage cmdlet to create the retention label policy in the Microsoft Purview compliance portal. This is a one-time operation. Retention labels apply retention settings to content. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,9 +29,9 @@ Enable-ComplianceTagStorage ``` ## DESCRIPTION -If you run this cmdlet more than once, you'll get an error that says a policy already exists. +You can check the status by running the following command: `Get-ComplianceTagStorage | Format-List Enabled,DistributionStatus`. The value True for the Enabled property and the value Success for the DistributionStatus property indicates the Enable-ComplianceTagStorage cmdlet has already been run in the organization, and you don't need to run it again. If you run the cmdlet unnecessarily, you'll get a warning, and the DistributionStatus property changes to the value Pending for a few minutes before returning to the value Success. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -40,7 +40,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Enable-ComplianceTagStorage ``` -This example creates the label policy in the Microsoft 365 compliance center. +This example creates the label policy in the Microsoft Purview compliance portal. ## PARAMETERS @@ -54,7 +54,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -70,7 +70,7 @@ This RecordsManagementSecurityGroupEmail parameter specifies the email address o Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +80,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,12 +100,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md b/exchange/exchange-ps/exchange/Enable-DistributionGroup.md index 3f9e50109c..cda305dfb4 100644 --- a/exchange/exchange-ps/exchange/Enable-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Enable-DistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-distributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/enable-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-DistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-DistributionGroup cmdlet to mail-enable existing universal security groups and universal distribution groups that aren't already mail-enabled. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,9 @@ Enable-DistributionGroup [-Identity] ## DESCRIPTION The Enable-DistributionGroup cmdlet mail-enables existing universal security groups and universal distribution groups by adding the email attributes that are required by Exchange. Mail-enabled security groups and distribution groups are visible to the other \*-DistributionGroup cmdlets and to the \*-DistributionGroupMember cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. ## EXAMPLES @@ -69,15 +71,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -151,7 +158,7 @@ Accept wildcard characters: False ### -PrimarySmtpAddress The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. -By default, the primary SMTP address is generated based on the default email address policy and the value of the Alias parameter or the Name property. If you use the PrimarySmtpAddress parameter to specify the primary email address, the EmailAddressPolicyEnabled property is set to the value False, which means the email addresses of this group won't be automatically updated by email address policies. +By default, the primary SMTP address is generated based on the default email address policy and the value of the Alias parameter or the Name property. If you use the PrimarySmtpAddress parameter to specify the primary email address, the EmailAddressPolicyEnabled property is set to the value False, which means the email addresses of the group won't be automatically updated by email address policies. ```yaml Type: SmtpAddress @@ -187,12 +194,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md b/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md new file mode 100644 index 0000000000..785b0029ab --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-DnssecForVerifiedDomain.md @@ -0,0 +1,105 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-dnssecforverifieddomain +applicable: Exchange Online +title: Enable-DnssecForVerifiedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-DnssecForVerifiedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-DnssecForVerifiedDomain cmdlet to enable Domain Name System Security (DNSSEC) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-DnssecForVerifiedDomain [-DomainName] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The output of this cmdlet is an MX record value that you need to add to DNS for the specified domain. + +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-DnssecForVerifiedDomain -DomainName contoso.com +``` + +This example enables DNSSEC for mail sent to contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to enable DNSSEC (for example, contoso.com). Use the Get-AcceptedDomain cmdlet to see the accepted domains in the organization. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..a73b54c47d --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: Enable-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-EOPProtectionPolicyRule cmdlet to turn on the Standard preset security policy or the Strict preset security policy. If your organization has Defender for Office 365, you also need to use the Enable-ATPProtectionPolicyRule cmdlet to turn on the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-EOPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled. + +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations without Defender for Office 365, this example turns off the Standard preset security policy. The State property value of the rule is now Enabled. + +### Example 2 +```powershell +Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Enable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +In organizations with Defender for Office 365, this example turns on the Standard preset security policy. The State property value of both rules is now Enabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md index e45a8fc424..29cc1af6d3 100644 --- a/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Enable-ExchangeCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-exchangecertificate +online version: https://learn.microsoft.com/powershell/module/exchange/enable-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-ExchangeCertificate schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-ExchangeCertificate cmdlet to enable an existing certificate on the Exchange server for Exchange services such as Internet Information Services (IIS), SMTP, POP, IMAP and Unified Messaging (UM). Once you enable a certificate for a service, you can't disable it. -To see the existing certificates that are used for Exchange services, use [Get-ExchangeCertificate](https://docs.microsoft.com/powershell/module/exchange/get-exchangecertificate). +To see the existing certificates that are used for Exchange services, use [Get-ExchangeCertificate](https://learn.microsoft.com/powershell/module/exchange/get-exchangecertificate). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,11 +52,11 @@ The Enable-ExchangeCertificate cmdlet enables certificates by updating the metad After you run the Enable-ExchangeCertificate cmdlet, you might need to restart Internet Information Services (IIS). In some scenarios, Exchange might continue to use the previous certificate for encrypting and decrypting the cookie that's used for Outlook on the web (formerly known as Outlook Web App) authentication. We recommend restarting IIS in environments that use Layer 4 load balancing. -There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://docs.microsoft.com/Exchange/architecture/client-access/certificates). +There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/certificates). -Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out [Protecting you against the SSL 3.0 vulnerability](https://blogs.office.com/2014/10/29/protecting-ssl-3-0-vulnerability/). +Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). For more information, see [Exchange Server TLS configuration best practices](https://learn.microsoft.com/Exchange/exchange-tls-configuration). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -198,7 +198,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. By default, when you enable a certificate for SMTP, the command prompts you to replace the existing certificate that's enabled for SMTP, which is likely the default Exchange self-signed certificate. @@ -277,12 +279,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md index 3a84464838..8b49e06134 100644 --- a/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/Enable-HostedContentFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-hostedcontentfilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection title: Enable-HostedContentFilterRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Enable-HostedContentFilterRule cmdlet to enable spam filter rules (content filter rules) in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Enable-HostedContentFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,12 +101,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md index 406be7ca20..b0b6d2ea45 100644 --- a/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/exchange/Enable-HostedOutboundSpamFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-hostedoutboundspamfilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection title: Enable-HostedOutboundSpamFilterRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Enable-HostedOutboundSpamFilterRule cmdlet to enable outbound spam filter rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Enable-HostedOutboundSpamFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md b/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md new file mode 100644 index 0000000000..1ce4f5db89 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-IPv6ForAcceptedDomain.md @@ -0,0 +1,105 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/enable-ipv6foraccepteddomain +applicable: Exchange Online +title: Enable-IPv6ForAcceptedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-IPv6ForAcceptedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-IPv6ForAcceptedDomain cmdlet to enable support for mail delivery to accepted domains in Exchange Online using IPv6. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-IPv6ForAcceptedDomain [[-Domain] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Online organization to use with this cmdlet + +If IPv6 is enabled for an accepted domain in Exchange Online, IPv4 and IPv6 addresses are returned in DNS queries for mail flow records of the domain. If IPv6 is disabled, only IPv4 addresses are returned in DNS queries for mail flow records of the domain. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-IPv6ForAcceptedDomain -Domain contoso.com +``` + +This example enables IPv6 support for mail sent to contoso.com. Mail can be delivered to the domain using IPv4 or IPv6. + +## PARAMETERS + +### -Domain +The Domain parameter specifies the accepted domain that you want to enable mail delivery using IPv6 for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-InboxRule.md b/exchange/exchange-ps/exchange/Enable-InboxRule.md index 7748ec951e..a4e38bdcbb 100644 --- a/exchange/exchange-ps/exchange/Enable-InboxRule.md +++ b/exchange/exchange-ps/exchange/Enable-InboxRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-inboxrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Enable-InboxRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-InboxRule cmdlet to enable an Inbox rule. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Enable-InboxRule [-Identity] ## DESCRIPTION When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,7 +69,7 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. +The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -122,7 +122,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -187,12 +189,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-JournalRule.md b/exchange/exchange-ps/exchange/Enable-JournalRule.md index 40e8d7a643..a642ee6b6f 100644 --- a/exchange/exchange-ps/exchange/Enable-JournalRule.md +++ b/exchange/exchange-ps/exchange/Enable-JournalRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-journalrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Enable-JournalRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-JournalRule cmdlet to enable an existing journal rule on a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,9 +29,9 @@ Enable-JournalRule [-Identity] ``` ## DESCRIPTION -You can enable or disable specific journal rules in your organization at any time using the Enable-JournalRule and Disable-JournalRule cmdlets. For more information, see [Journaling in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/journaling/journaling). +You can enable or disable specific journal rules in your organization at any time using the Enable-JournalRule and Disable-JournalRule cmdlets. For more information, see [Journaling in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/journaling/journaling). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-MailContact.md b/exchange/exchange-ps/exchange/Enable-MailContact.md index e7a9648a44..32afb576cd 100644 --- a/exchange/exchange-ps/exchange/Enable-MailContact.md +++ b/exchange/exchange-ps/exchange/Enable-MailContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-mailcontact +online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-MailContact schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-MailContact cmdlet to add email capabilities to existing contacts that aren't already mail-enabled. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ Enable-MailContact [-Identity] -ExternalEmailAddress ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -187,12 +187,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-MailUser.md b/exchange/exchange-ps/exchange/Enable-MailUser.md index ea84552cf2..0a00e13f2c 100644 --- a/exchange/exchange-ps/exchange/Enable-MailUser.md +++ b/exchange/exchange-ps/exchange/Enable-MailUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-mailuser +online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-MailUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-MailUser cmdlet to mail-enable existing users that aren't already mail-enabled. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -54,7 +54,7 @@ The Enable-MailUser cmdlet mail-enables existing users by adding the email attri Mail users have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. Email messages sent to mail users are delivered to the specified external email address. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,15 +118,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -334,12 +339,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-Mailbox.md b/exchange/exchange-ps/exchange/Enable-Mailbox.md index bf22a6a22b..3a49c7ac0c 100644 --- a/exchange/exchange-ps/exchange/Enable-Mailbox.md +++ b/exchange/exchange-ps/exchange/Enable-Mailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailbox +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Enable-Mailbox schema: 2.0.0 author: chrisda @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-Mailbox cmdlet to create mailboxes for existing users who don't already have mailboxes. You can also use this cmdlet to create In-Place archives for existing mailboxes. -**Note**: In Exchange Online, you use this cmdlet to add archive mailboxes for existing users and to enable auto-expanding archives. To add a mailbox for an existing Azure AD account, you need to add a license to the account as described in [Assign licenses to user accounts](https://docs.microsoft.com/office365/enterprise/powershell/assign-licenses-to-user-accounts-with-office-365-powershell). +**Note**: In Exchange Online, you use this cmdlet to add archive mailboxes for existing users and to enable auto-expanding archives. To add a mailbox for an existing Microsoft Entra account, you need to add a license to the account as described in [Assign licenses to user accounts](https://learn.microsoft.com/office365/enterprise/powershell/assign-licenses-to-user-accounts-with-office-365-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -125,7 +125,7 @@ Enable-Mailbox [-Identity] -LinkedDomainController -L ### Linked ``` -Enable-Mailbox [-Identity] -LinkedDomainController -LinkedMasterAccount +Enable-Mailbox [-Identity] -LinkedDomainController -LinkedMasterAccount [-LinkedCredential ] [-ActiveSyncMailboxPolicy ] [-Alias ] @@ -228,7 +228,7 @@ Enable-Mailbox [-Identity] ] [-Archive] [-ArchiveGuid ] [-ArchiveName ] [-ActiveSyncMailboxPolicy ] - [-Alias + [-Alias ] [-Confirm] [-DisplayName ] [-DomainController ] @@ -272,7 +272,9 @@ The Enable-Mailbox cmdlet mailbox-enables existing users, public folders, or Ine When mailbox-enabling an existing user, beware of non-supported characters in the user account or Name property. If you don't specify an Alias value when you mailbox-enable the user, Exchange converts all non-supported characters to question marks (?). To avoid question marks in the Alias, verify that the user account and Name properties have only supported ASCII or Unicode characters or specify an Alias value when you mailbox-enable the user. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. ## EXAMPLES @@ -311,7 +313,7 @@ The Identity parameter specifies the user or InetOrgPerson object that you want Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -365,7 +367,7 @@ This parameter is available only in on-premises Exchange. The Discovery switch is required to mailbox-enable Discovery mailboxes. You don't need to specify a value with this switch. -Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be converted to another type of mailbox. For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). +Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be converted to another type of mailbox. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: SwitchParameter @@ -423,7 +425,7 @@ Accept wildcard characters: False ### -LinkedMasterAccount This parameter is available only in on-premises Exchange. -The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: For example: +The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account. For example: - Name - Distinguished name (DN) @@ -558,7 +560,7 @@ The AddressBookPolicy parameter specifies the address book policy that's applied - Distinguished name (DN) - GUID -For more information about address book policies, see [Address book policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). +For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). ```yaml Type: AddressBookMailboxPolicyIdParameter @@ -576,15 +578,20 @@ Accept wildcard characters: False ### -Alias This parameter is available only in on-premises Exchange. -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -611,7 +618,7 @@ The Archive switch creates an archive mailbox for an existing user that already Type: SwitchParameter Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -661,15 +668,23 @@ Accept wildcard characters: False ``` ### -ArchiveName -The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook and Outlook Web App. +The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). + +In on-premises Exchange, if you don't use this parameter, the following default values are used based on the version of Exchange: -If you don't use this parameter, the default value is `In-Place Archive - `. +- Exchange 2016 or later: `In-Place Archive -` +- Exchange 2013: `In-Place Archive - ` +- Exchange 2010: `Personal Archive - ` + +In Exchange Online, if you don't use this parameter, the default value is `In-Place Archive -`. + +In Outlook in Exchange Online, the value of this parameter is ignored. The name of the archive mailbox that's shown in the folder list is `Online Archive - `. ```yaml Type: MultiValuedProperty Parameter Sets: Archive Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -699,7 +714,7 @@ Accept wildcard characters: False ### -AutoExpandingArchive This parameter is available only in the cloud-based service. -The AutoExpandingArchive switch enables the unlimited archiving feature (called auto-expanding archiving) for the specified mailbox. You don't need to specify a value with this switch. +The AutoExpandingArchive switch enables the auto-expanding archiving feature for the specified mailbox. You don't need to specify a value with this switch. After you enable auto-expanding archiving, additional storage space is automatically added to the user's archive mailbox when it approaches the storage limit. @@ -712,7 +727,7 @@ After you enable auto-expanding archiving, additional storage space is automatic Type: SwitchParameter Parameter Sets: AutoExpandingArchive Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -731,7 +746,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -801,13 +816,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -821,9 +838,9 @@ This parameter is available only in on-premises Exchange. The HoldForMigration switch specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging on to a public folder mailbox. You don't need to specify a value with this switch. -You need to use this parameter when you create the first public folder, which is called the hierarchy mailbox, in your organization. +You need to use this switch when you create the first public folder, which is called the hierarchy mailbox, in your organization. -Use this parameter only if you plan to migrate legacy Exchange 2010 public folders to Exchange 2016. If you use this switch but don't have legacy public folders to migrate, you won't be able to create any public folders. +Use this switch only if you plan to migrate legacy Exchange 2010 public folders to Exchange 2016. If you use this switch but don't have legacy public folders to migrate, you won't be able to create any public folders. ```yaml Type: SwitchParameter @@ -843,7 +860,7 @@ This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the credentials used to access the domain controller that's specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -879,7 +896,9 @@ Accept wildcard characters: False ### -ManagedFolderMailboxPolicyAllowed This parameter is available in Exchange Server 2010. -The ManagedFolderMailboxPolicyAllowed parameter specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Outlook earlier than Office Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed parameter is used. +The ManagedFolderMailboxPolicyAllowed switch specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Outlook earlier than Office Outlook 2007. You don't need to specify a value with this switch. + +When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed switch is used. Outlook 2003 Service Pack 3 clients are supported but are provided limited functionality for MRM. @@ -967,13 +986,13 @@ The RoleAssignmentPolicy parameter specifies the management role assignment poli - Distinguished name (DN) - GUID -If you don't use this parameter, the default role assignment policy is used. If the assignment policy name contains spaces, enclose the name in quotation marks ("). If you don't want to assign an assignment policy when a mailbox is created or enabled, specify a value of $null. For more information about assignment policies, see [Understanding management role assignment policies](https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). +If you don't use this parameter, the default role assignment policy is used. If the assignment policy name contains spaces, enclose the name in quotation marks ("). If you don't want to assign an assignment policy when a mailbox is created or enabled, specify a value of $null. For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). ```yaml Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -989,7 +1008,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1003,12 +1022,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md b/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md index 006ee9c4bf..94f1b1b2d7 100644 --- a/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md +++ b/exchange/exchange-ps/exchange/Enable-MailboxQuarantine.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-mailboxquarantine +online version: https://learn.microsoft.com/powershell/module/exchange/enable-mailboxquarantine applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-MailboxQuarantine schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-MailboxQuarantine cmdlet to quarantine mailboxes that affect the availability of the mailbox database. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,7 +53,7 @@ Enable-MailboxQuarantine -Database -StoreMailboxIdentity < ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -153,7 +153,7 @@ Accept wildcard characters: False ``` ### -AllowMigration -The AllowMigration switch allows a quarantined mailbox to be moved to another mailbox database or to the cloud. You don't have to specify a value with this switch. +The AllowMigration switch allows a quarantined mailbox to be moved to another mailbox database or to the cloud. You don't need to specify a value with this switch. Moving a mailbox is one method of correcting data corruption that's required before releasing the mailbox from quarantine. @@ -176,6 +176,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -244,12 +246,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md index 6a2bfe4e77..d671effeae 100644 --- a/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Enable-MalwareFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-malwarefilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Enable-MalwareFilterRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-MalwareFilterRule cmdlet to enable malware filter rules in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Enable-MalwareFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md b/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md index e3152895a2..642a0ec9b8 100644 --- a/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md +++ b/exchange/exchange-ps/exchange/Enable-MetaCacheDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-metacachedatabase +online version: https://learn.microsoft.com/powershell/module/exchange/enable-metacachedatabase applicable: Exchange Server 2019 title: Enable-MetaCacheDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-MetaCacheDatabase cmdlet to enable the metacache database on Exchange 2019 Mailbox servers. The metacache database stores mailbox database indexes and secondary copies of metadata on solid state drives (SSDs) to improve search latency and user logons. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Enable-MetaCacheDatabase -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -104,12 +104,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md b/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md index bbdb7c165b..23f178be9e 100644 --- a/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md +++ b/exchange/exchange-ps/exchange/Enable-OrganizationCustomization.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-organizationcustomization +online version: https://learn.microsoft.com/powershell/module/exchange/enable-organizationcustomization applicable: Exchange Online, Exchange Online Protection title: Enable-OrganizationCustomization schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. You may be prompted to run the EnableOrganizationCustomization cmdlet before you create or modify objects in your Exchange Online organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,12 +36,13 @@ Here are some examples of when you might see this: - Creating a new Outlook on the web mailbox policy or modifying a built-in Outlook on the web mailbox policy. - Creating a new sharing policy or modifying a built-in sharing policy. - Creating a new retention policy or modifying a built-in retention policy. +- Enabling preset security policies in the Microsoft Defender portal. Note that you are only required to run the Enable-OrganizationCustomization cmdlet once in your Exchange Online organization. If you attempt to run the cmdlet again, you'll get an error. Whether or not this command has been previously run in an organization is available in the IsDehydrated property of the Get-OrganizationConfig cmdlet: False ($false) = the command has already been run; True ($true) = the command has never been run. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -96,12 +95,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md index db6465be0c..f2706fde72 100644 --- a/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Enable-OutlookAnywhere.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-outlookanywhere +online version: https://learn.microsoft.com/powershell/module/exchange/enable-outlookanywhere applicable: Exchange Server 2010 title: Enable-OutlookAnywhere schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Enable-OutlookAnywhere cmdlet to enable Outlook Anywhere on a computer running Microsoft Exchange Server 2010 that has the Client Access server role installed. Running the Enable-OutlookAnywhere cmdlet enables the server to accept requests from Microsoft Office Outlook 2007 and Outlook 2003 client computers from the Internet by using Outlook Anywhere, also known as RPC over HTTP. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -54,9 +54,9 @@ This cmdlet can be successfully run only if the RPC over HTTP proxy Windows netw When you run this cmdlet, it can take as long as an hour for the settings to become effective, depending on how long it takes for Active Directory to replicate. -For more information about the different authentication methods that you can see in this article, see [Understanding HTTP Authentication](https://docs.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication). +For more information about the different authentication methods that you can see in this article, see [Understanding HTTP Authentication](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -251,7 +251,7 @@ If you have a proxy server between the client and the Client Access server that' If you have a proxy server between the client and the Client Access server that's configured to terminate the client-to-proxy SSL channel, you must also configure one or more SPNs using the parameter ExtendedProtectionSPNList. -To learn more about Extended Protection for Authentication, see [Understanding Extended Protection for Authentication](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/ff459225(v=exchg.141)). +To learn more about Extended Protection for Authentication, see [Understanding Extended Protection for Authentication](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/ff459225(v=exchg.141)). ```yaml Type: ExtendedProtectionTokenCheckingMode @@ -330,12 +330,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md index 8b8b33dfdd..63e2c39801 100644 --- a/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/Enable-OutlookProtectionRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-outlookprotectionrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Enable-OutlookProtectionRule schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-OutlookProtectionRule cmdlet to enable an existing Outlook protection rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +31,9 @@ Enable-OutlookProtectionRule [-Identity] ``` ## DESCRIPTION -Outlook protection rules are used to automatically Information Rights Management (IRM)-protect messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). +Outlook protection rules are used to automatically Information Rights Management (IRM)-protect messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md b/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md index b6ca29597f..e23369448c 100644 --- a/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md +++ b/exchange/exchange-ps/exchange/Enable-PushNotificationProxy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-pushnotificationproxy +online version: https://learn.microsoft.com/powershell/module/exchange/enable-pushnotificationproxy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-PushNotificationProxy schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Enable-PushNotificationProxy cmdlet to enable a push notification proxy In order for event notifications to be successfully delivered, you also need to configure OAuth authentication between your on-premises Exchange organization and your Microsoft 365 organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Enable-PushNotificationProxy [-Confirm] ## DESCRIPTION The push notification proxy relays event notifications (for example, new email or calendar updates) for on-premises mailboxes through Microsoft 365 to Outlook on the web for devices on the user's device. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,10 +46,10 @@ This example displays the status of the push notification proxy in the on-premis ### Example 2 ```powershell -Enable-PushNotificationProxy -Organization contoso.com +Enable-PushNotificationProxy -Organization contoso.onmicrosoft.com ``` -This example enables the push notification proxy in the on-premises Exchange organization by using the Microsoft 365 organization contoso.com. +This example enables the push notification proxy in the on-premises Exchange organization by using the Microsoft 365 organization contoso.onmicrosoft.com. ## PARAMETERS @@ -73,7 +73,7 @@ Accept wildcard characters: False ``` ### -Organization -The Organization parameter specifies the domain name of the Microsoft 365 organization. For example, contoso.com. +The Organization parameter specifies the domain name of the Microsoft 365 organization. For example, contoso.onmicrosoft.com. ```yaml Type: String @@ -89,7 +89,7 @@ Accept wildcard characters: False ``` ### -Uri -The Uri parameter specifies the push notification service endpoint in Microsoft 365. The default value is https://outlook.office365.com/PushNotifications. +The Uri parameter specifies the push notification service endpoint in Microsoft 365. The default value is . ```yaml Type: String @@ -125,12 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md b/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md index 29c383cd7d..e2ca574784 100644 --- a/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Enable-RemoteMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-remotemailbox +online version: https://learn.microsoft.com/powershell/module/exchange/enable-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-RemoteMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-RemoteMailbox cmdlet to create a mailbox in the cloud-based service for an existing user in the on-premises Active Directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -101,7 +101,7 @@ Directory synchronization must be configured correctly for a mailbox to be creat The policies that you apply to recipients in the on-premises Exchange organization, such as Unified Messaging or compliance policies, aren't applied to mailboxes in the service. You must configure policies in the service if you want policies to be applied to recipients in the service. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -117,6 +117,7 @@ After the user is mail-enabled, directory synchronization synchronizes the mail- ### Example 2 ```powershell Enable-RemoteMailbox "Kim Akers" -RemoteRoutingAddress "kima@contoso.mail.onmicrosoft.com" + Enable-RemoteMailbox "Kim Akers" -Archive ``` @@ -231,15 +232,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -260,7 +266,7 @@ Accept wildcard characters: False ``` ### -Archive -The Archive switch specifies whether to create an archive mailbox in the service in addition to the mailbox created in the service. You don't need to specify a value with this switch. +The Archive switch creates an archive mailbox for an existing cloud-based user that already has a mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -276,7 +282,15 @@ Accept wildcard characters: False ``` ### -ArchiveName -The ArchiveName parameter specifies the name of the archive mailbox. Use this parameter to change the name of the archive. +The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). + +If you don't use this parameter, the following default values are used based on the version of Exchange: + +- Exchange 2016 or later: `In-Place Archive -` +- Exchange 2013: `In-Place Archive - ` +- Exchange 2010: `Personal Archive - ` + +In Outlook, the value of this parameter is ignored. The name of the archive mailbox that's shown in the folder list is `Online Archive - `. ```yaml Type: MultiValuedProperty @@ -395,12 +409,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md new file mode 100644 index 0000000000..9bf1aa79ac --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-ReportSubmissionRule.md @@ -0,0 +1,104 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-reportsubmissionrule +applicable: Exchange Online +title: Enable-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-ReportSubmissionRule cmdlet to enable the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-ReportSubmissionRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-ReportSubmissionRule -Identity DefaultReportSubmissionRule. +``` + +This example enables the report submission rule if it's already disabled. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to enable. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md index 4177bf61ad..2642212149 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Enable-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/enable-safeattachmentrule +applicable: Exchange Online title: Enable-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Enable-SafeAttachmentRule cmdlet to enable safe attachment rules in your cloud-based organization. This cmdlet is also responsible for disabling complete Safe Attachments policies in the admin center, which consist of the safe attachment rule and the corresponding assigned safe attachment policy in PowerShell. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +28,9 @@ Enable-SafeAttachmentRule [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -77,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -107,12 +105,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md index b08646d678..1314b22664 100644 --- a/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Enable-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-safelinksrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/enable-safelinksrule +applicable: Exchange Online title: Enable-SafeLinksRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Enable-SafeLinksRule cmdlet to enable disabled Safe Links rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Enable-SafeLinksRule [-Identity] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -77,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -107,12 +105,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md b/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md index bb83046071..206921ec6f 100644 --- a/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md +++ b/exchange/exchange-ps/exchange/Enable-ServiceEmailChannel.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-serviceemailchannel +online version: https://learn.microsoft.com/powershell/module/exchange/enable-serviceemailchannel applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-ServiceEmailChannel schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-ServiceEmailChannel cmdlet to enable the .NET service channel for a specific user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Enable-ServiceEmailChannel [-Identity] ## DESCRIPTION The .NET service channel enables Microsoft Exchange to store information that it later forwards to applications or devices that aren't permanently connected to the server running Exchange. This cmdlet creates a receive folder in the user's mailbox under the root folder named Service E-mail. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -143,12 +143,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md b/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md new file mode 100644 index 0000000000..84502bb3b4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Enable-SmtpDaneInbound.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/enable-smtpdaneinbound +applicable: Exchange Online +title: Enable-SmtpDaneInbound +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Enable-SmtpDaneInbound + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Enable-SMTPDaneInbound cmdlet to enable SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Enable-SmtpDaneInbound [-DomainName] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Enable-SmtpDaneInbound -DomainName contoso.com +``` + +This example enables SMTP DANE for mail sent to contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to enable SMTP DANE (for example, contoso.com). Use the Get-AcceptedDomain cmdlet to see the accepted domains in the organization. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-SweepRule.md b/exchange/exchange-ps/exchange/Enable-SweepRule.md index 98088a3d4a..a5d16d3d5f 100644 --- a/exchange/exchange-ps/exchange/Enable-SweepRule.md +++ b/exchange/exchange-ps/exchange/Enable-SweepRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-sweeprule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Enable-SweepRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-SweepRule cmdlet to enable Sweep rules in mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Enable-SweepRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -155,12 +155,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Enable-TransportAgent.md b/exchange/exchange-ps/exchange/Enable-TransportAgent.md index 29af16462d..1985292cfa 100644 --- a/exchange/exchange-ps/exchange/Enable-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Enable-TransportAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-transportagent +online version: https://learn.microsoft.com/powershell/module/exchange/enable-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Enable-TransportAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-TransportAgent cmdlet to enable a transport agent. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Enable-TransportAgent [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -139,12 +139,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-TransportRule.md b/exchange/exchange-ps/exchange/Enable-TransportRule.md index 441c5f6dca..4f9a620693 100644 --- a/exchange/exchange-ps/exchange/Enable-TransportRule.md +++ b/exchange/exchange-ps/exchange/Enable-TransportRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-transportrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Enable-TransportRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-TransportRule cmdlet to enable transport rules (mail flow rules) in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Enable-TransportRule [-Identity] ## DESCRIPTION To disable rules that are enabled, use the Disable-TransportRule cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,7 +116,9 @@ The Mode parameter specifies how the rule operates after it's enabled. Valid val - Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. - AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. -- Enforce: All actions specified in the rule are taken. This is the default value. +- Enforce: All actions specified in the rule are taken. + +The value that has already been set in the rule will be persevered, unless -Mode parameter is specified. ```yaml Type: RuleMode @@ -152,12 +154,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md index 323d266e4c..b5a6029718 100644 --- a/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/Enable-UMAutoAttendant.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-umautoattendant +online version: https://learn.microsoft.com/powershell/module/exchange/enable-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Enable-UMAutoAttendant schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-UMAutoAttendant cmdlet to enable an existing Unified Messaging (UM) auto attendant that's disabled. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Enable-UMAutoAttendant [-Identity] ## DESCRIPTION The Enable-UMAutoAttendant cmdlet enables the UM auto attendant by modifying its status variable. When you create a UM auto attendant, it isn't enabled by default. For the auto attendant to answer incoming calls, you must first enable it. After this task is completed, the UM auto attendant answers incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md index 6c3e68713f..871ebf54fd 100644 --- a/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/exchange/Enable-UMCallAnsweringRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-umcallansweringrule +online version: https://learn.microsoft.com/powershell/module/exchange/enable-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 title: Enable-UMCallAnsweringRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-UMCallAnsweringRule cmdlet to enable a call answering rule that has been created within a UM-enabled mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ The Enable-UMCallAnsweringRule cmdlet enables the call answering rule by modifyi After this task is completed, the cmdlet sets the parameters and values specified. When you enable a call answering rule, the call answering rule is processed when an incoming call is received. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -162,12 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-UMIPGateway.md b/exchange/exchange-ps/exchange/Enable-UMIPGateway.md index 1bdf2f07ef..2b49427750 100644 --- a/exchange/exchange-ps/exchange/Enable-UMIPGateway.md +++ b/exchange/exchange-ps/exchange/Enable-UMIPGateway.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-umipgateway +online version: https://learn.microsoft.com/powershell/module/exchange/enable-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Enable-UMIPGateway schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-UMIPGateway cmdlet to enable a Unified Messaging (UM) IP gateway. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The status variable for a UM IP gateway can be used to enable or disable call an After this task is completed, the UM IP gateway answers incoming calls and makes outgoing calls through the IP gateway or IP Private Branch eXchange (PBX). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-UMMailbox.md b/exchange/exchange-ps/exchange/Enable-UMMailbox.md index 5168693fa7..64d7a8d5d7 100644 --- a/exchange/exchange-ps/exchange/Enable-UMMailbox.md +++ b/exchange/exchange-ps/exchange/Enable-UMMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-ummailbox +online version: https://learn.microsoft.com/powershell/module/exchange/enable-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Enable-UMMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Enable-UMMailbox cmdlet to enable Unified Messaging (UM) for existing mailbox users. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,7 +62,7 @@ Enable-UMMailbox [-Identity] ## DESCRIPTION When the mailbox is enabled for Unified Messaging, the settings from a UM mailbox policy are applied to the mailbox. After the mailbox is enabled for Unified Messaging, the user can use the UM features that are included in Microsoft Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -231,9 +231,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -356,7 +356,9 @@ Accept wildcard characters: False ``` ### -ValidateOnly -The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. No changes are made when the ValidateOnly switch is used. +The ValidateOnly switch tells the cmdlet to evaluate the conditions and requirements necessary to perform the operation and then reports whether the operation will succeed or fail. You don't need to specify a value with this switch. + +No changes are made when the ValidateOnly switch is used. ```yaml Type: SwitchParameter @@ -392,12 +394,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-UMServer.md b/exchange/exchange-ps/exchange/Enable-UMServer.md index 3b39033a90..01417d0e76 100644 --- a/exchange/exchange-ps/exchange/Enable-UMServer.md +++ b/exchange/exchange-ps/exchange/Enable-UMServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-umserver +online version: https://learn.microsoft.com/powershell/module/exchange/enable-umserver applicable: Exchange Server 2010 title: Enable-UMServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Enable-UMServer cmdlet to set the status of a Unified Messaging (UM) server to enabled. This enables the Unified Messaging server to process UM calls. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Enable-UMServer cmdlet sets the status of a Unified Messaging server. A UM s After this task is completed, the Unified Messaging server is available to answer incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Enable-UMService.md b/exchange/exchange-ps/exchange/Enable-UMService.md index 6791807cb2..d0441b4357 100644 --- a/exchange/exchange-ps/exchange/Enable-UMService.md +++ b/exchange/exchange-ps/exchange/Enable-UMService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/enable-umservice +online version: https://learn.microsoft.com/powershell/module/exchange/enable-umservice applicable: Exchange Server 2013, Exchange Server 2016 title: Enable-UMService schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Enable-UMService cmdlet to set the status of an Exchange Server 2010 Uni You can run this cmdlet in Exchange 2013 or Exchange 2016, but the target server must be an Exchange 2010 UM server. You can't use this cmdlet to enable the UM service on Exchange 2013 or Exchange 2016 Mailbox servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ The Enable-UMService cmdlet sets the status of an Exchange server running the Un After this task is completed, the UM server is available to answer incoming calls. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -125,12 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md b/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md index fc186dee41..8da13825b6 100644 --- a/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md +++ b/exchange/exchange-ps/exchange/Execute-AzureADLabelSync.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/execute-azureadlabelsync -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/execute-azureadlabelsync +applicable: Security & Compliance title: Execute-AzureADLabelSync schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Execute-AzureADLabelSync ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Execute-AzureADLabelSync cmdlet to start the synchronization of sensitivity labels into Azure Active Directory. This allows the application of sensitivity labels to Microsoft Teams sites, Microsoft 365 Groups, and SharePoint sites. This cmdlet is required if you were using sensitivity labels before September 2019. +Use the Execute-AzureADLabelSync cmdlet to start the synchronization of sensitivity labels into Microsoft Entra ID. This allows the application of sensitivity labels to Microsoft Teams sites, Microsoft 365 Groups, and SharePoint sites. This cmdlet is required if you were using sensitivity labels before September 2019. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ Execute-AzureADLabelSync [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -34,7 +34,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Execute-AzureADLabelSync ``` -This example will initialize the synchronization of sensitivity labels into Azure Active Directory. +This example will initialize the synchronization of sensitivity labels into Microsoft Entra ID. ## PARAMETERS @@ -43,12 +43,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Expedite-Delicensing.md b/exchange/exchange-ps/exchange/Expedite-Delicensing.md new file mode 100644 index 0000000000..f5c2af5041 --- /dev/null +++ b/exchange/exchange-ps/exchange/Expedite-Delicensing.md @@ -0,0 +1,77 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/expedite-delicensing +applicable: Exchange Online +title: Expedite-Delicensing +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Expedite-Delicensing + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Expedite-Delicensing cmdlet to end the delay for removing mailbox licenses from users. After you remove the delay, the licenses are removed from mailboxes within 24 hours. You configure delayed mailbox license removal using the DelayedDelicensingEnabled parameter on the Set-OrganizationConfig cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Expedite-Delicensing [-Identity] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Expedite-Delicensing -Identity yajvendra@contoso.onmicrosoft.com +``` + +This example ends the delay for the mailbox license removal request on the specified mailbox. Typically, the mailbox license is removed from the mailbox within 30 minutes after running the command, but it might take up to 24 hours. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox with a pending mailbox license removal request. + +You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Email address +- GUID +- LegacyExchangeDN +- User ID or user principal name (UPN) + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md b/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md index 7fc48af5b8..2af091f5e0 100644 --- a/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md +++ b/exchange/exchange-ps/exchange/Export-ActiveSyncLog.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-activesynclog +online version: https://learn.microsoft.com/powershell/module/exchange/export-activesynclog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Export-ActiveSyncLog schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Export-ActiveSyncLog cmdlet to parse the Internet Information Services (IIS) logs and return information about Microsoft Exchange ActiveSync usage, either on the screen or in an output file. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Export-ActiveSyncLog -Filename ## DESCRIPTION The Export-ActiveSyncLog cmdlet parses the IIS log files and returns information about Exchange ActiveSync usage. This cmdlet can export the output to a file or display it in the Exchange Management Shell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -115,7 +115,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -179,7 +181,9 @@ Accept wildcard characters: False ``` ### -UseGMT -The UseGMT switch specifies that Coordinated Universal Time (Greenwich Mean Time) is used for the time in the report output. By default, if this parameter isn't specified, local time is used. +The UseGMT switch specifies that Coordinated Universal Time (Greenwich Mean Time) is used for the time in the report output. You don't need to specify a value with this switch. + +If you don't use this switch, local time is used. ```yaml Type: SwitchParameter @@ -215,12 +219,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md new file mode 100644 index 0000000000..8d5bf12471 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-ActivityExplorerData.md @@ -0,0 +1,413 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata +applicable: Security & Compliance +title: Export-ActivityExplorerData +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-ActivityExplorerData + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Export-ActivityExplorerData cmdlet to export activities from Data classification \> Activity Explorer in the Microsoft 365 Purview compliance portal. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-ActivityExplorerData -EndTime -OutputFormat -StartTime + [-Filter1 ] + [-Filter2 ] + [-Filter3 ] + [-Filter4 ] + [-Filter5 ] + [-PageCookie ] + [-PageSize ] + [] +``` + +## DESCRIPTION +This cmdlet supports following filters: + +- Activity +- Application +- ArtifactType +- ClientIP +- ColdScanPolicyId +- CopilotAppHost +- CopilotThreadId +- CopilotType +- CreationTime +- DataState +- DestinationFilePath +- DestinationLocationType +- DeviceName +- DLPPolicyId +- DLPPolicyRuleId +- EmailReceiver +- EmailSender +- EndpointOperation +- EnforcementMode +- FalsePositive +- FileExtension +- GeneralPurposeComparison +- HowApplied +- HowAppliedDetail +- IrmUrlCategory +- IsProtected +- IsProtectedBefore +- ItemName +- LabelEventType +- Location +- MDATPDeviceId +- OriginatingDomain +- PageSize +- ParentArchiveHash +- Platform +- PolicyId +- PolicyMode +- PolicyName +- PolicyRuleAction +- PolicyRuleId +- PolicyRuleName +- PreviousFileName +- PreviousProtectionOwner +- ProtectionEventType +- ProtectionOwner +- RemovableMediaDeviceManufacturer +- RemovableMediaDeviceModel +- RemovableMediaDeviceSerialNumber +- RetentionLabel +- RMSEncrypted +- SensitiveInfoTypeClassifierType +- SensitiveInfoTypeConfidence +- SensitiveInfoTypeCount +- SensitiveInfoTypeId +- SensitivityLabel +- SensitivityLabelPolicy +- Sha1 +- Sha256 +- SourceLocationType +- TargetDomain +- TargetPrinterName +- User +- UsersPerDay +- Workload + +Valid workload filters include the following values: + +- Copilot +- Endpoint +- Exchange +- OnPremisesFileShareScanner +- OnPremisesSharePointScanner +- OneDrive +- PowerBI +- PurviewDataMap +- SharePoint + +Valid activity filters include the following values: + +- AIAppInteraction +- ArchiveCreated +- AutoLabelingSimulation +- BrowseToUrl +- ChangeProtection +- ClassificationAdded +- ClassificationDeleted +- ClassificationUpdated +- CopilotInteraction +- DLPInfo +- DLPRuleEnforce +- DLPRuleMatch +- DLPRuleUndo +- DlpClassification +- DownloadFile +- DownloadText +- FileAccessedByUnallowedApp +- FileArchived +- FileCopiedToClipboard +- FileCopiedToNetworkShare +- FileCopiedToRemoteDesktopSession +- FileCopiedToRemovableMedia +- FileCreated +- FileCreatedOnNetworkShare +- FileCreatedOnRemovableMedia +- FileDeleted +- FileDiscovered +- FileModified +- FilePrinted +- FileRead +- FileRenamed +- FileTransferredByBluetooth +- FileUploadedToCloud +- LabelApplied +- LabelChanged +- LabelRecommended +- LabelRecommendedAndDismissed +- LabelRemoved +- NewProtection +- PastedToBrowser +- RemoveProtection +- ScreenCapture +- UploadFile +- UploadText +- WebpageCopiedToClipboard +- WebpagePrinted +- WebpageSavedToLocal + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageSize 5000 -OutputFormat Json +``` + +This example exports a maximum of 5000 records for the specified date range in JSON format. + +### Example 2 +```powershell +Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -OutputFormat Json +``` + +This example exports up to 100 records for the specified date range in Json format. If more than 100 records are available, the value of the LastPage property in the command output will be False. Use the value of the Watermark property as the value of the PageCookie parameter in a new query to get the next set of records. + +### Example 3 +```powershell +$res = Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageSize 5000 -OutputFormat Json + +#Run the following steps in loop until all results are fetched + +while ($res.LastPage -ne $true) +{ + $pageCookie = $res.WaterMark + $res = Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageSize 5000 -OutputFormat Json -PageCookie $pageCookie +} +``` + +This example is related to the previous example where more than 100 records were available (the value of the LastPage property from that command was False). We're using the same date range, but this time we're using the value of the Watermark property from the previous command for the PageCookie parameter in this command to get the remaining results in a loop. ResultData from each iteration can be used as needed. + +### Example 4 +```powershell +Export-ActivityExplorerData -StartTime "07/06/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -Filter1 @("Activity", "FileArchived") -OutputFormat Csv +``` + +This example exports up to 100 records for the specified date range in CSV format, and filters the output by the Activity value FileArchived. + +### Example 5 +```powershell +Export-ActivityExplorerData -StartTime "07/06/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -Filter1 @("Activity", "FileArchived", "ArchiveCreated") -OutputFormat Json +``` + +This example exports up to 100 records for the specified date range in JSON format, and filters the output by the Activity value FileArchived or ArchiveCreated. + +### Example 6 +```powershell +Export-ActivityExplorerData -StartTime "07/06/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -Filter1 @("Activity", "FileArchived", "ArchiveCreated") -Filter2 @("Workload","Endpoint") -OutputFormat Json +``` + +This example exports up to 100 records for the specified date range in JSON format, and filters the output by the Workload value Endpoint for FileArchived or ArchiveCreated activities. + +## PARAMETERS + +### -EndTime +The EndTime parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFormat +The OutputFormat parameter specifies the output format. Valid values are: + +- Csv +- Json + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: csv, json +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartTime +The StartTime parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter1 +The Filter1 parameter filters the data to export. This parameter takes a minimum of two values as input: a filter name and at least one filter value. For example, `@("Activity", "LabelApplied")` returns records with the activity value `LabelApplied`. + +If you specify multiple filter values for the same parameter, OR behavior is used. For example, `@("Activity", "LabelApplied", "LabelRemoved")` returns records with the activity values `LabelApplied` or `LabelRemoved`. + +If you use this parameter with other filter parameters, AND behavior is used across parameters. For example: + +`-Filter1 @("Activity", "LabelApplied", "LabelRemoved") -Filter2 = @("Workload", "Exchange")` returns records with the activity values `LabelApplied` or `LabelRemoved` for the `Exchange` workload. In other words, ((`Activity eq LabelApplied`) OR (`Activity eq LabelRemoved`)) AND (`Workload eq Exchange`). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter2 +The Filter2 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. + +Use this parameter only if you're also using the Filter1 parameter in the same command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter3 +The Filter3 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. + +Use this parameter only if you're also using the Filter2 and Filter1 parameters in the same command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter4 +The Filter4 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. + +Use this parameter only if you're also using the Filter3, Filter2, and Filter1 parameters in the same command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filter5 +The Filter5 parameter filters the data to export. This parameter has the same syntax requirements as the Filter1 parameter, the same OR behavior for multiple values in the same parameter, and the same AND behavior for multiple filter parameters. + +Use this parameter only if you're also using the Filter4, Filter3, Filter2, and Filter1 parameters in the same command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageCookie +The PageCookie parameter specifies whether to get more data when the value of the LastPage property in the command output is False. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 5000 records can be returned. To get more records than what as returned in the current command, use the value of the Watermark property from the output of the current command as the value for the PageCookie parameter in a new command with the same date range and filters. The PageCookie value is valid for 120 seconds to fetch the next set of records for same query. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 100. Consider using a smaller PageSize value to avoid PageCookie expiry when exporting large datasets. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES +- The date-time field exported via this cmdlet is in UTC timezone. + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md b/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md index fe3010d012..01b6148ebe 100644 --- a/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md +++ b/exchange/exchange-ps/exchange/Export-AutoDiscoverConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-autodiscoverconfig +online version: https://learn.microsoft.com/powershell/module/exchange/export-autodiscoverconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Export-AutoDiscoverConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Export-AutoDiscoverConfig cmdlet to create or update a service connection point for an Autodiscover service pointer in a target Exchange forest. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` @@ -35,7 +35,7 @@ Export-AutoDiscoverConfig -TargetForestDomainController ## DESCRIPTION The Autodiscover Service Connection Point pointer resides Active Directory in the user account forest and includes the LDAP URL of the resource forest that the client will use to locate the Autodiscover service in the resource forest. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -125,7 +125,10 @@ Accept wildcard characters: False ``` ### -MultipleExchangeDeployments -The MultipleExchangeDeployments parameter specifies whether multiple Exchange deployments exist. This setting should be set to $true only if Exchange 2016 is deployed in more than one Active Directory forest, and the forests are connected. If set to $true, the list of authoritative accepted domains for the source forest is written to the Autodiscover service connection point object. Outlook 2010 clients use this object to select the most appropriate forest to search for the Autodiscover service. +The MultipleExchangeDeployments parameter specifies whether multiple Exchange deployments exist. Valid values are: + +- $true: Exchange is deployed in more than one Active Directory forest, and the forests are connected. The list of authoritative accepted domains for the source forest is written to the Autodiscover service connection point object. Outlook clients use this object to select the most appropriate forest to search for the Autodiscover service. +- $False: Multiple Exchange deployments aren't used. This is the default value. ```yaml Type: Boolean @@ -159,7 +162,7 @@ Accept wildcard characters: False ### -SourceForestCredential The SourceForestCredential parameter specifies the credentials to use when connecting to the source forest. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -177,7 +180,7 @@ Accept wildcard characters: False ### -TargetForestCredential The TargetForestCredential parameter specifies the credentials to use to connect to the target forest. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -213,12 +216,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-ContentExplorerData.md b/exchange/exchange-ps/exchange/Export-ContentExplorerData.md new file mode 100644 index 0000000000..85f8802e21 --- /dev/null +++ b/exchange/exchange-ps/exchange/Export-ContentExplorerData.md @@ -0,0 +1,242 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/export-contentexplorerdata +applicable: Security & Compliance +title: Export-ContentExplorerData +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Export-ContentExplorerData + +## SYNOPSIS +**Note**: This cmdlet is currently in Preview and is subject to change. + +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Export-ContentExplorerData cmdlet to export data classification file details in Microsoft Purview compliance. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Export-ContentExplorerData [-TagName] [-TagType] + [-Aggregate] + [[-PageCookie] ] + [[-PageSize] ] + [[-SiteUrl] ] + [[-UserPrincipalName] ] + [[-Workload] ] + [] +``` + +## DESCRIPTION +The output of this cmdlet contains the following information: + +- TotalCount: Aggregate count. If only the TagName and TagType parameters are used, the value is the total aggregate count for that tag. If the Workload parameter is also used, the value is the aggregate count in the workload for that tag. If the UserPrincipalName or SiteUrl parameters are used, the value is the count for that specific folder. +- MorePagesAvailable: Shows whether there are more records left to export. The value is True or False. +- RecordsReturned: The number of records returned in the query. +- PageCookie: Used to get the next set of records when MorePagesAvailable is True. + +The following list describes best practices for scripts using this cmdlet: + +- We recommend not using a single script to export multiple SITs/Labels. Instead, create a script for one SIT/Label, and then re-use the same script for each SIT/Label in each workload as required. +- When retrying the script, make sure to reconnect to the session first. The session's token expires after about an hour, which can cause the cmdlet to fail. To fix this issue, reconnect to the session before retrying the script. If the script fails, restart it using the last page cookie returned to continue the export from where it left off. + + > [!TIP] + > To support unattended scripts that run for a long time, you can use [certificate-based authentication (CBA)](https://learn.microsoft.com/powershell/exchange/app-only-auth-powershell-v2). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Export-ContentExplorerData -TagType SensitiveInformationType -TagName "Credit Card Number" -Workload EXO -UserPrincipalName erika@contoso.onmicrosoft.com +``` + +This example exports records for the specified sensitive info type from Erika's mailbox. + +### Example 2 +```powershell +Export-ContentExplorerData -TagType SensitiveInformationType -TagName "Credit Card Number" -Workload ODB -SiteUrl https://contoso-my.sharepoint.com/personal/erika_contoso_onmicrosoft_com +``` + +This example exports records for the specified sensitive info type in Erika's OneDrive site. + +### Example 3 +```powershell +Export-ContentExplorerData -TagType SensitiveInformationType -TagName "All Full Names" +``` + +This example exports records for the specified sensitive info type for all workloads. + +## PARAMETERS + +### -TagType +The TagType parameter specifies the type of label to export file details from. Valid values are: + +- Retention +- SensitiveInformationType +- Sensitivity +- TrainableClassifier + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Aggregate +**Note:** This parameter is currently in Private Preview, isn't available in all organizations, and is subject to change. + +The Aggregate parameter switch returns the folder level aggregated numbers instead of returning details at the item level. You don't need to specify a value with this switch. + +Using this switch significantly reduces the export time. To download the items in a folder, run this cmdlet for specific folders. + +When you use this switch with the TagName, TagType, and Workload parameters, the command returns the following information: + +- SharePoint and OneDrive: The list of SiteUlrs. +- Exchange Online and Microsoft Teams: The list of UPNs. +- The count of items in the folders stamped with relevant tag. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageCookie +The PageCookie parameter specifies whether to get more data when the value of the MorePagesAvailable property in the command output is True. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 10000 records can be returned. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of records to return in a single query. Valid input for this parameter is an integer between 1 and 10000. The default value is 100. + +**Note**: In empty folders or folders with few files, this parameter can cause the command to run for a long time as it tries to get the PageSize count of the results. To prevent this issue, the command returns data from 5 folders or the number of records specified by the PageSize parameter, whichever completes first. For example, if there are 10 folders with 1 record each, the command returns 5 records of the top 5 folders. In the next execution using page cookie, it returns 5 records from the remaining 5 folders, even if the PageSize value is 10. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteUrl +The SiteUrl parameter specifies the site URL to export file details from. + +You use this parameter for SharePoint and OneDrive workloads. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TagName +The TagName parameter specifies the name of the label to export file details from. If the value contains spaces, enclose the value in quotation marks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserPrincipalName +The UserPrincipalName parameter specifies the user account in UPN format to export message details from. An example UPN value is erika@contoso.onmicrosoft.com. + +You use this parameter for Exchange and Microsoft Teams workloads. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload +The Workload parameter specifies the location to export file details from. Valid values are: + +- EXO or Exchange +- ODB or OneDrive +- SPO or SharePoint +- Teams + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 7 +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md index 0d60f7aa65..0c2de21c86 100644 --- a/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md +++ b/exchange/exchange-ps/exchange/Export-DlpPolicyCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-dlppolicycollection +online version: https://learn.microsoft.com/powershell/module/exchange/export-dlppolicycollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Export-DlpPolicyCollection schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Export-DlpPolicyCollection ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: This cmdlet has been retired from the cloud-based service. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/exchange-online-etrs-to-stop-supporting-dlp-policies/ba-p/3886713). -Use the Export-DlpPolicyCollection cmdlet to export data loss prevention (DLP) policy collections from your organization to a file. +This cmdlet is functional only in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the Export-DlpPolicyCollection cmdlet to export data loss prevention (DLP) policy collections that are based on transport rules (mail flow rules) from your organization to a file. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,14 +33,15 @@ Export-DlpPolicyCollection [[-Identity] ] ## DESCRIPTION The Export-DlpPolicyCollection cmdlet exports the settings of the DLP policies and the associated transport rules. You use the Import-DlpPolicyCollection to import the DLP policy collection into your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -$file = Export-DlpPolicyCollection -Set-Content -Path "C:\My Documents\Contoso PII.xml" -Value $file.FileData -Encoding Byte +$DlpPol = Export-DlpPolicyCollection + +[System.IO.File]::WriteAllBytes('C:\My Documents\Contoso PII.xml', $DlpPol.FileData) ``` This example exports all the elements of the existing DLP policies to the file C:\\My Documents\\Contoso PII.xml. @@ -81,8 +84,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -119,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md index 5abecdd4f9..ec431d5516 100644 --- a/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Export-ExchangeCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-exchangecertificate +online version: https://learn.microsoft.com/powershell/module/exchange/export-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Export-ExchangeCertificate schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Export-ExchangeCertificate cmdlet to export existing certificates and pending certificate requests (also known as certificate signing requests or CSRs) from Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -56,33 +56,54 @@ The Export-ExchangeCertificate cmdlet creates the following types of files: Typically, you export a certificate request file if you need to resubmit the certificate request to the certification authority. You can't import an exported certificate request on another server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Export-ExchangeCertificate -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e -FileName "C:\Data\HT cert.pfx" -BinaryEncoded -Password (ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force) +Export-ExchangeCertificate -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e -FileName "C:\Data\HT cert.pfx" -BinaryEncoded -Password (Get-Credential).password ``` -This example exports a certificate from the local Exchange server to a file with the following settings: +In **Exchange 2013**, this example exports a certificate from the local Exchange server to a file with the following settings: -The certificate that has the thumbprint value 5113ae0233a72fccb75b1d0198628675333d010e is exported to the file C:\\Data\\HT cert.pfx. +- The certificate to export has the thumbprint value 5113ae0233a72fccb75b1d0198628675333d010e. +- The exported certificate file is DER encoded (binary), not Base64. +- Enter the password when prompted. +- The certificate is exported to the file C:\\Data\\HT cert.pfx. -The exported certificate file is encoded by DER (not Base64). - -The password for the certificate file is P@ssw0rd1. +**Note**: The FileName parameter is available only in Exchange 2013. To export the certificate in Exchange 2016 or Exchange 2019, see Example 2. ### Example 2 ```powershell +$bincert = Export-ExchangeCertificate -Thumbprint 5113ae0233a72fccb75b1d0198628675333d010e -BinaryEncoded -Password (Get-Credential).password + +[System.IO.File]::WriteAllBytes('C:\Data\HT cert.pfx', $bincert.FileData) +``` + +This example exports the same certificate from Example 1. This method is required in Exchange 2016 and Exchange 2019 because the FileName parameter is not available. + +### Example 3 +```powershell Export-ExchangeCertificate -Thumbprint 72570529B260E556349F3403F5CF5819D19B3B58 -Server Mailbox01 -FileName "\\FileServer01\Data\Fabrikam.req" ``` -This example exports a pending certificate request to a file with the following settings: +In **Exchange 2013**, this example exports a pending certificate request to a file with the following settings: -The pending certificate request that has the thumbprint value 72570529B260E556349F3403F5CF5819D19B3B58 on the Exchange server named Mailbox01 is exported to the file \\\\FileServer01\\Data\\Fabrikam.req. +- The certificate request to export has the thumbprint value 72570529B260E556349F3403F5CF5819D19B3B58 and is located on the Exchange server named Mailbox01. +- The exported certificate request file is Base64 encoded, so the information that's written to the file is also displayed onscreen. +- The certificate request is exported to the file \\\\FileServer01\\Data\\Fabrikam.req. -The exported certificate request file is Base64 encoded, so the information that's written to the file is also displayed onscreen. +**Note**: The FileName parameter is available only in Exchange 2013. To export the pending certificate request in Exchange 2016 or Exchange 2019, see Example 4. + +### Example 4 +```powershell +$txtcert = Export-ExchangeCertificate -Thumbprint 72570529B260E556349F3403F5CF5819D19B3B58 -Server Mailbox01 + +[System.IO.File]::WriteAllBytes('\\FileServer01\Data\Fabrikam.req', [System.Text.Encoding]::Unicode.GetBytes($txtcert)) +``` + +This example exports the same pending certificate request from Example 3. This method is required in Exchange 2016 and Exchange 2019 because the FileName parameter is not available. ## PARAMETERS @@ -185,13 +206,17 @@ Accept wildcard characters: False ``` ### -FileName +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To export the certificate or certificate request to a file without using the FileName parameter, use the methods described in Example 2 and Example 4. + +This parameter is available only in Exchange 2013. + The FileName parameter specifies the name and path of the exported certificate or certificate request file. You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013 Required: False Position: Named @@ -203,7 +228,11 @@ Accept wildcard characters: False ### -Password The Password parameter specifies the password for the private key or chain of trust in the exported certificate file. To import the exported certificate file on another server, you need to know the password. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString @@ -264,12 +293,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-FilePlanProperty.md b/exchange/exchange-ps/exchange/Export-FilePlanProperty.md index 431e257c81..91b4a41f26 100644 --- a/exchange/exchange-ps/exchange/Export-FilePlanProperty.md +++ b/exchange/exchange-ps/exchange/Export-FilePlanProperty.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-fileplanproperty -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/export-fileplanproperty +applicable: Security & Compliance title: Export-FilePlanProperty schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Export-FilePlanProperty ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Export-FilePlanProperty cmdlet to export file plan properties. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -22,7 +22,7 @@ Export-FilePlanProperty [-Confirm] [-DomainController ] [-WhatIf] [] ## DESCRIPTION You can use the Export-JournalRuleCollection cmdlet to export journal rules in your organization to create a backup copy of your rules. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $file = Export-JournalRuleCollection -Set-Content -Path "C:\MyDocs\JournalRules.xml" -Value $file.FileData -Encoding Byte + +[System.IO.File]::WriteAllBytes('C:\MyDocs\JournalRules.xml', $file.FileData) ``` This example exports journal rules in a two-step process. In the first step, the Export-JournalRuleCollection cmdlet exports journal rules to the variable $file. In the second step, the Set-Content cmdlet saves the exported data to the XML file JournalRules.xml. @@ -47,10 +48,11 @@ This example exports journal rules in a two-step process. In the first step, the ### Example 2 ```powershell $file = Export-JournalRuleCollection -ExportLegacyRules -Set-Content -Path "C:\MyDocs\Ex2007-JournalRules.xml" -Value $file.FileData -Encoding Byte + +[System.IO.File]::WriteAllBytes('C:\MyDocs\LegacyJournalRules.xml', $file.FileData) ``` -In Exchange Server 2010, this example exports legacy journal rules to an XML file using the two-step process similar to the preceding example. In the first step, the Export-JournalRuleCollection cmdlet is used with the ExportLegacyRules switch to export legacy rules to the array $file. In the second step, the exported data is saved to the XML file Ex2007-JournallRules.xml. +In Exchange Server 2010, this example exports legacy journal rules that were created in Exchange 2007 to an XML file. The first command uses the ExportLegacyRules switch to export legacy journal rules to the variable named $file. The second step saves the exported data to the XML file named LegacyJournalRules.xml. ## PARAMETERS @@ -108,7 +110,7 @@ Accept wildcard characters: False ### -ExportLegacyRules This parameter is available only in Exchange Server 2010. -The ExportLegacyRules switch specifies whether to export Exchange 2007 journal rules. +The ExportLegacyRules switch specifies whether to export Exchange 2007 journal rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -144,12 +146,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md index 2957b6ba77..dada5fa300 100644 --- a/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md +++ b/exchange/exchange-ps/exchange/Export-MailboxDiagnosticLogs.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-mailboxdiagnosticlogs +online version: https://learn.microsoft.com/powershell/module/exchange/export-mailboxdiagnosticlogs applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Export-MailboxDiagnosticLogs schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Export-MailboxDiagnosticLogs cmdlet to export diagnostic data from user and system mailboxes in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -50,7 +50,7 @@ Export-MailboxDiagnosticLogs [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -100,9 +100,11 @@ Accept wildcard characters: False ### -ComponentName The ComponentName parameter specifies the component that you want to retrieve the diagnostic logs for. Valid values depend on the type and location of the mailbox (on-premises Exchange or Exchange Online). Valid values include: +- AcceptCalendarSharingInvite - ActionProcessingAgent - BirthdayAssistant - CalendarPermissions +- CalendarSharingInvite - CalendarSharingLocalFolder - DefaultViewIndexer - FreeBusyPublishingAssistantQuickLog @@ -112,7 +114,9 @@ The ComponentName parameter specifies the component that you want to retrieve th - MRM - OnlineMeetings - OOFRules +- RBA - RemindersAssistant +- Sharing - SharingMigrationAssistant - SharingSyncAssistant - SubstrateHoldTracking @@ -190,7 +194,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -246,7 +250,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -300,12 +306,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-Message.md b/exchange/exchange-ps/exchange/Export-Message.md index 80c9debd5c..28b6f435c6 100644 --- a/exchange/exchange-ps/exchange/Export-Message.md +++ b/exchange/exchange-ps/exchange/Export-Message.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-message +online version: https://learn.microsoft.com/powershell/module/exchange/export-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Export-Message schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Export-Message cmdlet to copy a message from a queue on a Mailbox server or an Edge Transport server to a specified file path in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Export-Message [-Identity] ## DESCRIPTION The Export-Message cmdlet copies messages from the Delivery queue, the Unreachable queue, or the poison message queue on Mailbox server or an Edge Transport server to a specified file path. Before you export a message, you must first suspend the message. Messages in the poison message queue are already suspended. You can use the Export-Message cmdlet to copy messages to the Replay directory of another Mailbox server for delivery. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,9 +44,13 @@ This example exports a single message to the specified file path. Because the Ex ### Example 2 ```powershell Get-Message -Queue "Server1\contoso.com" -ResultSize Unlimited | ForEach-Object {Suspend-Message $_.Identity -Confirm:$False + $Temp="C:\ExportFolder\"+$_.InternetMessageID+".eml" + $Temp=$Temp.Replace("<","_") + $Temp=$Temp.Replace(">","_") + Export-Message $_.Identity | AssembleMessage -Path $Temp} ``` @@ -59,7 +63,7 @@ This example retrieves all messages from the specified queue. The query results ## PARAMETERS ### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity @@ -114,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-MigrationReport.md b/exchange/exchange-ps/exchange/Export-MigrationReport.md index e124e99989..4610a82482 100644 --- a/exchange/exchange-ps/exchange/Export-MigrationReport.md +++ b/exchange/exchange-ps/exchange/Export-MigrationReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-migrationreport +online version: https://learn.microsoft.com/powershell/module/exchange/export-migrationreport applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Export-MigrationReport schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. The Export-MigrationReport is used by the Exchange migration process to enable an administrator to download a CSV file that contains migration errors for a selected migration batch. This cmdlet isn't run by an administrator in Windows PowerShell. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ Export-MigrationReport [-Identity] -RowCount [-Identity ] + [-CompressOutput] + [-EntityType ] + [-ForceConversionToMime] + [-Password ] + [-PasswordV2 ] + [-ReasonForExport ] + [-RecipientAddress ] [] ``` ### IdentityOnly ``` Export-QuarantineMessage -Identity + [-CompressOutput] + [-EntityType ] + [-ForceConversionToMime] + [-Password ] + [-PasswordV2 ] + [-ReasonForExport ] + [-RecipientAddress ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -$e = Export-QuarantineMessage -Identity c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7 -$e.BodyEncoding -$e | select -ExpandProperty Eml | Out-File "C:\My Documents\Export1_ascii.eml" -Encoding ascii -``` +$e = Export-QuarantineMessage -Identity b28e0706-e50e-4c33-17e8-08daf2898d15\e939baaf-9dac-6126-2137-b82abf373159 -This example exports the quarantined message with the specified Identity value. +$txt = [System.Text.Encoding]::Ascii.GetString([System.Convert]::FromBase64String($e.eml)) -The first two commands determine the message encoding (the value of the BodyEncoding property in the output; for example, ascii). +[IO.File]::WriteAllText("C:\My Documents\Quarantined Message.eml", $txt) +``` -The third command exports the message to the specified file using the message encoding that you found in the previous commands. +This example exports the specified message that was quarantined as spam: -**Notes**: +- The first command exports the quarantined message to the variable `$e`. The message is stored in the Eml property (the `$e.eml` value) as Base64 (based on the `$e.BodyEncoding` value). +- The second command converts the Eml property from Base64 to ASCII text and stores the result in the variable `$txt`. +- The third command writes the quarantined message to the specified .eml file. -- The `| select -ExpandProperty Eml`" part of the command specifies the whole message, including attachments. -- You need to use the Out-File cmdlet to write the .eml message file with the required encoding. If you use the default PowerShell redirection operator ">" to write the output file, the default encoding is Unicode, which might not match the actual message encoding. +**Note**: Don't enclose the Identity value in quotation marks (you might get an error). ### Example 2 ```powershell -$e = Export-QuarantineMessage -Identity 9c6bb3e8-db9e-4823-9759-08d594179bd3\7fec89fe-41b0-ae67-4887-5bede017d111 -$bytes = [Convert]::FromBase64String($e.eml) -[IO.File]::WriteAllBytes("C:\My Documents\Export1.txt", $bytes) +$f = Export-QuarantineMessage -Identity 9c6bb3e8-db9e-4823-9759-08d594179bd3\7fec89fe-41b0-ae67-4887-5bede017d111 + +$bytes = [Convert]::FromBase64String($f.eml) + +[IO.File]::WriteAllBytes("C:\My Documents\Quarantined Message with Attachments.eml", $bytes) ``` -This example exports the quarantined file with the specified Identity value. The first command exports the file to a Base 64 string. The next two commands convert the string to byte format and write it to the output file. +This example exports the specified message with attachments that was quarantined as malware: + +- The first command exports the quarantined message and attachments to the variable `$f`. The message and attachments are stored in the Eml property (the `$f.eml` value) as Base64 (based on the `$f.BodyEncoding` value). +- The second command converts the Eml property from Base64 to bytes and stores the result in the variable `$bytes`. +- The third command writes the quarantined message and attachments to the specified .eml file. ## PARAMETERS ### -Identities -{{ Fill Identities Description }} +The Identities parameter identifies quarantined messages for bulk operations. You identify the messages by using the syntax: `value1,value2...valueN`. Each value is a unique quarantined message identifier in the format `GUID1\GUID2` (for example `c14401cf-aa9a-465b-cfd5-08d0f0ca37c5\4c2ca98e-94ea-db3a-7eb8-3b63657d4db7`). + +You can find the Identity value for a quarantined message by using the Get-QuarantineMessage cmdlet. + +When you use this parameter, the Identity parameter is required, but the value is ignored. For example, use the value 000 for the Identity parameter. ```yaml Type: QuarantineMessageIdentity[] Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -95,7 +116,7 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -108,7 +129,7 @@ Accept wildcard characters: False Type: QuarantineMessageIdentity Parameter Sets: IdentityOnly Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -117,17 +138,142 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -CompressOutput +The CompressOutput switch exports the message as a compressed .zip file. You don't need to specify a value with this switch. + +For exported messages, including messages with attachments, the .zip file contains a folder that's named after the first GUID value in the Identity. The folder contains the .eml message that's named after the second GUID value in the Identity. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceConversionToMime +The ForceConversionToMime switch converts exported plain text messages to MIME formatting. You don't need to specify a value with this switch. + +This switch has no effect if the message is already encoded as Base64. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The Password parameter specifies the password that's required to open the exported message. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +To enter the password in plain text, use the PasswordV2 parameter. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PasswordV2 +The PasswordV2 parameter specifies the plain text value of the password that's required to open the exported message. Enclose the value in quotation marks (for example, `''`). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReasonForExport +The ReasonForExport parameter specifies why the message was exported. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md index b2ed542e10..79ca27c8bb 100644 --- a/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md +++ b/exchange/exchange-ps/exchange/Export-RecipientDataProperty.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-recipientdataproperty +online version: https://learn.microsoft.com/powershell/module/exchange/export-recipientdataproperty applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Export-RecipientDataProperty schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Export-RecipientDataProperty cmdlet to download a user's picture or spoken name sound file. The picture and audio files display in the Global Address List property dialog box, contact card, reading pane, and meeting requests in Outlook. +Use the Export-RecipientDataProperty cmdlet to download the picture or spoken name audio file of a mailbox or mail contact. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,20 +41,24 @@ Export-RecipientDataProperty [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Export-RecipientDataProperty -Identity tony@contoso.com -SpokenName | ForEach { $_.FileData | Add-Content C:\tonysmith.wma -Encoding Byte} +$SN = Export-RecipientDataProperty -Identity tonys@contoso.com -SpokenName + +[System.IO.File]::WriteAllBytes('C:\tonysmith.wma', $SN.FileData) ``` This example exports Tony Smith's spoken name audio file and saves it to the local computer. ### Example 2 ```powershell -Export-RecipientDataProperty -Identity "Ayla" -Picture | ForEach { $_.FileData | Add-Content C:\aylakol.jpg -Encoding Byte} +$Pic = Export-RecipientDataProperty -Identity "Ayla Kol" -Picture + +[System.IO.File]::WriteAllBytes('C:\Data\aylakol.jpg', $Pic.FileData) ``` This example exports Ayla Kol's picture file to the local computer. @@ -120,9 +124,11 @@ Accept wildcard characters: False ``` ### -Picture -The Picture switch specifies that the file you're exporting is the user's picture file. You don't need to specify a value with this switch. +The Picture switch specifies that you're exporting the user's picture. You don't need to specify a value with this switch. -You can't use this switch with the SpokenName switch. You can only export one file type at a time. +The user's picture is exported as a JPEG file. + +You can't use this switch with the SpokenName switch. ```yaml Type: SwitchParameter @@ -138,9 +144,11 @@ Accept wildcard characters: False ``` ### -SpokenName -The SpokenName switch specifies that the file you're exporting is the user's audio file. You don't need to specify a value with this switch. +The SpokenName switch specifies that you're exporting the user's spoken name. You don't need to specify a value with this switch. + +The user's spoken name is exported as a WMA 9 file. -This cmdlet exports the WMA 9-voice format. You can't use this switch with the Picture switch. You can only export one file type at a time. +You can't use this switch with the Picture switch. ```yaml Type: SwitchParameter @@ -176,12 +184,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md index e7e48ed142..1996ade66b 100644 --- a/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md +++ b/exchange/exchange-ps/exchange/Export-TransportRuleCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-transportrulecollection +online version: https://learn.microsoft.com/powershell/module/exchange/export-transportrulecollection applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Export-TransportRuleCollection schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Export-TransportRuleCollection cmdlet to export the transport rules in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,34 +33,38 @@ Export-TransportRuleCollection [[-Identity] ] ## DESCRIPTION The Export-TransportRuleCollection cmdlet can be used to export the transport rule collection in your organization. The format of the exported transport rule collection changed in Exchange Server 2013. The new format can't be imported into Exchange Server 2010. -Exporting the rules collection is a two-step process. You first export the rules collection to a variable, and then use the Set-Content cmdlet to write the data to an XML file. For more information, see [Set-Content](https://docs.microsoft.com/powershell/module/microsoft.powershell.management/set-content). +Exporting the rules collection is a two-step process. You first export the rules collection to a variable, and then use the Set-Content cmdlet to write the data to an XML file. For more information, see [Set-Content](https://learn.microsoft.com/powershell/module/microsoft.powershell.management/set-content). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $file = Export-TransportRuleCollection -Set-Content -Path "C:\My Docs\Rules.xml" -Value $file.FileData -Encoding Byte + +[System.IO.File]::WriteAllBytes('C:\My Docs\Rules.xml', $file.FileData) ``` This example exports transport rules. Rule data is first exported to the variable $file, and then written to the XML file Rules.xml in the C:\\My Docs folder. -**Note**: In PowerShell 6.0 or later, replace `-Encoding Byte` with `-AsByteStream`. - ### Example 2 ```powershell $file = Export-TransportRuleCollection -ExportLegacyRules -Set-Content -Path "C:\MyDocs\LegacyRules.xml" -Value $file.FileData -Encoding Byte + +[System.IO.File]::WriteAllBytes('C:\My Docs\LegacyRules.xml', $file.FileData) ``` -In Exchange Server 2010, this example exports legacy transport rules created in Exchange 2007 using the ExportLegacyRules switch. The cmdlet should be run from an Exchange 2010 Hub Transport server. The exported rules collection can then be imported to Exchange 2010 using the Import-TransportRuleCollection cmdlet. +In Exchange Server 2010, this example exports legacy transport rules that were created in Exchange 2007 to an XML file. The first command uses the ExportLegacyRules switch to export legacy transport rules to the variable named $file. The second step saves the exported data to the XML file named LegacyRules.xml. + +You can import the exported rules collection to Exchange 2010 using the Import-TransportRuleCollection cmdlet. + +You need to run these commands in this example on an Exchange 2010 Hub Transport server. ## PARAMETERS ### -Identity -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The Identity parameter specifies the transport rule that you want to export. You can use any value that uniquely identifies the rule. For example: @@ -181,12 +185,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md b/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md index 8796ce6138..29e7f3790d 100644 --- a/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md +++ b/exchange/exchange-ps/exchange/Export-UMCallDataRecord.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-umcalldatarecord +online version: https://learn.microsoft.com/powershell/module/exchange/export-umcalldatarecord applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Export-UMCallDataRecord schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Export-UMCallDataRecord cmdlet to export Unified Messaging (UM) call data records for UM dial plans and UM IP gateways for a date that you've specified. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,11 +33,9 @@ Export-UMCallDataRecord -ClientStream -Date ## DESCRIPTION The Export-UMCallDataRecord cmdlet exports Unified Messaging call data records for a specified date to a comma-separated value (CSV) file. You can filter call data records for specific UM dial plans or UM IP gateways. However, if you don't specify a UM IP gateway, all call data records are returned. -The Export-UMCallDataRecord cmdlet is available when you're using the Exchange Administration Center. You can't use the cmdlet from the Exchange Management Shell. - After this task is completed, a report is generated that contains Unified Messaging call data records. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -177,12 +175,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Export-UMPrompt.md b/exchange/exchange-ps/exchange/Export-UMPrompt.md index c807da2608..02e8841d44 100644 --- a/exchange/exchange-ps/exchange/Export-UMPrompt.md +++ b/exchange/exchange-ps/exchange/Export-UMPrompt.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/export-umprompt +online version: https://learn.microsoft.com/powershell/module/exchange/export-umprompt applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Export-UMPrompt schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Export-UMPrompt cmdlet to export an audio file being used as a greeting prompt for Unified Messaging (UM) dial plans and auto attendants. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,14 +43,15 @@ The Export-UMPrompt cmdlet exports prompts that belong to existing UM dial plan After this task is completed, the UM prompts are displayed or saved. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $prompt = Export-UMPrompt -PromptFileName "customgreeting.mp3" -UMDialPlan MyUMDialPlan -Set-Content -Path "d:\DialPlanPrompts\welcomegreeting.mp3" -Value $prompt.AudioData -Encoding Byte + +[System.IO.File]::WriteAllBytes('D:\DialPlanPrompts\welcomegreeting.mp3', $prompt.AudioData) ``` This example exports the welcome greeting for the UM dial plan MyUMDialPlan and saves it as the file welcomegreeting.mp3. @@ -58,7 +59,8 @@ This example exports the welcome greeting for the UM dial plan MyUMDialPlan and ### Example 2 ```powershell $prompt = Export-UMPrompt -PromptFileName "welcomegreeting.mp3" -UMAutoAttendant MyUMAutoAttendant -Set-Content -Path "e:\UMPromptsBackup\welcomegreetingbackup.mp3" -Value $prompt.AudioData -Encoding Byte + +[System.IO.File]::WriteAllBytes('E:\UMPromptsBackup\welcomegreetingbackup.mp3', $prompt.AudioData) ``` This example exports a custom greeting for the UM auto attendant MyUMAutoAttendant and saves it to the file welcomegreetingbackup.mp3. @@ -169,12 +171,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ADPermission.md b/exchange/exchange-ps/exchange/Get-ADPermission.md index e8818bfbb2..773f0467b4 100644 --- a/exchange/exchange-ps/exchange/Get-ADPermission.md +++ b/exchange/exchange-ps/exchange/Get-ADPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-adpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-adpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ADPermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ADPermission cmdlet to get permissions on an Active Directory object. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,9 +37,9 @@ Get-ADPermission [-Identity] ``` ## DESCRIPTION -The ADPermission cmdlets can be used to directly modify Active Directory access control lists (ACLs). Although some Microsoft Exchange features may continue to use the ADPermission cmdlets to manage permissions (for example Send and Receive connectors) Exchange 2013 and later versions no longer use customized ACLs to manage administrative permissions. If you want to grant or deny administrative permissions in Exchange 2013 or later, you need to use Role Based Access Control (RBAC). For more information about RBAC, see [Permissions in Exchange Server](https://docs.microsoft.com/Exchange/permissions/permissions). +The ADPermission cmdlets can be used to directly modify Active Directory access control lists (ACLs). Although some Microsoft Exchange features may continue to use the ADPermission cmdlets to manage permissions (for example Send and Receive connectors), Exchange 2013 and later versions no longer use customized ACLs to manage administrative permissions. If you want to grant or deny administrative permissions in Exchange 2013 or later, you need to use Role Based Access Control (RBAC). For more information about RBAC, see [Permissions in Exchange Server](https://learn.microsoft.com/Exchange/permissions/permissions). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,7 +118,12 @@ The user parameter filters the results who has permissions on the Active Directo - Mail users - Security groups -You can use any value that uniquely identifies the user or group. For example: +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: - Name - Alias @@ -151,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ADServerSettings.md b/exchange/exchange-ps/exchange/Get-ADServerSettings.md index 6fd7871e07..e44f8bd977 100644 --- a/exchange/exchange-ps/exchange/Get-ADServerSettings.md +++ b/exchange/exchange-ps/exchange/Get-ADServerSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-adserversettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-adserversettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ADServerSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-AdServerSettings cmdlet to view the Active Directory Domain Services (AD DS) environment settings in the current Exchange Management Shell session. The Get-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ Get-AdServerSettings [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -36,7 +36,7 @@ Get-AdServerSettings | Format-List This example displays the session settings for the current session. -For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ## PARAMETERS @@ -45,12 +45,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ADSite.md b/exchange/exchange-ps/exchange/Get-ADSite.md index 3c8b2938ff..507afd4a61 100644 --- a/exchange/exchange-ps/exchange/Get-ADSite.md +++ b/exchange/exchange-ps/exchange/Get-ADSite.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-adsite +online version: https://learn.microsoft.com/powershell/module/exchange/get-adsite applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ADSite schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-AdSite cmdlet to display configuration information about one or more Active Directory sites. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-AdSite [[-Identity] ] ## DESCRIPTION Exchange uses Active Directory sites and the costs assigned to the Active Directory site links to make message routing decisions. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,12 +81,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md new file mode 100644 index 0000000000..714d4981eb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ATPBuiltInProtectionRule.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule +applicable: Exchange Online +title: Get-ATPBuiltInProtectionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ATPBuiltInProtectionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ATPBuiltInProtectionRule cmdlet to view the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ATPBuiltInProtectionRule [[-Identity] ] [-State ] [] +``` + +## DESCRIPTION +For more information about preset security policies, see [Preset security policies in EOP and Microsoft Defender for Office 365](https://learn.microsoft.com/defender-office-365/preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ATPBuiltInProtectionRule +``` + +This example shows the rule for the Built-in protection preset security policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +The name of the only rule is ATP Built-In Protection Rule. + +```yaml +Type: DehydrateableRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the state of the rule. Valid values are: + +- Disabled +- Enabled + +The only rule is always enabled. + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..f0a24d140f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md @@ -0,0 +1,103 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-atpprotectionpolicyrule +applicable: Exchange Online +title: Get-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ATPProtectionPolicyRule cmdlet to view rules for Microsoft Defender for Office 365 protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ATPProtectionPolicyRule [[-Identity] ] + [-State ] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ATPProtectionPolicyRule | Format-Table Name,State +``` + +This example returns a summary list of the rules for Defender for Office 365 protections in preset security policies. + +### Example 2 +```powershell +Get-ATPProtectionPolicyRule -Identity "Strict Preset Security Policy" +``` + +This example returns detailed information about the rule named Strict Preset Security Policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the state of the rule. Valid values are: + +- Enabled +- Disabled + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md index 3e0216bc60..754759eea3 100644 --- a/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md +++ b/exchange/exchange-ps/exchange/Get-ATPTotalTrafficReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-atptotaltrafficreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-atptotaltrafficreport applicable: Exchange Online, Exchange Online Protection title: Get-ATPTotalTrafficReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-ATPTotalTrafficReport to view details about message traffic in your Microsoft Defender for Office 365 organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,9 +36,9 @@ Get-ATPTotalTrafficReport ``` ## DESCRIPTION -For the reporting period and organization you specify, the cmdlet returns the following information: +For the reporting period you specify, the cmdlet returns the following information: -- EventType +- EventType: TotalBulkCount, TotalMalwareCount, TotalMissedSafeAttachmentCount, TotalMissedSafeLinkCount, TotalPhishCount, TotalSafeAttachmentCount, TotalSafeLinkCount, TotalSpamCount - Organization - Date - MessageCount @@ -49,9 +47,15 @@ For the reporting period and organization you specify, the cmdlet returns the fo - AggregateBy - Index +TotalMissedSafeAttachmentCount is when the recipient or tenant is not included in a Safe Attachments policy, but a message with a detected attachment was removed by zero-hour auto purge (ZAP) after delivery. + +TotalMissedSafeLinkCount is when the recipient or tenant is not included in a Safe Links policy, but a message with a detected URL was removed by ZAP after delivery. + +If the tenant had Safe Attachments or Safe Links policies, the messages would have been blocked and not delivered. + By default, the command returns data for the last 14 days. Data for the last 90 days is available. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,7 +103,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -133,7 +142,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: System.DateTime @@ -199,7 +208,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: System.DateTime @@ -217,7 +226,14 @@ Accept wildcard characters: False ### -SummarizeBy The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. -For this cmdlet, the SummarizedBy parameter accepts the value EventType. +For this cmdlet, valid values are: + +- Action +- Direction +- Domain +- EventType + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -237,12 +253,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md b/exchange/exchange-ps/exchange/Get-AcceptedDomain.md index ecf51fe133..7a46a55884 100644 --- a/exchange/exchange-ps/exchange/Get-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Get-AcceptedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-accepteddomain +online version: https://learn.microsoft.com/powershell/module/exchange/get-accepteddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-AcceptedDomain schema: 2.0.0 @@ -16,18 +16,19 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-AcceptedDomain cmdlet to view the configuration information for the accepted domains in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-AcceptedDomain [[-Identity] ] [-DomainController ] + [-ResultSize ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,17 +84,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md index f4fe729375..c42017f450 100644 --- a/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/exchange/Get-AccessToCustomerDataRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-accesstocustomerdatarequest -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-accesstocustomerdatarequest +applicable: Exchange Online, Exchange Online Protection title: Get-AccessToCustomerDataRequest schema: 2.0.0 author: chrisda @@ -14,13 +14,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-AccessToCustomerDataRequest cmdlet to view Microsoft 365 customer lockbox requests that control access to your data by Microsoft support engineers. +Use the Get-AccessToCustomerDataRequest cmdlet to view Microsoft 365 Customer Lockbox requests that control access to your data by Microsoft support engineers. -**Note**: Customer lockbox is included in the Microsoft 365 E5 plan. If you don't have a Microsoft 365 E5 plan, you can buy a separate customer lockbox subscription with any Microsoft 365 Enterprise plan. +**Note**: Customer Lockbox is included in Microsoft 365 E5, or you can buy a separate Customer Lockbox subscription with any Microsoft 365 Enterprise plan. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Get-AccessToCustomerDataRequest [-ApprovalStatus ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,21 +39,21 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-AccessToCustomerDataRequest ``` -This example returns a summary list of all customer lockbox request. +This example returns a summary list of all Customer Lockbox request. ### Example 2 ```powershell Get-AccessToCustomerDataRequest -ApprovalStatus Pending ``` -This example returns a summary list of all customer lockbox requests that have the status value Pending. +This example returns a summary list of all Customer Lockbox requests that have the status value Pending. ### Example 3 ```powershell Get-AccessToCustomerDataRequest -RequestId EXSR123456 | Format-List ``` -This example returns detailed information the customer lockbox request EXSR123456. +This example returns detailed information the Customer Lockbox request EXSR123456. ## PARAMETERS @@ -71,7 +69,7 @@ The ApprovalStatus parameter filters the results by approval status. Valid value Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -86,13 +84,13 @@ The CreatedAfter parameter filters the results by the creation date in Coordinat To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -108,7 +106,7 @@ The RequestId parameter filters the results by reference number (for example, EX Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -122,12 +120,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md index f681a66f14..76afb95c32 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-activesyncdevice +online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdevice applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-ActiveSyncDevice schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Get-ActiveSyncDevice cmdlet to retrieve the list of devices in your orga **Note**: In Exchange 2013 or later, use the Get-MobileDevice cmdlet instead. If you have scripts that use Get-ActiveSyncDevice, update them to use Get-MobileDevice. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,7 +49,7 @@ Get-ActiveSyncDevice [[-Identity] ] ## DESCRIPTION The Get-ActiveSyncDevice cmdlet returns identification, configuration and status information for each device. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -142,16 +142,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can filter by the following properties: @@ -285,12 +285,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md index 323273a5b6..d3a5a05c35 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-activesyncdeviceaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdeviceaccessrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-ActiveSyncDeviceAccessRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ActiveSyncDeviceAccessRule cmdlet to retrieve an access group of Exchange mobile devices along with their access level. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-ActiveSyncDeviceAccessRule [[-Identity] ] ## DESCRIPTION You can use this cmdlet to view a list of mobile phones or devices by type. For example, you can return a list of all Android mobile digital devices in the organization or all Windows Phone devices in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,16 +90,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can filter by the following properties: @@ -149,12 +149,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md index e28d37d784..df60827dd4 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncDeviceStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-activesyncdevicestatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncdevicestatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-ActiveSyncDeviceStatistics schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ActiveSyncDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. -**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange Server or Exchange Online, use the Get-MobileDeviceStatistics cmdlet instead. If you have scripts that use Get-ActiveSyncDeviceStatistics, update them to use Get-MobileDeviceStatistics. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange or Exchange Online, use the Get-MobileDeviceStatistics cmdlet instead. If you have scripts that use Get-ActiveSyncDeviceStatistics, update them to use Get-MobileDeviceStatistics. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ Get-ActiveSyncDeviceStatistics -Mailbox ## DESCRIPTION The Get-ActiveSyncDeviceStatistics cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,16 +59,17 @@ This example retrieves the statistics for the mobile phone configured to synchro ### Example 2 ```powershell $UserList = Get-CASMailbox -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'" + Get-Mailbox $UserList | foreach {Get-ActiveSyncDeviceStatistics -Mailbox $_} ``` This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. -**Note**: For more information about OPath filter syntax, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +**Note**: For more information about OPATH filter syntax, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ### Example 3 ```powershell -Get-ActiveSyncDeviceStatistics -Mailbox TonySmith -GetMailboxLog $true -NotificationEmailAddresses "admin@contoso.com" +Get-ActiveSyncDeviceStatistics -Mailbox TonySmith -GetMailboxLog -NotificationEmailAddresses "admin@contoso.com" ``` This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. It also outputs the Exchange ActiveSync log file and sends it to the System Administrator at admin@contoso.com. @@ -137,7 +138,7 @@ Accept wildcard characters: False ``` ### -GetMailboxLog -The GetMailboxLog parameter specifies whether to send the mailbox logs via email to the administrator running the task. If the parameter is set to $true, the command sends the mailbox logs via email to the administrator running the task. The default value of this parameter is $false. +The GetMailboxLog switch specifies whether to send the mobile device statistics to the email addresses that are specified by the NotificationEmailAddresses parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -153,7 +154,9 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses -The NotificationEmailAddresses parameter specifies an optional list of comma-separated aliases or email addresses where the mailbox logs are sent. If the GetMailboxLog parameter is set to $false, this parameter is ignored. +The NotificationEmailAddresses parameter specifies a comma-separated list of email addresses to receive the mobile device statistics when you use the GetMailboxLog switch. + +This parameter is meaningful only if you also use the GetMailboxLog switch in the same command. ```yaml Type: MultiValuedProperty @@ -189,12 +192,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md index b3b6c55a67..c43f7a04a7 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-activesyncmailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncmailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-ActiveSyncMailboxPolicy schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Get-ActiveSyncMailboxPolicy cmdlet to retrieve the Mobile Device mailbox **Note**: In Exchange 2013 or later, use the Get-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Get-ActiveSyncMailboxPolicy, update them to use Get-MobileDeviceMailboxPolicy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Get-ActiveSyncMailboxPolicy [[-Identity] ] ## DESCRIPTION A Mobile Device mailbox policy is a group of settings that specifies how mobile devices enabled for Microsoft Exchange ActiveSync connect to the computer running Exchange. Exchange supports multiple Mobile Device mailbox policies. The Get-ActiveSyncMailboxPolicy cmdlet displays all the policy settings for the specified policy. These settings include password settings, file access settings and attachment settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,12 +97,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md b/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md index f81285891e..554ac124b7 100644 --- a/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md +++ b/exchange/exchange-ps/exchange/Get-ActiveSyncOrganizationSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-activesyncorganizationsettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-activesyncorganizationsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-ActiveSyncOrganizationSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ActiveSyncOrganizationSettings cmdlet to view the Microsoft Exchange ActiveSync settings for your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-ActiveSyncOrganizationSettings [[-Identity] ] ## DESCRIPTION Microsoft Exchange servers have a default virtual directory that Exchange ActiveSync mobile devices use to synchronize with the server. You can create multiple virtual directories and assign different devices to different directories. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,7 +116,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -172,12 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ActivityAlert.md b/exchange/exchange-ps/exchange/Get-ActivityAlert.md deleted file mode 100644 index 9e14c9327c..0000000000 --- a/exchange/exchange-ps/exchange/Get-ActivityAlert.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-activityalert -applicable: Security & Compliance Center -title: Get-ActivityAlert -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-ActivityAlert - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Get-ActivityAlert cmdlet to view activity alerts in the Microsoft 365 Defender portal or the Microsoft 365 compliance center. Activity alerts send you email notifications when users perform specific activities in Microsoft 365. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-ActivityAlert [[-Identity] ] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-ActivityAlert | Format-List Disabled,Name,Description,Operation,UserId,NotifyUser -``` - -This example returns a summary list of all activity alerts. - -### Example 2 -```powershell -Get-ActivityAlert -Identity "All Mailbox Activities" -``` - -This example returns detailed information about the activity alert named All Mailbox Activities. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the activity alert that you want to view. You can use any value that uniquely identifies the activity alert. For example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AdSiteLink.md b/exchange/exchange-ps/exchange/Get-AdSiteLink.md index 86517dcbc1..11565da45f 100644 --- a/exchange/exchange-ps/exchange/Get-AdSiteLink.md +++ b/exchange/exchange-ps/exchange/Get-AdSiteLink.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-adsitelink +online version: https://learn.microsoft.com/powershell/module/exchange/get-adsitelink applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-AdSiteLink schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-AdSiteLink cmdlet to view configuration information about an Active Directory IP site link. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-AdSiteLink [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,12 +86,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AdaptiveScope.md b/exchange/exchange-ps/exchange/Get-AdaptiveScope.md new file mode 100644 index 0000000000..1444986464 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AdaptiveScope.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-adaptivescope +applicable: Exchange Online, Security & Compliance +title: Get-AdaptiveScope +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AdaptiveScope + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-AdaptiveScope cmdlet to view adaptive scopes in your organization. Adaptive scopes (or static scopes) are used in retention policies and retention label policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AdaptiveScope [[-Identity] ] + [-AdministrativeUnits ] + [-LocationTypes ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AdaptiveScope | Format-Table Name,Priority +``` + +This example returns a summary list of all adaptive scopes. +### Example 2 +```powershell +Get-AdaptiveScope -Identity "Project X" +``` + +This example returns detailed information about the adaptive scope named Project X. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the adaptive scope that you want to view. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AdministrativeUnits +{{ Fill AdministrativeUnits Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationTypes +{{ Fill LocationTypes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md index 153ce46444..83e1de7f90 100644 --- a/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AddressBookPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-addressbookpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-addressbookpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-AddressBookPolicy schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-AddressBookPolicy cmdlet to return address book policies that match the specified conditions. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-AddressBookPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,12 +95,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AddressList.md b/exchange/exchange-ps/exchange/Get-AddressList.md index 1856f28533..cf62cd285e 100644 --- a/exchange/exchange-ps/exchange/Get-AddressList.md +++ b/exchange/exchange-ps/exchange/Get-AddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-addresslist +online version: https://learn.microsoft.com/powershell/module/exchange/get-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-AddressList schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-AddressList cmdlet to view address lists. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,7 +46,7 @@ Get-AddressList [-SearchText ] ## DESCRIPTION You can pipe the output from the Get-AddressList cmdlet to the Remove-AddressList, Set-AddressList, Update-AddressList and Move-AddressList cmdlets instead of using the Identity parameter with each of those cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -153,12 +153,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md index 737adb06e9..7faa2b133d 100644 --- a/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md +++ b/exchange/exchange-ps/exchange/Get-AddressRewriteEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-addressrewriteentry +online version: https://learn.microsoft.com/powershell/module/exchange/get-addressrewriteentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-AddressRewriteEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-AddressRewriteEntry cmdlet to view an existing address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -86,12 +86,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md index 313f135e3e..e9159a5432 100644 --- a/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/exchange/Get-AdminAuditLogConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-adminauditlogconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-adminauditlogconfig +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-AdminAuditLogConfig schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-AdminAuditLogConfig cmdlet to view the administrator audit logging configuration settings. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,9 +26,9 @@ Get-AdminAuditLogConfig [-DomainController ] ``` ## DESCRIPTION -When audit logging is enabled, a log entry is created for each cmdlet that's run, excluding Get cmdlets. +To check the UnifiedAuditLogIngestionEnabled value in the output of this cmdlet, run the command in Exchange Online PowerShell. The value in Security & Compliance PowerShell is always False and the Set-AdminAuditLogConfig cmdlet (and the UnifiedAuditLogIngestionEnabled parameter) is not available to change it. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -39,8 +39,8 @@ Get-AdminAuditLogConfig | Format-List This example displays the administrator audit logging settings. The output of the Get-AdminAuditLogConfig cmdlet is piped to the Format-List cmdlet. For more information about piping and the Format-List cmdlet, see the following topics: -- [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) -- [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help) +- [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) +- [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help) ## PARAMETERS @@ -67,12 +67,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md index d01064198c..6a2753ab2d 100644 --- a/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md +++ b/exchange/exchange-ps/exchange/Get-AdministrativeUnit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-administrativeunit +online version: https://learn.microsoft.com/powershell/module/exchange/get-administrativeunit applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-AdministrativeUnit schema: 2.0.0 @@ -12,15 +12,13 @@ ms.reviewer: # Get-AdministrativeUnit ## SYNOPSIS -This cmdlet is available or functional only in the cloud-based service. +This cmdlet is functional only in the cloud-based service. -Use the Get-AdministrativeUnit cmdlet to view administrative units, which are Azure Active Directory containers of resources. You can use administrative units to delegate administrative permissions and apply policies to different groups of users. +Use the Get-AdministrativeUnit cmdlet to view administrative units, which are Microsoft Entra containers of resources. You can use administrative units to delegate administrative permissions and apply policies to different groups of users. -**Note**: Administrative units are only available in Azure Active Directory Premium. You create and manage administrative units in Azure AD PowerShell. +**Note**: Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +31,7 @@ Get-AdministrativeUnit [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,7 +40,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-AdministrativeUnit ``` -This example returns a summary list of all Azure Active Directory administrative units. +This example returns a summary list of all Microsoft Entra administrative units. ### Example 2 ```powershell @@ -56,8 +54,8 @@ This example returns detailed information about the administrative unit with the ### -Identity The Identity parameter specifies the administrative unit that you want to view. You can use any value that uniquely identifies the administrative unit. For example: -- Display name (this value is the same in Azure AD PowerShell) -- ExternalDirectoryObjectId (this GUID value is the same as the ObjectId property in Azure AD PowerShell) +- Display name (this value is the same in Microsoft Graph PowerShell) +- ExternalDirectoryObjectId (this GUID value is the same as the ObjectId property in Microsoft Graph PowerShell) - Name (GUID value) - Distinguished name (DN) - GUID (different value than Name) @@ -133,12 +131,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md deleted file mode 100644 index bc02558195..0000000000 --- a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentDetail.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiondocumentdetail -applicable: Exchange Online, Exchange Online Protection -title: Get-AdvancedThreatProtectionDocumentDetail -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-AdvancedThreatProtectionDocumentDetail - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AdvancedThreatProtectionDocumentDetailReport cmdlet to view the detailed results of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in your Microsoft Defender for Office 365 organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-AdvancedThreatProtectionDocumentDetail [-Action ] - [-Domain ] - [-EndDate ] - [-EventType ] - [-Page ] - [-PageSize ] - [-ProbeTag ] - [-StartDate ] - [] -``` - -## DESCRIPTION -For the reporting period and organization you specify, the cmdlet returns the following information: - -- Action -- Document Id -- Domain -- Event Type -- File Hash -- File Name -- File Path -- Size -- Timestamp -- Workload - -For more information about this feature, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-AdvancedThreatProtectionDocumentDetail -Organization contoso.com -StartDate "4/26/2016" -EndDate "4/28/2016" | Format-Table -``` - -This example returns the detailed report of detections during the specified date range. - -## PARAMETERS - -### -Action -The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - -- Allow -- BlockAccess - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- Advanced Threat Protection -- Advanced Threat Protection clean -- Anti-malware engine -- Anti-malware engine clean - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentReport.md b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentReport.md deleted file mode 100644 index a5b84bc5b3..0000000000 --- a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionDocumentReport.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiondocumentreport -applicable: Exchange Online, Exchange Online Protection -title: Get-AdvancedThreatProtectionDocumentReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-AdvancedThreatProtectionDocumentReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-AdvancedThreatProtectionDocumentReport cmdlet to view the results of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in your Microsoft Defender for Office 365 organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-AdvancedThreatProtectionDocumentReport - [-Action ] - [-AggregateBy ] - [-Domain ] - [-EndDate ] - [-EventType ] - [-Page ] - [-PageSize ] - [-ProbeTag ] - [-StartDate ] - [-SummarizeBy ] - [] -``` - -## DESCRIPTION -For more information about this feature, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). - -For the reporting period and organization you specify, the cmdlet returns the following information: - -- Action -- Count -- Date -- Domain -- Event Type -- Workload - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-AdvancedThreatProtectionTrafficReport -Organization contoso.com -StartDate "4/26/2018" -EndDate "4/28/2018" | Format-Table -``` - -This example returns the aggregated report of detections for the specified organization during the specified date range. - -## PARAMETERS - -### -Action -The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - -- Allow -- BlockAccess - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format which is defined in the Regional Options settings on the computer where you are running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- Advanced Threat Protection -- Advanced Threat Protection clean -- Anti-malware engine -- Anti-malware engine clean - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format which is defined in the Regional Options settings on the computer where you are running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -{{ Fill SummarizeBy Description }} - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionTrafficReport.md b/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionTrafficReport.md deleted file mode 100644 index 9e0a671532..0000000000 --- a/exchange/exchange-ps/exchange/Get-AdvancedThreatProtectionTrafficReport.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-advancedthreatprotectiontrafficreport -applicable: Exchange Online, Exchange Online Protection -title: Get-AdvancedThreatProtectionTrafficReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-AdvancedThreatProtectionTrafficReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet will be deprecated. Use the **Get-MailTrafficATPReport** cmdlet instead. - -Use the Get-AdvancedThreatProtectionTrafficReport cmdlet to view the results of Safe Attachments and Safe Links actions in your cloud-based organization for the last 90 days. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-AdvancedThreatProtectionTrafficReport [-Action ] - [-AggregateBy ] - [-Direction ] - [-DisplayBy ] - [-Domain ] - [-EndDate ] - [-EventType ] - [-MalwareName ] - [-Page ] - [-PageSize ] - [-ProbeTag ] - [-StartDate ] - [] -``` - -## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. - -Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. - -For the reporting period you specify, the cmdlet returns the following information: - -- Domain -- Date -- Event Type -- MalwareName -- Action -- Message Count - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-AdvancedThreatProtectionTrafficReport -StartDate "4/26/2016" -EndDate "4/28/2016" | Format-Table -``` - -This example returns the results of Safe Attachments and Safe Links actions during the specified date range. - -## PARAMETERS - -### -Action -The Action parameter filters the results by the action taken on the attachment or link. Valid values are: - -- Allow -- AllowRedirect -- BlockAccess -- BlockRedirect -- BypassMessage -- BypassMessageSystem -- ContentReplaced -- InfectedAllowed -- ReplaceRedirect - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayBy -The DisplayBy parameter specifies how the information in the report is organized. Valid values are: - -- Action (This is the default value) -- MalwareName - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- AdvancedProtectionMalware -- AtpGoodMail - -To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify Microsoft Defender for Office 365 (formerly known as Advanced Threat Protection or ATP) event types for Defender for Office 365 reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MalwareName -The MalwareName parameter filters the results by malware payload. Valid values are: - -- Excel -- EXE -- Flash -- Others -- PDF -- PowerPoint -- URL - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AgentLog.md b/exchange/exchange-ps/exchange/Get-AgentLog.md index fbe5326260..90b89266d4 100644 --- a/exchange/exchange-ps/exchange/Get-AgentLog.md +++ b/exchange/exchange-ps/exchange/Get-AgentLog.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-agentlog +online version: https://learn.microsoft.com/powershell/module/exchange/get-agentlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-AgentLog schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-AgentLog cmdlet to parse log files that you specify as parameters and collect raw statistics from the filtering that anti-spam agents apply during a time period that you specify. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-AgentLog [-EndDate ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,7 +45,7 @@ This example returns a report that has statistics collected between 09:00 (9 A.M ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -79,7 +79,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -121,12 +121,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AggregateZapReport.md b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md new file mode 100644 index 0000000000..fd62052590 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AggregateZapReport.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-aggregatezapreport +applicable: Exchange Online +title: Get-AggregateZapReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AggregateZapReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-AggregateZapReport cmdlet to view aggregate information about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AggregateZapReport + [[-EndDate] ] + [[-Page] ] + [[-PageSize] ] + [[-StartDate] ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following information: + +- Date +- EventType +- ZapActionCount + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AggregateZapReport +``` + +This example retrieves information for the last 3 days. + +### Example 2 +```powershell +Get-AggregateZapReport -StartDate 7/1/2023 -EndDate 7/9/2023 +``` + +This example retrieves information for the specified date range. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". + +If you use the EndDate parameter, you also need to use the StartDate parameter. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". + +If you use this parameter, you also need to use the StartDate parameter. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md index f1cc767ece..332d193a34 100644 --- a/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AntiPhishPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-antiphishpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-antiphishpolicy applicable: Exchange Online, Exchange Online Protection title: Get-AntiPhishPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-AntiPhishPolicy cmdlet to view antiphish policies in your cloud-based organization. This cmdlet returns results only in Exchange Online PowerShell. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +29,7 @@ Get-AntiPhishPolicy [-Identity ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,7 +77,7 @@ The Advanced switch filters the properties that are returned to the advanced set You don't need to specify a value with this switch. -Advanced settings are only available in anti-phishing policies in Microsoft Defender for Office 365. +Advanced settings are available only in anti-phishing policies in Microsoft Defender for Office 365. ```yaml Type: SwitchParameter @@ -119,7 +117,7 @@ The Impersonation switch filters the properties that are returned to the imperso You don't need to specify a value with this switch. -Impersonation settings are only available in anti-phishing policies in Microsoft Defender for Office 365. +Impersonation settings are available only in anti-phishing policies in Microsoft Defender for Office 365. ```yaml Type: SwitchParameter @@ -160,12 +158,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AntiPhishRule.md b/exchange/exchange-ps/exchange/Get-AntiPhishRule.md index ae6e8b3e89..9593dd004c 100644 --- a/exchange/exchange-ps/exchange/Get-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/Get-AntiPhishRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-antiphishrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-antiphishrule applicable: Exchange Online, Exchange Online Protection title: Get-AntiPhishRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-AntiPhishRule cmdlet to view antiphish rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +27,7 @@ Get-AntiPhishRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,12 +88,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-App.md b/exchange/exchange-ps/exchange/Get-App.md index 49d8d22c6a..4d63102688 100644 --- a/exchange/exchange-ps/exchange/Get-App.md +++ b/exchange/exchange-ps/exchange/Get-App.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-app +online version: https://learn.microsoft.com/powershell/module/exchange/get-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-App schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-App cmdlet to view installed apps. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Get-App [[-Identity] ] ## DESCRIPTION The Get-App cmdlet returns information about all installed apps or the details of a specific installed app. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,6 +109,8 @@ The Mailbox parameter specifies the identity of the mailbox where the apps are i You can't use this parameter with the Identity parameter. +**Note**: This parameter only returns user installed and default add-ins. It doesn't return add-ins installed by admins from Integrated Apps. For more information, see [Deploy and manage Office Add-ins](https://learn.microsoft.com/microsoft-365/admin/manage/office-addins). + ```yaml Type: MailboxIdParameter Parameter Sets: (All) @@ -161,12 +163,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md new file mode 100644 index 0000000000..1feb6b2100 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AppRetentionCompliancePolicy.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancepolicy +applicable: Security & Compliance +title: Get-AppRetentionCompliancePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AppRetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-AppRetentionCompliancePolicy to view app retention compliance policies. App retention & labeling policies target new ways to scope and manage policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AppRetentionCompliancePolicy [[-Identity] ] + [-DistributionDetail] + [-ErrorPolicyOnly] + [-RetentionRuleTypes] + [] +``` + +## DESCRIPTION +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies that cover Teams private channels, Viva Engage chats, and Viva Engage community messages. Eventually, you'll use these cmdlets for most retention locations and policy types. The \*-RetentionCompliance\* cmdlets will continue to support Exchange and SharePoint locations primarily. For policies created with the \*-AppRetentionCompliance\* cmdlets, you can only set the list of included or excluded scopes for all included workloads, which means you'll likely need to create one policy per workload. + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AppRetentionCompliancePolicy | Format-Table Name,GUID +``` + +This example returns a summary list of all app retention compliance policies. + +### Example 1 +```powershell +Get-AppRetentionCompliancePolicy -Identity "Contoso Viva Engage" +``` + +This example returns detailed information for the app retention compliance policy named Contoso Viva Engage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DistributionDetail +The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ErrorPolicyOnly +{{ Fill ErrorPolicyOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionRuleTypes +The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. + +To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, `Get-AppRetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes`. If you don't use the RetentionRuleTypes switch, the value appears blank. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md new file mode 100644 index 0000000000..b61fb71ac0 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-AppRetentionComplianceRule.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-appretentioncompliancerule +applicable: Security & Compliance +title: Get-AppRetentionComplianceRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-AppRetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Get-AppRetentionComplianceRule to view app retention compliance rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-AppRetentionComplianceRule [[-Identity] ] [-Policy ] [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AppRetentionComplianceRule | Format-Table Name,Policy +``` + +This example returns a summary list of all app retention compliance rules. + +### Example 1 +```powershell +Get-AppRetentionComplianceRule -Identity "Contoso Viva Engage" +``` + +This example returns detailed information for the app retention compliance rule named Contoso Viva Engage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance rule that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter filters the app retention compliance rule results by the associated app retention compliance policy. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md index 528d314f3d..60e3070aa4 100644 --- a/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Get-ApplicationAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-applicationaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection title: Get-ApplicationAccessPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-ApplicationAccessPolicy cmdlet to view the list of application access policies. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Get-ApplicationAccessPolicy [[-Identity] ] ## DESCRIPTION This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,12 +69,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ArcConfig.md b/exchange/exchange-ps/exchange/Get-ArcConfig.md new file mode 100644 index 0000000000..84df4c911e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ArcConfig.md @@ -0,0 +1,52 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-arcconfig +applicable: Exchange Online +title: Get-ArcConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ArcConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ArcConfig cmdlet to view the list of trusted Authenticated Received Chain (ARC) sealers that are configured in the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ArcConfig [] +``` + +## DESCRIPTION +Services that modify message content in transit before delivery can invalidate DKIM email signatures and affect the authentication of the message. These services can use ARC to provide details of the original authentication before the modifications occurred. Your organization can then trust these details to help authenticate the message. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ArcConfig +``` + +This example returns the trusted ARC sealers that are configured for the organization + +## 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md index daa0136fe7..31818f3779 100644 --- a/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Get-AtpPolicyForO365.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-atppolicyforo365 -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-atppolicyforo365 +applicable: Exchange Online title: Get-AtpPolicyForO365 schema: 2.0.0 author: chrisda @@ -20,9 +20,7 @@ Use the Get-AtpPolicyForO365 cmdlet to view the settings for the following featu - Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise. - Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,13 +30,13 @@ Get-AtpPolicyForO365 [[-Identity] ] ``` ## DESCRIPTION -Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see [Safe Links settings for Office 365 apps](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#safe-links-settings-for-office-365-apps). +Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see [Safe Links settings for Office 365 apps](https://learn.microsoft.com/defender-office-365/safe-links-about#safe-links-settings-for-office-apps). -Safe Documents scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-docs). +Safe Documents scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://learn.microsoft.com/defender-office-365/safe-documents-in-e5-plus-security-about). -Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). +Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://learn.microsoft.com/defender-office-365/safe-attachments-for-spo-odfb-teams-about). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +56,7 @@ The Identity parameter specifies the policy that you want to modify. There's onl Type: AtpPolicyForO365IdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -72,12 +70,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md index dea37f4122..f9144d58cd 100644 --- a/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/exchange/Get-AttachmentFilterEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-attachmentfilterentry +online version: https://learn.microsoft.com/powershell/module/exchange/get-attachmentfilterentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-AttachmentFilterEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-AttachmentFilterEntry cmdlet to view the list of attachment filter entries that are used by the Attachment Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-AttachmentFilterEntry [[-Identity] ] ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://docs.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -98,12 +98,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md b/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md index 8ab78d5ea5..f05c82c01c 100644 --- a/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md +++ b/exchange/exchange-ps/exchange/Get-AttachmentFilterListConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-attachmentfilterlistconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-attachmentfilterlistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-AttachmentFilterListConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-AttachmentFilterListConfig cmdlet to view the configuration of the Attachment Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -64,12 +64,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AuditConfig.md b/exchange/exchange-ps/exchange/Get-AuditConfig.md index a84a388b56..65476171dc 100644 --- a/exchange/exchange-ps/exchange/Get-AuditConfig.md +++ b/exchange/exchange-ps/exchange/Get-AuditConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-auditconfig -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-auditconfig +applicable: Security & Compliance title: Get-AuditConfig schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-AuditConfig ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-AuditConfig cmdlet to view the auditing configuration in the Microsoft 365 compliance center. +Use the Get-AuditConfig cmdlet to view the auditing configuration in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-AuditConfig [-DomainController ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -35,7 +35,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Get-AuditConfig ``` -This example shows the auditing configuration in the Microsoft 365 compliance center. +This example shows the auditing configuration in the Microsoft Purview compliance portal. ## PARAMETERS @@ -46,7 +46,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -60,12 +60,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/Get-AuditConfigurationPolicy.md deleted file mode 100644 index 737d1421af..0000000000 --- a/exchange/exchange-ps/exchange/Get-AuditConfigurationPolicy.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-auditconfigurationpolicy -applicable: Exchange Online, Security & Compliance Center -title: Get-AuditConfigurationPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-AuditConfigurationPolicy - -## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Get-AuditConfigurationPolicy cmdlet to view audit configuration policies. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-AuditConfigurationPolicy [[-Identity] ] - [-DomainController ] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-AuditConfigurationPolicy | Format-List Name,Enabled,Workload,Priority,*Location -``` - -This example lists summary information about all audit configuration policies. - -### Example 2 -```powershell -Get-AuditConfigurationPolicy -Identity 8d4d2060-ee8e-46a8-8d72-24922956fba5 -``` - -This examples lists details about the audit configuration policy named 8d4d2060-ee8e-46a8-8d72-24922956fba5. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the audit configuration policy that you want to view. The name of the policy is a GUID value. For example, 8d4d2060-ee8e-46a8-8d72-24922956fba5. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Security & Compliance Center - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/Get-AuditConfigurationRule.md deleted file mode 100644 index 4949090e5a..0000000000 --- a/exchange/exchange-ps/exchange/Get-AuditConfigurationRule.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-auditconfigurationrule -applicable: Exchange Online, Security & Compliance Center -title: Get-AuditConfigurationRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Get-AuditConfigurationRule cmdlet to view audit configuration rules. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-AuditConfigurationRule [[-Identity] ] - [-DomainController ] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-AuditConfigurationRule | Format-List Name,Workload,AuditOperation,Policy -``` - -This example lists summary information about all audit configuration rules. - -### Example 2 -```powershell -Get-AuditConfigurationRule 989a3a6c-dc40-4fa4-8307-beb3ece992e9 -``` - -This example lists details about the audit configuration rule named 989a3a6c-dc40-4fa4-8307-beb3ece992e9. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the audit configuration rule that you want to view. The name of the rule is a GUID value. For example, 989a3a6c-dc40-4fa4-8307-beb3ece992e9. - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Security & Compliance Center - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AuditLogSearch.md b/exchange/exchange-ps/exchange/Get-AuditLogSearch.md index 0434d067cc..a77201fca0 100644 --- a/exchange/exchange-ps/exchange/Get-AuditLogSearch.md +++ b/exchange/exchange-ps/exchange/Get-AuditLogSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-auditlogsearch +online version: https://learn.microsoft.com/powershell/module/exchange/get-auditlogsearch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-AuditLogSearch schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-AuditLogSearch cmdlet to return a list of current audit log searches that were created with the New-AdminAuditLogSearch or New-MailboxAuditLogSearch cmdlets. The Get-AuditLogSearch cmdlet also returns audit log searches that are initiated whenever an administrator uses the Exchange admin center (EAC) to export audit logs. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Get-AuditLogSearch [[-Identity] ] ## DESCRIPTION Run the Get-AuditLogSearch cmdlet to return a list of pending audit log searches. If an audit log search has been completed, it won't be displayed in the list of audit log searches. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,7 +71,7 @@ Accept wildcard characters: False ### -CreatedAfter The CreatedAfter parameter filters the results to audit log searches that were created after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -89,7 +89,7 @@ Accept wildcard characters: False ### -CreatedBefore The CreatedBefore parameter filters the results to audit log searches that were created before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -141,12 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AuthConfig.md b/exchange/exchange-ps/exchange/Get-AuthConfig.md index 9422ed78ae..7acbfbce8c 100644 --- a/exchange/exchange-ps/exchange/Get-AuthConfig.md +++ b/exchange/exchange-ps/exchange/Get-AuthConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-authconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-authconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-AuthConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-AuthConfig cmdlet to get the authorization configuration for partner applications. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-AuthConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,12 +60,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AuthRedirect.md b/exchange/exchange-ps/exchange/Get-AuthRedirect.md index 6d6c37726b..a1e538e22c 100644 --- a/exchange/exchange-ps/exchange/Get-AuthRedirect.md +++ b/exchange/exchange-ps/exchange/Get-AuthRedirect.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-authredirect +online version: https://learn.microsoft.com/powershell/module/exchange/get-authredirect applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-AuthRedirect schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-AuthRedirect cmdlet to view OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-AuthRedirect [[-Identity] ] ## DESCRIPTION Exchange 2010 Client Access servers don't support OAuth authentication requests. OAuth redirection objects redirect OAuth authentication requests to Exchange servers that are running later versions of Exchange. This cmdlet is only useful if your organization has Exchange 2010 Client Access servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,7 +42,7 @@ This example shows a summary list of all the OAuth redirection objects. ### Example 2 ```powershell -Get-AuthRedirect AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE | Format-List +Get-AuthRedirect -Identity AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE | Format-List ``` This example shows detailed information about the OAuth redirection object named AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE @@ -86,12 +86,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AuthServer.md b/exchange/exchange-ps/exchange/Get-AuthServer.md index 5f0db677eb..ecf577d5a2 100644 --- a/exchange/exchange-ps/exchange/Get-AuthServer.md +++ b/exchange/exchange-ps/exchange/Get-AuthServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-authserver +online version: https://learn.microsoft.com/powershell/module/exchange/get-authserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-AuthServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-AuthServer cmdlet to view the settings of authorization servers in the Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-AuthServer [[-Identity] ] ## DESCRIPTION An authorization server is a server or service that issues tokens trusted by Microsoft Exchange for access by partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -92,12 +92,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md index a2a22c7b0e..b79c7d9b3c 100644 --- a/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AuthenticationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-authenticationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-authenticationpolicy applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-AuthenticationPolicy schema: 2.0.0 @@ -15,17 +15,19 @@ ms.reviewer: This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Get-AuthenticationPolicy cmdlet to view authentication policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-AuthenticationPolicy [[-Identity] ] + [-AllowLegacyExchangeTokens] + [-TenantId ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,6 +45,13 @@ Get-AuthenticationPolicy -Identity "Engineering Group" This example returns detailed information for the authentication policy named Engineering Group. +### Example 3 +```powershell +Get-AuthenticationPolicy -AllowLegacyExchangeTokens +``` + +In Exchange Online, this example specifies whether legacy Exchange tokens for Outlook add-ins are allowed in the organization. + ## PARAMETERS ### -Identity @@ -65,17 +74,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowLegacyExchangeTokens +This parameter is available only in the cloud-based service. + +The AllowLegacyExchangeTokens switch specifies whether legacy Exchange tokens are allowed for Outlook add-ins in your organization. You don't need to specify a value with this switch. + +Legacy Exchange tokens include Exchange user identity and callback tokens. + +**Important**: + +- The AllowLegacyExchangeTokens switch returns `Not Set` if tokens haven't been explicitly allowed or blocked in your organization using the _AllowLegacyExchangeTokens_ or _BlockLegacyExchangeTokens_ parameters on the **Set-AuthenticationPolicy** cmdlet. For more information, see [Get the status of legacy Exchange Online tokens and add-ins that use them](https://learn.microsoft.com/office/dev/add-ins/outlook/turn-exchange-tokens-on-off#get-the-status-of-legacy-exchange-online-tokens-and-add-ins-that-use-them). +- As of February 17 2025, legacy Exchange tokens are blocked by default in all cloud-based organizations. Although tokens are blocked by default, the AllowLegacyExchangeTokens switch still returns `Not Set` if you haven't used the _AllowLegacyExchangeTokens_ or _BlockLegacyExchangeTokens_ parameters on the **Set-AuthenticationPolicy** cmdlet. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +This parameter is available only in the cloud-based service. + +{{ Fill TenantId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md index 3abf9c45ea..b60b6db4da 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-autosensitivitylabelpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-autosensitivitylabelpolicy +applicable: Security & Compliance title: Get-AutoSensitivityLabelPolicy schema: 2.0.0 author: chrisda @@ -12,23 +12,25 @@ ms.reviewer: # Get-AutoSensitivityLabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-AutoSensitivityLabelPolicy cmdlet to view auto-labeling policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-AutoSensitivityLabelPolicy [[-Identity] ] [-DistributionDetail] + [-ForceValidate ] + [-IncludeProgressFeedback] [-IncludeTestModeResults ] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -52,7 +54,7 @@ The Identity parameter specifies the auto-labeling policy that you want to view. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -68,7 +70,44 @@ The DistributionDetail switch returns detailed policy distribution information i Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceValidate +The ForceValidate parameter specifies whether to include details related to the AdminUnits of users, groups, or sites in the policy. Valid values are: + +- $true: Various properties in the policy include details of the AdminUnits that are associated with current set of selected users, groups, or sites. +- $false: The output doesn't contain the information. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeProgressFeedback +IncludeProgressFeedback specifies whether to include the labeling progress of files in SharePoint or OneDrive. You don't need to specify a value with this switch. + +If you use this switch, the command shows the progress of files to be labeled, files labeled in the last 7 days, and total files labeled for enabled auto-labeling policies. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -87,7 +126,7 @@ The IncludeTestModeResults parameter specifies whether to include the status of Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,12 +140,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md index c97923cfab..ebaea6d9d6 100644 --- a/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Get-AutoSensitivityLabelRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-autosensitivitylabelrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-autosensitivitylabelrule +applicable: Security & Compliance title: Get-AutoSensitivityLabelRule schema: 2.0.0 author: chrisda @@ -12,17 +12,18 @@ ms.reviewer: # Get-AutoSensitivityLabelRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-AutoSensitivityLabelPolicy cmdlet to view auto-labeling policy rules in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-AutoSensitivityLabelRule [[-Identity] ] [-Confirm] + [-ForceValidate] [-IncludeExecutionRuleGuids ] [-IncludeExecutionRuleInformation ] [-Policy ] @@ -31,7 +32,7 @@ Get-AutoSensitivityLabelRule [[-Identity] ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -40,7 +41,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Get-AutoSensitivityLabelRule ``` -This example displays summary information for all autolabeling rules in the Microsoft 365 compliance center. +This example displays summary information for all autolabeling rules in the Microsoft Purview compliance portal. ## PARAMETERS @@ -55,7 +56,7 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -71,7 +72,23 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceValidate +{{ Fill ForceValidate Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -90,7 +107,7 @@ The IncludeExecutionRuleGuids parameter specifies whether to include the executi Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -109,7 +126,7 @@ The IncludeExecutionRuleInformation parameter specifies whether to include the e Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -129,7 +146,7 @@ The Policy parameter filters the auto-labeling policy rule results by the associ Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -145,7 +162,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -159,12 +176,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md index 08d59c541b..e8c693c9bf 100644 --- a/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-AutodiscoverVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-autodiscovervirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/get-autodiscovervirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-AutodiscoverVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-AutodiscoverVirtualDirectory cmdlet to view Autodiscover virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Get-AutodiscoverVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,7 +114,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -170,12 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md index a947de4318..bfde6fcc4c 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/exchange/Get-AvailabilityAddressSpace.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-availabilityaddressspace -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityaddressspace +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-AvailabilityAddressSpace schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-AvailabilityAddressSpace cmdlet to view existing availability address space objects that are used to share free/busy data across Exchange organizations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-AvailabilityAddressSpace [[-Identity] ] ## DESCRIPTION In on-premises Exchange organizations, you run the Remove-AvailabilityAddressSpace cmdlet on Exchange servers that have the Client Access server role installed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,7 +60,7 @@ The Identity parameter specifies the availability address space that you want to Type: AvailabilityAddressSpaceIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -92,12 +92,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md index 315adf47ee..7932aaed30 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/Get-AvailabilityConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-availabilityconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-AvailabilityConfig schema: 2.0.0 @@ -14,9 +14,12 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Get-AvailabilityConfig cmdlet to retrieve the accounts that are trusted in the cross-forest exchange of free/busy information. +Use the Get-AvailabilityConfig cmdlet to view information about the sharing of free/busy information between organizations: -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +- In on-premises Exchange, the cmdlet returns the accounts that are trusted in the cross-forest sharing of free/busy information. +- In Exchange Online, the cmdlet returns the tenant IDs of organizations that free/busy information is being shared with. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,9 +30,7 @@ Get-AvailabilityConfig [[-Identity] ] ``` ## DESCRIPTION -The Get-AvailabilityConfig cmdlet lists the accounts that have permissions to issue proxy availability service requests on an organizational or per-user basis. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -38,19 +39,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-AvailabilityConfig ``` -This example retrieves the accounts that are trusted in the cross-forest exchange of free/busy information. - -### Example 2 -```powershell -Get-AvailabilityConfig -Identity -``` +In on-premises Exchange, this example returns the accounts that are trusted in the cross-forest shared of free/busy information. -This example retrieves the accounts that are trusted in the cross-forest exchange of free/busy information. This example is scoped to return only the results of the specified Identity parameter. +In Exchange Online, this examples returns the tenant IDs that free/busy information is being shared with. ## PARAMETERS ### -Identity -The Identity parameter specifies the availability configuration to be retrieved. +The Identity parameter specifies the availability configuration that you want to view. You don't need to use this parameter, because there's only one availability configuration object named Availability Configuration in any organization. ```yaml Type: OrganizationIdParameter @@ -88,12 +84,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md index 4bceef66c8..b73d3f29f3 100644 --- a/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/exchange/Get-AvailabilityReportOutage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-availabilityreportoutage +online version: https://learn.microsoft.com/powershell/module/exchange/get-availabilityreportoutage applicable: Exchange Server 2010 title: Get-AvailabilityReportOutage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Get-AvailabilityReportOutage cmdlet to return the daily downtime (if any) for each service entity and its overridden value (if set) to the overall reported availability for the day. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-AvailabilityReportOutage [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-BlockedConnector.md b/exchange/exchange-ps/exchange/Get-BlockedConnector.md new file mode 100644 index 0000000000..c6701d3230 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-BlockedConnector.md @@ -0,0 +1,73 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-blockedconnector +applicable: Exchange Online, Exchange Online Protection +title: Get-BlockedConnector +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-BlockedConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-BlockedConnector cmdlet to view inbound connectors that have been detected as potentially compromised. Blocked connectors are prevented from sending email. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-BlockedConnector [-ConnectorId ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-BlockedConnector +``` + +This example returns a summary list of all blocked connectors. + +### Example 2 +```powershell +Get-BlockedConnector -ConnectorId 159eb7c4-75d7-43e2-95fe-ced44b3e0a56 | Format-List +``` + +This example returns detailed information for the specified blocked connector. + +## PARAMETERS + +### -ConnectorId +The ConnectorId parameter specifies the blocked connector that you want to view. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md b/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md index 15bc67ef07..4a14ad443b 100644 --- a/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md +++ b/exchange/exchange-ps/exchange/Get-BlockedSenderAddress.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-blockedsenderaddress +online version: https://learn.microsoft.com/powershell/module/exchange/get-blockedsenderaddress applicable: Exchange Online, Exchange Online Protection title: Get-BlockedSenderAddress schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-BlockedSenderAddress cmdlet to view users in your Microsoft 365 organization that are impacted by the protection system. These users sent multiple messages that were classified as spam, so they're blocked from sending messages. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-BlockedSenderAddress [-SenderAddress ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,17 +63,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://docs.microsoft.com/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://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS -### -To see the input types that this cmdlet accepts, see [Exchange Management Shell cmdlet input and output types](https://docs.microsoft.com/exchange/client-developer/management/exchange-management-shell-cmdlet-input-and-output-types). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. +### Input types +To see the input types that this cmdlet accepts, see [Exchange Management Shell cmdlet input and output types](https://learn.microsoft.com/exchange/client-developer/management/exchange-management-shell-cmdlet-input-and-output-types). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Exchange Management Shell cmdlet input and output types](https://docs.microsoft.com/exchange/client-developer/management/exchange-management-shell-cmdlet-input-and-output-types). If the Output Type field is blank, the cmdlet doesn't return data. +### Output types +To see the return types, which are also known as output types, that this cmdlet accepts, see [Exchange Management Shell cmdlet input and output types](https://learn.microsoft.com/exchange/client-developer/management/exchange-management-shell-cmdlet-input-and-output-types). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-CASMailbox.md b/exchange/exchange-ps/exchange/Get-CASMailbox.md index 4ba929d8b1..00439ed122 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Get-CASMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-casmailbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-casmailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-CASMailbox schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-CASMailbox cmdlet to view the Client Access settings that are configured on mailboxes. -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOCASMailbox cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOCASMailbox cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -65,7 +65,7 @@ Get-CASMailbox [[-Identity] ] ## DESCRIPTION This cmdlet returns a variety of client access settings for one or more mailboxes. These settings include options for Outlook on the web, Exchange ActiveSync, POP3, and IMAP4. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,7 +123,7 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -133,9 +133,11 @@ Accept wildcard characters: False ``` ### -ActiveSyncDebugLogging -The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. If you don't use this switch, the value always appears as $false. +The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, the value always appears as $false. -To see this value, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List. +To see this value, you need to use a formatting cmdlet. For example, `Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List`. ```yaml Type: SwitchParameter @@ -191,7 +193,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -225,16 +227,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -250,9 +252,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -321,7 +323,9 @@ The ProtocolSettings switch returns the server names, TCP ports and encryption m - ExternalSmtpSettings - InternalSmtpSettings -To see these values, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List. +You don't need to specify a value with this switch. + +To see these values, you need to use a formatting cmdlet. For example, `Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List`. ```yaml Type: SwitchParameter @@ -339,7 +343,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -373,7 +379,9 @@ Accept wildcard characters: False ``` ### -RecalculateHasActiveSyncDevicePartnership -The RecalculateHasActiveSyncDevicePartnership switch recalculates the value of the HasActiveSyncDevicePartnership property on the mailbox. The value is automatically updated if it's found to be incorrect. You don't have to specify a value with this switch. +The RecalculateHasActiveSyncDevicePartnership switch recalculates the value of the HasActiveSyncDevicePartnership property on the mailbox. You don't need to specify a value with this switch. + +The value is automatically updated if it's found to be incorrect. ```yaml Type: SwitchParameter @@ -464,12 +472,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md b/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md index c644c415d5..c825898743 100644 --- a/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md +++ b/exchange/exchange-ps/exchange/Get-CASMailboxPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-casmailboxplan +online version: https://learn.microsoft.com/powershell/module/exchange/get-casmailboxplan applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-CASMailboxPlan schema: 2.0.0 @@ -12,13 +12,11 @@ ms.reviewer: # Get-CASMailboxPlan ## SYNOPSIS -This cmdlet is available or functional only in the cloud-based service. +This cmdlet is functional only in the cloud-based service. Use the Get-CASMailboxPlan cmdlet to view Client Access services (CAS) mailbox plans in cloud-based organizations. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +34,7 @@ Get-CASMailboxPlan [[-Identity] ] ## DESCRIPTION A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,7 +79,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -113,16 +111,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -201,12 +199,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md index 0f9f46fb28..497c465e12 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticAnalysis.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis +online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-CalendarDiagnosticAnalysis schema: 2.0.0 @@ -16,7 +16,7 @@ Although this cmdlet is available in on-premises Exchange and in the cloud-based Use the Get-CalendarDiagnosticAnalysis cmdlet to troubleshoot calendar-related reliability issues. You can use this cmdlet to analyze calendar item data that's recorded in the Calendar Diagnostic logs. You provide the calendar item data to this cmdlet by using the Get-CalendarDiagnosticLog cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -59,13 +59,14 @@ The following properties of the calendar item are returned in the default output - SenderEmailAddress - SentRepresentingDisplayName -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $logs = Get-CalendarDiagnosticLog -Identity oevans -MeetingID 040000008200E00074C5B7101A82E008000000009421DCCD5046CD0100000000000000001000000010B0349F6B17454685E17D9F9512E71F + Get-CalendarDiagnosticAnalysis -CalendarLogs $logs -DetailLevel Advanced | Set-Content -Path "C:\My Documents\Oscar Evans Analysis.csv" ``` @@ -78,7 +79,20 @@ For basic analysis of the item, don't include the DetailLevel parameter, or use Get-CalendarDiagnosticAnalysis -LogLocation "C:\My Documents\Exported Calendar Logs\jkozma@contoso.com" -DetailLevel Advanced -OutputAs HTML | Set-Content -Path "C:\My Documents\Jasen Kozma Analysis.html" ``` -This example analyzes the calendar items that were exported from Jasen Kozma's mailbox by using the Get-CalendarDiagnosticLog cmdlet with the LogLocation parameter and writes the advanced analysis of the items to an HTML file. +In **Exchange 2013**, this example analyzes the calendar items that were previously exported from Jasen Kozma's mailbox by using the Get-CalendarDiagnosticLog cmdlet with the LogLocation parameter and writes the advanced analysis of the items to an HTML file. + +**Note**: The LogLocation parameter is available only in Exchange 2013. To specify the location of exported calendar items in Exchange 2016 or Exchange 2019, see Example 3. + +For basic analysis of the items, don't include the DetailLevel parameter, or use the value Basic instead of Advanced. + +### Example 3 +```powershell +$calitems = Get-CalendarDiagnosticLog -Identity jkozma@contoso.com -Subject "Budget Meeting" + +ForEach($item in $calitems){$i++; Get-CalendarDiagnosticAnalysis -CalendarLogs $item -OutputAs HTML | Set-Content -Path ("\\FileServer01\Data\Jasen Kozma Analysis{0}.html" -f $i)} +``` + +This example analyzes the calendar items that were exported from Jasen Kozma's mailbox by using the Get-CalendarDiagnosticLog cmdlet and writes the advanced analysis for each item to an HTML file by using an UNC path. For basic analysis of the items, don't include the DetailLevel parameter, or use the value Basic instead of Advanced. @@ -89,7 +103,7 @@ The CalendarLogs parameter specifies the calendar item that you want to analyze. For example, to analyze the meeting with the subject "November Budget Meeting" in Shannon Steele's mailbox, run the command `$Budget = Get-CalendarDiagnosticLog -Identity "Shannon Steele" -Subject "November Budget Meeting" -ExactMatch` and then use the value `$Budget` for this parameter. -Note that you can't use this parameter to analyze multiple calendar items. The value that you use for this parameter must identify a single item. +The value that you use for this parameter must identify a single item. To identify multiple items, see Example 3. You can't use this parameter with the LogLocation parameter. @@ -107,6 +121,10 @@ Accept wildcard characters: False ``` ### -LogLocation +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To specify the calendar items to analyze, use the CalendarLogs parameter. + +This parameter is functional only in Exchange 2013. + The LogLocation parameter specifies the location of the exported calendar items that you want to analyze. You can specify a local path, or a UNC path (`\\Server\Share\User`). If the value contains spaces, enclose the value in quotation marks ("). You export the calendar items to .msg files by using the Get-CalendarDiagnosticLog cmdlet with the LogLocation parameter. If the path contains multiple .msg files, all of those files are analyzed when you run Get-CalendarDiagnosticAnalysis. @@ -117,7 +135,7 @@ You can't use this parameter with the CalendarLogs parameter. Type: String[] Parameter Sets: LocationSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Online Required: True Position: Named @@ -146,7 +164,7 @@ Accept wildcard characters: False ``` ### -GlobalObjectId -The GlobalObjectId parameter specifies the identity of the calendar item you want to analyze. You can use this parameter with the LogLocation parameter to specify the calendar item if the location contains multiple exported .msg files. +The GlobalObjectId parameter specifies the identity of the calendar item you want to analyze. In Exchange 2013, you can use this parameter with the LogLocation parameter to specify the calendar item if the location contains multiple exported .msg files. The GlobalObjectId property of the meeting uses the same format as the CleanGlobalObjectId property (for example, 040000008200E00074C5B7101A82E008000000009421DCCD5046CD0100000000000000001000000010B0349F6B17454685E17D9F9512E71F) and the value of the two properties is likely the same. However, the value of GlobalObjectId might not stay the same for all instances of the same meeting in multiple calendars (for example, different attendees invited to different instances of the same recurring meeting). @@ -188,12 +206,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md index 7bf56a2b92..38b63df96c 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticLog.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticlog +online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-CalendarDiagnosticLog schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-CalendarDiagnosticLog ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +Although this cmdlet is available in on-premises Exchange and in the cloud-based service, it only works in on-premises Exchange. In cloud-based service, use the Get-CalendarDiagnosticObjects cmdlet instead. Use the Get-CalendarDiagnosticLog cmdlet to collect a range of calendar logs. The Calendar Diagnostic logs track all calendar items and meeting requests in mailboxes. You can use this information to troubleshoot calendar issues that occur in mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -70,9 +70,9 @@ The output of this cmdlet contains the following information: - NormalizedSubject: The Subject field of the calendar item. - CleanGlobalObjectId: The identifier that's constant throughout the lifetime of the calendar item. For example, 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. -After you run the Get-CalendarDiagnosticLog cmdlet, you can analyze the calendar data using the Get-CalendarDiagnosticAnalysis cmdlet. For more information, see [Get-CalendarDiagnosticAnalysis](https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis). +After you run the Get-CalendarDiagnosticLog cmdlet, you can analyze the calendar data using the Get-CalendarDiagnosticAnalysis cmdlet. For more information, see [Get-CalendarDiagnosticAnalysis](https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticanalysis). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,12 +102,13 @@ This example retrieves the Calendar Diagnostic log data only for the most recent Get-CalendarDiagnosticLog -Identity "Jasen Kozma" -Subject "Budget Meeting" -ExactMatch $true -LogLocation "C:\My Documents\Calendar Diagnostic Export" ``` -This example exports all calendar items in the Calendar Diagnostic log for Jasen Kozma's mailbox that have "Budget Meeting" anywhere in the subject to the specified folder. +In **Exchange 2013**, this example exports all calendar items in the Calendar Diagnostic log for Jasen Kozma's mailbox that have "Budget Meeting" anywhere in the subject to the specified folder. **Notes**: - In this example, the message files are written to C:\\My Documents\\Calendar Diagnostic Export\\jkozma@contoso.com. -- In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet with the LogLocation parameter to analyze the exported .msg files. +- In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet to analyze the exported .msg files. +- This example doesn't work in Exchange 2016 or Exchange 2019 because the LogLocation parameter is not available. ## PARAMETERS @@ -139,19 +140,23 @@ Accept wildcard characters: False ``` ### -LogLocation +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. Usage of this cmdlet is now restricted to the local server. + +This parameter is functional only in Exchange 2010 and Exchange 2013. + The LogLocation parameter specifies the location to export the calendar items to .msg files. You can specify a local path, or a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). In the location you specify, a subfolder is automatically created for the specified mailbox that holds the exported calendar items. For example, if you specify the value "C:\\My Documents\\Calendar Export" to export calendar items from the mailbox of Shannon Steele, the .msg files are actually stored in C:\\My Documents\\Calendar Export\\ssteele@contoso.com. -In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet with the LogLocation parameter to analyze the exported .msg files. +In on-premises Exchange organizations, you can use the Get-CalendarDiagnosticAnalysis cmdlet to analyze the exported .msg files. -**Note**: Commands that use this parameter might fail if the calendar item doesn't have a title. If you receive errors when you use this parameter, run the command again and replace this parameter with redirection to a file (| Set-Content -Path "C:\\My Documents\\Calendar Export") or substitute the output to a PowerShell variable. +**Note**: Commands that use this parameter might fail if the calendar item doesn't have a title. If you receive errors when you use this parameter, run the command again and replace this parameter with redirection to a file (`| Set-Content -Path "C:\My Documents\Calendar Export"`) or substitute the output to a PowerShell variable. ```yaml Type: String Parameter Sets: ExportToMsg Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online Required: True Position: Named @@ -164,7 +169,7 @@ Accept wildcard characters: False Type: String Parameter Sets: MeetingId, MeetingSubject Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Online Required: False Position: Named @@ -242,7 +247,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -278,7 +283,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -387,7 +392,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -423,7 +430,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -443,12 +450,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md index 1c6e840047..e01ded63d5 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md +++ b/exchange/exchange-ps/exchange/Get-CalendarDiagnosticObjects.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-calendardiagnosticobjects +online version: https://learn.microsoft.com/powershell/module/exchange/get-calendardiagnosticobjects applicable: Exchange Online title: Get-CalendarDiagnosticObjects schema: 2.0.0 @@ -16,14 +16,14 @@ This cmdlet is available only in the cloud-based service. Use the Get-CalendarDiagnosticObjects cmdlet to collect a range of calendar logs. The calendar diagnostic logs track important calendar-related event data for each mailbox, and can be used to troubleshoot calendar issues that occur in mailboxes. The logs track all calendar items and meeting messages. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-CalendarDiagnosticObjects [-Identity] + [-AnalyzeExceptionWithOriginalStartDate ] + [-AutoRequeryOnMeetingId ] [-ConfigurationName ] [-CustomPropertyNames ] [-EndDate ] @@ -32,6 +32,7 @@ Get-CalendarDiagnosticObjects [-Identity] [-ExactMatch ] [-ItemClass ] [-ItemIds ] + [-MaxResults ] [-MeetingId ] [-ODataId ] [-ResultSize ] @@ -55,7 +56,7 @@ Some of the more interesting properties that are returned in the results are: - ResponseType: 0 = The organizer hasn't received a response, 1 = The organizer's copy of the meeting, 2 = Tentative, 3 = Accept, 4 = Decline, or 5 = The attendee hasn't responded. - ResponsibleUserName: The LegacyExchangeDN value of the user who made the change (for example, `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=BN6PR11MB1587/cn=Microsoft System Attendant` or `/o=ExchangeLabs/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Recipients/cn=696eea97d3c449eab648920d03385efb-admin`). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,8 +70,8 @@ This example retrieves the calendar diagnostic logs from Pedro Pizarro's mailbox ### Example 2 ```powershell $A = Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Meeting" -ExactMatch $true -$A | Select-Object *,@{n='OLMT' -e={[DateTime]::Parse($_.OriginalLastModifiedTime.ToString())}} | sort OLMT | Format-Table OriginalLastModifiedTime,CalendarLogTriggerAction,ItemClass,ClientInfoString + +$A | Select-Object *,@{n='OLMT'; e={[DateTime]::Parse($_.OriginalLastModifiedTime.ToString())}} | sort OLMT | Format-Table OriginalLastModifiedTime,CalendarLogTriggerAction,ItemClass,ClientInfoString ``` This is the same as the previous example, but now the results are sorted by original last modified time. @@ -87,7 +88,7 @@ This example retrieves the calendar diagnostic logs for Pedro Pizarro's mailbox Get-CalendarDiagnosticObjects -Identity "Pedro Pizarro" -Subject "Team Lunch" -StartDate 7/1/2018 -EndDate 7/31/2018 | Export-Csv "C:\My Documents\Team Lunch Meeting.csv" -NoTypeInformation ``` -This example returns diagnostic information for meetings with the subject Team Lunch in Pedro Pizarro's mailbox in the month of July, 2018, and exports the results to the file C:\\My Documents\\Team Lunch Meeting.csv. +This example returns diagnostic information for meetings with the subject Team Lunch in Pedro Pizarro's mailbox that were modified in the month of July, 2018, and exports the results to the file C:\\My Documents\\Team Lunch Meeting.csv. ## PARAMETERS @@ -118,6 +119,38 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AnalyzeExceptionWithOriginalStartDate +{{ Fill AnalyzeExceptionWithOriginalStartDate Description }} + +```yaml +Type: ExDateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoRequeryOnMeetingId +{{ Fill AutoRequeryOnMeetingId Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ConfigurationName {{ Fill ConfigurationName Description }} @@ -135,7 +168,7 @@ Accept wildcard characters: False ``` ### -CustomPropertyNames -The CustomPropertyNames parameter returns the specified calendar item custom property in the results. For valid values, see [Values for the CustomPropertyNames parameter in Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/values-for-custompropertynames-parameter). +The CustomPropertyNames parameter returns the specified calendar item custom property in the results. For valid values, see [Values for the CustomPropertyNames parameter in Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/values-for-custompropertynames-parameter). You can specify multiple values separated by commas. @@ -153,9 +186,9 @@ Accept wildcard characters: False ``` ### -EndDate -The EndDate parameter specifies the end date of the date range. +The EndDate parameter specifies the end date of the date range for the OriginalLastModifiedTime property (when the meeting was last modified, not created). -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -259,6 +292,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MaxResults +{{ Fill MaxResults Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MeetingId The MeetingId parameter filters the results by the globally unique identifier of the calendar item. The value is the CleanGlobalObjectId property of the calendar item that's available in the output of this cmdlet, or by using other MAPI examination tools. An example value is 040000008200E00074C5B7101A82E00800000000B0225ABF0710C80100000000000000001000000005B27C05AA7C4646B0835D5EB4E41C55. This value is constant throughout the lifetime of the calendar item. @@ -378,9 +427,9 @@ Accept wildcard characters: False ``` ### -StartDate -The StartDate parameter specifies the start date of the date range. +The StartDate parameter specifies the start date of the date range for the OriginalLastModifiedTime property (when the meeting was last modified, not created). -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -416,12 +465,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CalendarNotification.md b/exchange/exchange-ps/exchange/Get-CalendarNotification.md index a9eddf4125..014d7e719e 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarNotification.md +++ b/exchange/exchange-ps/exchange/Get-CalendarNotification.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-calendarnotification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-calendarnotification +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-CalendarNotification schema: 2.0.0 author: chrisda @@ -12,11 +12,13 @@ ms.reviewer: # Get-CalendarNotification ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. -Use the Get-CalendarNotification cmdlet to return a list of all calendar notification settings for a user. +Use the Get-CalendarNotification cmdlet to view calendar text message notification settings for a mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: This cmdlet has been deprecated in Exchange Online PowerShell. The text message notification service has been discontinued in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,37 +32,23 @@ Get-CalendarNotification [-Identity] ``` ## DESCRIPTION -The Get-CalendarNotification cmdlet retrieves and displays the rules used to trigger the calendar agenda notification, reminder notification, or update notification. +The Get-CalendarNotification cmdlet retrieves and displays the rules that trigger the calendar agenda notification, reminder notification, or update notification text messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-CalendarNotification -Identity "TonySmith" -``` - -This example returns the calendar notification settings for the user Tony Smith using the user's alias. - -### Example 2 -```powershell -Get-CalendarNotification -Identity tony@contoso.com -ReadFromDomainController -``` - -This example returns the calendar notification settings for the user Tony Smith. - -### Example 3 -```powershell -Get-CalendarNotification -Identity "contoso\tonysmith" +Get-CalendarNotification -Identity tony@contoso.com ``` -This example returns the calendar notification settings for the user Tony Smith using the user's domain and name. +This example returns the calendar text message notification settings for Tony's mailbox. ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox. You can use any value that uniquely identifies the mailbox. For example: +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - Name - Alias @@ -77,7 +65,7 @@ The Identity parameter specifies the mailbox. You can use any value that uniquel Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,13 +77,13 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,8 +93,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -123,13 +109,17 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController parameter specifies whether the command should return data from the domain controller. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -139,13 +129,13 @@ Accept wildcard characters: False ``` ### -ResultSize -The ResultSize parameter specifies the amount of data returned. +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -159,12 +149,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-CalendarProcessing.md b/exchange/exchange-ps/exchange/Get-CalendarProcessing.md index a60b4af0d3..a38f7b7958 100644 --- a/exchange/exchange-ps/exchange/Get-CalendarProcessing.md +++ b/exchange/exchange-ps/exchange/Get-CalendarProcessing.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-calendarprocessing +online version: https://learn.microsoft.com/powershell/module/exchange/get-calendarprocessing applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-CalendarProcessing schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-CalendarProcessing cmdlet to view the calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant and calendar configuration. Note that the settings returned by this cmdlet are editable only on resource mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,9 +29,9 @@ Get-CalendarProcessing [-Identity] ``` ## DESCRIPTION -For details about the properties that are returned in the output of this cmdlet, see [Set-CalendarProcessing](https://docs.microsoft.com/powershell/module/exchange/set-calendarprocessing). +For details about the properties that are returned in the output of this cmdlet, see [Set-CalendarProcessing](https://learn.microsoft.com/powershell/module/exchange/set-calendarprocessing). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -92,7 +92,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -130,12 +132,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md index c3cdb0f760..54654c842b 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Get-CaseHoldPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-caseholdpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy +applicable: Security & Compliance title: Get-CaseHoldPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-CaseHoldPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-CaseHoldPolicy to view existing case hold policies in the Microsoft 365 compliance center. To get relevant information about how the hold was applied and the affected locations, you need to include the DistributionDetail switch. +Use the Get-CaseHoldPolicy to view existing case hold policies in the Microsoft Purview compliance portal. To get relevant information about how the hold was applied and the affected locations, you need to include the DistributionDetail switch. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,11 +25,12 @@ Get-CaseHoldPolicy [[-Identity] ] [-Case ] [-DistributionDetail] [-IncludeBindings] + [-IncludeBindingsOnly] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -60,7 +61,7 @@ The Identity parameter specifies the case hold policy that you want to view. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -81,7 +82,7 @@ You can find these values by running the command: Get-ComplianceCase | Format-Ta Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -108,7 +109,7 @@ The following properties are affected by this switch: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -124,7 +125,23 @@ PARAMVALUE: SwitchParameter Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBindingsOnly +{{ Fill IncludeBindingsOnly Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -138,12 +155,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md b/exchange/exchange-ps/exchange/Get-CaseHoldRule.md index ea12e73a1b..632e20fe65 100644 --- a/exchange/exchange-ps/exchange/Get-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Get-CaseHoldRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-caseholdrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-caseholdrule +applicable: Security & Compliance title: Get-CaseHoldRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-CaseHoldRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-CaseHoldRule to view case hold rules in the Microsoft 365 compliance center. +Use the Get-CaseHoldRule to view case hold rules in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,11 @@ Get-CaseHoldRule [[-Identity] ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +In large environments, running this cmdlet without any parameters results in a timeout. As a workaround, you can run the following command: + +`Get-ComplianceCase | foreach {Get-CaseHoldPolicy -Case $_.Identity | foreach {Get-CaseHoldRule -Policy $_.Guid}}` + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -51,7 +55,7 @@ The Identity parameter specifies the case hold rule you want to view. You can us Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -73,7 +77,7 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -87,12 +91,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md index d7c75b6b30..b246435ac5 100644 --- a/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/Get-ClassificationRuleCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-classificationrulecollection +online version: https://learn.microsoft.com/powershell/module/exchange/get-classificationrulecollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-ClassificationRuleCollection schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ClassificationRuleCollection cmdlet to view the classification rule collections in your organization. -In the Microsoft 365 compliance center, use the Get-DlpSensitiveInformationTypeRulePackage cmdlet. +In the Microsoft Purview compliance portal, use the Get-DlpSensitiveInformationTypeRulePackage cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-ClassificationRuleCollection [[-Identity] [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Get-ClientAccessRule cmdlet to view client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +34,7 @@ Get-ClientAccessRule [[-Identity] ] ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -91,7 +94,7 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -129,12 +132,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md b/exchange/exchange-ps/exchange/Get-ClientAccessServer.md index 8cd3a11d74..c3cb98eccc 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessServer.md +++ b/exchange/exchange-ps/exchange/Get-ClientAccessServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-clientaccessserver +online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ClientAccessServer schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Get-ClientAccessServer cmdlet to view settings that are associated with **Note**: In Exchange 2013 or later, use the Get-ClientAccessService cmdlet instead. If you have scripts that use Get-ClientAccessServer, update them to use Get-ClientAccessService. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Get-ClientAccessServer [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -131,12 +131,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ClientAccessService.md b/exchange/exchange-ps/exchange/Get-ClientAccessService.md index 9c186f6b5b..1f3d8c72e4 100644 --- a/exchange/exchange-ps/exchange/Get-ClientAccessService.md +++ b/exchange/exchange-ps/exchange/Get-ClientAccessService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-clientaccessservice +online version: https://learn.microsoft.com/powershell/module/exchange/get-clientaccessservice applicable: Exchange Server 2016, Exchange Server 2019 title: Get-ClientAccessService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ClientAccessService cmdlet to view settings that are associated with the Client Access server role. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-ClientAccessService [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -129,12 +129,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Clutter.md b/exchange/exchange-ps/exchange/Get-Clutter.md index 0c1d1eb974..abd9f70458 100644 --- a/exchange/exchange-ps/exchange/Get-Clutter.md +++ b/exchange/exchange-ps/exchange/Get-Clutter.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.Management-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-clutter +online version: https://learn.microsoft.com/powershell/module/exchange/get-clutter applicable: Exchange Online, Exchange Online Protection title: Get-Clutter schema: 2.0.0 @@ -16,19 +16,18 @@ This cmdlet is available only in the cloud-based service. Use the Get-Clutter cmdlet to view Clutter settings for mailboxes in your organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-Clutter -Identity + [-UseCustomRouting] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,17 +67,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md index af666a0dc6..79f88947ca 100644 --- a/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/exchange/Get-CmdletExtensionAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-cmdletextensionagent +online version: https://learn.microsoft.com/powershell/module/exchange/get-cmdletextensionagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-CmdletExtensionAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-CmdletExtensionAgent cmdlet to view cmdlet extension agents. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ Get-CmdletExtensionAgent [[-Identity] ] ## DESCRIPTION Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and later. Cmdlets provided by other Microsoft or third-party products can't use cmdlet extension agents. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -136,12 +136,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCase.md b/exchange/exchange-ps/exchange/Get-ComplianceCase.md index f6a4287ba3..74d35075bf 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceCase.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancecase -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancecase +applicable: Security & Compliance title: Get-ComplianceCase schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-ComplianceCase ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-ComplianceCase cmdlet to different types of compliance cases in the Microsoft 365 compliance center and Microsoft 365 compliance center. See the CaseType parameter for a list of these case types. +Use the Get-ComplianceCase cmdlet to different types of compliance cases in the Microsoft Purview compliance portal. See the CaseType parameter for a list of these case types. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-ComplianceCase [-Identity] ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -39,21 +39,21 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Get-ComplianceCase ``` -This example returns a summary list of all core eDiscovery cases in the organization. +This example returns a summary list of all eDiscovery Standard cases in the organization. ### Example 2 ```powershell Get-ComplianceCase -Identity "Contoso Legal" | Format-List ``` -This example returns detailed information for the core eDiscovery case named Contoso Legal. +This example returns detailed information for the eDiscovery Standard case named Contoso Legal. ### Example 3 ```powershell Get-ComplianceCase -CaseType AdvancedEdiscovery ``` -This example returns a summary list of all Advanced eDiscovery cases in the organization. +This example returns a summary list of all eDiscovery Premium cases in the organization. ### Example 4 ```powershell @@ -74,7 +74,7 @@ The Identity parameter specifies the compliance case that you want to view. You Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -86,20 +86,21 @@ Accept wildcard characters: False ### -CaseType The CaseType parameter specifies the type of compliance case that you want to view. Valid values are: -- AdvancedEdiscovery: Advanced eDiscovery cases are used to manage legal or other types of investigations. In the Microsoft 365 compliance center, Advanced eDiscovery cases are displayed under **eDiscovery** \> **Advanced eDiscovery**. -- ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft 365 compliance center, trainable classifiers are displayed under **Data classification** \> **Trainable classifiers**. -- ComplianceWorkspace: This value is reserved for internal Microsoft use.- DataInvestigation: Data investigation cases are used to investigate data spillage incidents. In the Microsoft 365 compliance center, Data investigation cases are displayed on the Data investigations page. -- DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. In the Microsoft 365 compliance center, DSR cases are displayed under **Data privacy** \> **Data subject requests**. -- eDiscovery: eDiscovery (also called core eDiscovery) cases are used to manage legal or other types of investigations. In the Microsoft 365 compliance center, core eDiscovery cases are displayed under **eDiscovery** \> **eDiscovery**. This is the default value. -- InsiderRisk: Insider risk cases are use to manage insider risk management cases. In the Microsoft 365 compliance center, insider risk cases are displayed under **Insider risk management** \> **Cases**. Typically, insider risk management cases are manually created in the compliance center to further investigate activity based on an risk alert. +- AdvancedEdiscovery: eDiscovery Premium cases are used to manage legal or other types of investigations. In the Microsoft Purview compliance portal, eDiscovery Premium cases are displayed under **eDiscovery** \> **Premium**. +- ComplianceClassifier: This type of case corresponds to a trainable classifier. In the Microsoft Purview compliance portal, trainable classifiers are displayed under **Data classification** \> **Trainable classifiers**. +- ComplianceWorkspace: This value is reserved for internal Microsoft use. +- DataInvestigation: Data investigation cases are used to investigate data spillage incidents. In the Microsoft Purview compliance portal, Data investigation cases are displayed on the **Data investigations** page. +- DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. In the Microsoft Purview compliance portal, DSR cases are displayed under **Data privacy** \> **Data subject requests**. +- eDiscovery: eDiscovery (also called eDiscovery Standard) cases are used to manage legal or other types of investigations. In the Microsoft Purview compliance portal, eDiscovery Standard cases are displayed under **eDiscovery** \> **Standard**. This is the default value. +- InsiderRisk: Insider risk cases are used to manage insider risk management cases. In the Microsoft Purview compliance portal, insider risk cases are displayed under **Insider risk management** \> **Cases**. Typically, insider risk management cases are manually created in the Microsoft Purview compliance portal to further investigate activity based on a risk alert. - InternalInvestigation: This value is reserved for internal Microsoft use. -- SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft 365 Compliance center, communication compliance policies are displayed under **Communication compliance** \> **Policies**. +- SupervisionPolicy: This type of case corresponds to communication compliance policy. In the Microsoft Purview compliance portal, communication compliance policies are displayed under **Communication compliance** \> **Policies**. ```yaml Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,7 +116,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -125,13 +126,15 @@ Accept wildcard characters: False ``` ### -RecentOnly -The RecentOnly switch returns a list of the most recently modified cases of the specified case type. This switch is used to display data in the "Recently cases" widget that's displayed in the compliance centers for some of the features that use compliance case objects. +The RecentOnly switch returns a list of the most recently modified cases of the specified case type. You don't need to specify a value with this switch. + +This switch is used to display data in the "Recent cases" widget in the Microsoft Purview compliance portal for some features that use compliance case objects. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -141,13 +144,13 @@ Accept wildcard characters: False ``` ### -RoleGroup -The RoleGroup parameter returns a list of compliance cases that the specified role group is a member of. If you don't include the CaseType parameter, the cmdlet returns a list of core eDiscovery cases that the role group is a member of. +The RoleGroup parameter returns a list of compliance cases that the specified role group is a member of. If you don't include the CaseType parameter, the cmdlet returns a list of eDiscovery Standard cases that the role group is a member of. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -161,12 +164,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md index 114dd0fe59..5588971c20 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceCaseMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancecasemember -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancecasemember +applicable: Security & Compliance title: Get-ComplianceCaseMember schema: 2.0.0 author: chrisda @@ -12,14 +12,15 @@ ms.reviewer: # Get-ComplianceCaseMember ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-ComplianceCaseMember cmdlet to view the members of eDiscovery cases in the Microsoft 365 compliance center. +Use the Get-ComplianceCaseMember cmdlet to view the members of eDiscovery cases in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Identity ``` Get-ComplianceCaseMember -Case [-DomainController ] @@ -28,8 +29,16 @@ Get-ComplianceCaseMember -Case [] ``` +### AllCases +``` +Get-ComplianceCaseMember + [-DomainController ] + [-ResultSize ] + [] +``` + ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -47,9 +56,9 @@ The Case parameter specifies the name of the eDiscovery case that you want to vi ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -65,7 +74,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -81,7 +90,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,9 +104,9 @@ The ShowCaseAdmin switch specifies whether to return the eDiscovery case admin i ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -111,12 +120,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md index eec0052e7a..4688db4274 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEvent.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEvent -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentionevent +applicable: Security & Compliance title: Get-ComplianceRetentionEvent schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-ComplianceRetentionEvent ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-ComplianceRetentionEvent cmdlet to view compliance retention events in the Microsoft 365 compliance center. +Use the Get-ComplianceRetentionEvent cmdlet to view compliance retention events in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-ComplianceRetentionEvent [-Identity ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,7 +61,7 @@ The Identity parameter specifies the compliance retention event that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -77,7 +77,7 @@ Accept wildcard characters: False Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -93,7 +93,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -109,7 +109,7 @@ Accept wildcard characters: False Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -125,7 +125,7 @@ Accept wildcard characters: False Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -139,12 +139,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md index 50b01e4f84..413b3c7aa3 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceRetentionEventType.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Get-ComplianceRetentionEventType -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-complianceretentioneventtype +applicable: Security & Compliance title: Get-ComplianceRetentionEventType schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-ComplianceRetentionEventType ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-ComplianceRetentionEventType cmdlet to view retention event types in the Microsoft 365 compliance center. +Use the Get-ComplianceRetentionEventType cmdlet to view retention event types in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-ComplianceRetentionEventType [-Identity ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +58,7 @@ The Identity parameter specifies the retention event type that you want to view. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -76,7 +76,7 @@ If you don't use this switch, the ComplianceTag property will always appear empt Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -90,12 +90,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md index 8ae4bdd00b..95ca1983f2 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesearch +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Get-ComplianceSearch schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Get-ComplianceSearch cmdlet to view estimate compliance searches in Exchange Server 2016 or later and in the Microsoft 365 compliance center. After you use the New-ComplianceSearchAction cmdlet to define a preview action for the compliance search, use the Get-ComplianceSearchAction cmdlet to view the results of the compliance search. +Use the Get-ComplianceSearch cmdlet to view estimate compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. After you use the New-ComplianceSearchAction cmdlet to define a preview action for the compliance search, use the Get-ComplianceSearchAction cmdlet to view the results of the compliance search. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,11 +29,11 @@ Get-ComplianceSearch [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -75,11 +75,13 @@ To improve the performance of this cmdlet, some compliance search properties are To view these properties, you need to use the Identity parameter in the command. +**Note**: The NumBindings property includes the primary mailbox, the main archive, and any additional archives for users included in the search. NumBindings is not the number of users included in the search, because each included user could have or not have a combination of a primary mailbox, a main archive, and additional archives. + ```yaml Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: 1 @@ -91,15 +93,15 @@ Accept wildcard characters: False ### -Case This parameter is available only in the cloud-based service. -The Case parameter filters the results by the name of a Core eDiscovery case that the compliance search is associated with. If the value contains spaces, enclose the value in quotation marks. +The Case parameter filters the results by the name of an eDiscovery Standard case that the compliance search is associated with. If the value contains spaces, enclose the value in quotation marks. -You can't use this parameter to view compliance searches associated with Advanced eDiscovery cases. +You can't use this parameter to view compliance searches associated with eDiscovery Premium cases. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -133,7 +135,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -147,12 +149,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md index 9937fd2c34..a0ca0a62b5 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancesearchaction -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesearchaction +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Get-ComplianceSearchAction schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ComplianceSearchAction cmdlet to view information about compliance search actions. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,6 +27,7 @@ Get-ComplianceSearchAction [[-Identity] ] [-Details] [-DomainController ] [-IncludeCredential] + [-Organization ] [-ResultSize ] [] ``` @@ -38,6 +39,7 @@ Get-ComplianceSearchAction [-Preview] [-Details] [-DomainController ] [-IncludeCredential] + [-Organization ] [-ResultSize ] [] ``` @@ -49,6 +51,7 @@ Get-ComplianceSearchAction [-Purge] [-Details] [-DomainController ] [-IncludeCredential] + [-Organization ] [-ResultSize ] [] ``` @@ -60,6 +63,7 @@ Get-ComplianceSearchAction [-Export] [-Details] [-DomainController ] [-IncludeCredential] + [-Organization ] [-ResultSize ] [] ``` @@ -67,11 +71,11 @@ Get-ComplianceSearchAction [-Export] ## DESCRIPTION After you create and run a compliance search using the New-ComplianceSearch cmdlet, and start the search using the Start-ComplianceSearch cmdlet, you assign a search action using the New-ComplianceSearchAction cmdlet. You use the Get-ComplianceSearchAction cmdlet to track the progress of the compliance search action. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -84,17 +88,17 @@ This example shows a summary list of all compliance search actions. ### Example 2 ```powershell -Get-ComplianceSearchAction -Identity "Case 1234\_Preview" | Format-List +Get-ComplianceSearchAction -Identity "Case 1234_Preview" | Format-List ``` -This example shows details about the compliance search action named "Case 1234\_Preview" +This example shows details about the compliance search action named "Case 1234_Preview" ## PARAMETERS ### -Identity The Identity parameter specifies the compliance search action that you want to view. You can use any value that uniquely identifies the compliance search action. For example: -- Name: The compliance search action name uses the syntax `"Compliance Search Name\_Action"`. For example, `"Case 1234\_Preview"`. +- Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"`. For example, `"Case 1234_Preview"`. - JobRunId (GUID) You can't use this parameter with the Export, Preview, or Purge parameters. @@ -103,7 +107,7 @@ When you use the Identity parameter, more details are returned in the results. F - In the Results line, the values of the Item count, Total size, and Details properties are populated. - Location lines are added to the results. -- The NumBinding property value is populated. +- The NumBindings property value is populated. This property includes the primary mailbox, the main archive, and any additional archives for users included in the search. NumBindings is not the number of users included in the search, because each included user could have or not have a combination of a primary mailbox, a main archive, and additional archives. - The affected location properties (for example, ExchangeLocation) are populated. - The CaseName property value is populated. @@ -111,7 +115,7 @@ When you use the Identity parameter, more details are returned in the results. F Type: ComplianceSearchActionIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: 1 @@ -129,7 +133,7 @@ The Case parameter filters the results by the name of the specified case. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -145,7 +149,7 @@ The Details switch specifies whether to include detailed information in the resu Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -155,7 +159,7 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -163,7 +167,7 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -173,6 +177,8 @@ Accept wildcard characters: False ``` ### -Export +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + The Export switch filters the results by Export compliance search actions. You don't need to specify a value with this switch. You can't use this switch with the Identity, Preview, or Purge parameters. @@ -181,7 +187,7 @@ You can't use this switch with the Identity, Preview, or Purge parameters. Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -197,7 +203,25 @@ The IncludeCredential switch specifies whether to include the credential in the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -207,7 +231,7 @@ Accept wildcard characters: False ``` ### -Preview -The Preview switch filters the results by Preview compliance search actions. +The Preview switch filters the results by Preview compliance search actions. You don't need to specify a value with this switch. You can't use this switch with the Export, Identity, or Purge parameters. @@ -215,7 +239,7 @@ You can't use this switch with the Export, Identity, or Purge parameters. Type: SwitchParameter Parameter Sets: Preview Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -225,9 +249,9 @@ Accept wildcard characters: False ``` ### -Purge -**Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management role group. +**Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. -The Purge switch filters the results by Purge compliance search actions. +The Purge switch filters the results by Purge compliance search actions. You don't need to specify a value with this switch. You can't use this switch with the Export, Identity, or Preview parameters. @@ -235,7 +259,7 @@ You can't use this switch with the Export, Identity, or Preview parameters. Type: SwitchParameter Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -251,7 +275,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -265,12 +289,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md index 779fbcb229..0c3ff1f88a 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceSecurityFilter.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancesecurityfilter -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancesecurityfilter +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Get-ComplianceSecurityFilter schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-ComplianceSecurityFilter ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-ComplianceSecurityFilter cmdlet to view compliance security filters in the Microsoft 365 compliance center. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Microsoft 365 organization. +Use the Get-ComplianceSecurityFilter cmdlet to view compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint or OneDrive sites in your Microsoft 365 organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Get-ComplianceSecurityFilter [-Action ] ``` ## DESCRIPTION -Compliance security filters work with compliance searches in the Microsoft 365 compliance center (\*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (\*-MailboxSearch cmdlets). +Compliance security filters work with compliance searches in the Microsoft Purview compliance portal (\*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (\*-MailboxSearch cmdlets). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -55,17 +55,17 @@ This example returns detailed information about the compliance security filter n ### -Action The Action parameter filters the results by the type of search action that a filter is applied to. Valid values are: -- All -- Export -- Preview -- Purge -- Search +- Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. +- Preview: The filter is applied when previewing search results. +- Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. +- Search: The filter is applied when running a search. +- All: The filter is applied to all search actions. ```yaml Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -84,7 +84,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -100,7 +100,7 @@ The FilterName parameter specifies the name of the compliance security filter th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -120,7 +120,7 @@ The User parameter filters the results by the user who gets a filter applied to Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -130,13 +130,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -150,12 +150,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceTag.md b/exchange/exchange-ps/exchange/Get-ComplianceTag.md index 415b9c7735..2c704b8488 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceTag.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancetag -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancetag +applicable: Exchange Online, Security & Compliance title: Get-ComplianceTag schema: 2.0.0 author: chrisda @@ -12,24 +12,23 @@ ms.reviewer: # Get-ComplianceTag ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-ComplianceTag cmdlet to view retention labels in the Microsoft 365 compliance center. Retention labels apply retention settings to content. +Use the Get-ComplianceTag cmdlet to view retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-ComplianceTag [[-Identity] ] [-IncludingLabelState] + [-PriorityCleanup] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -60,7 +59,7 @@ The Identity parameter specifies the label that you want to view. You can use an Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -76,7 +75,23 @@ Accept wildcard characters: False Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -90,12 +105,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md b/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md index 44fc9749bb..c3aa8eaca3 100644 --- a/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md +++ b/exchange/exchange-ps/exchange/Get-ComplianceTagStorage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compliancetagstorage -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-compliancetagstorage +applicable: Exchange Online, Security & Compliance title: Get-ComplianceTagStorage schema: 2.0.0 author: chrisda @@ -12,23 +12,22 @@ ms.reviewer: # Get-ComplianceTagStorage ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-ComplianceTagStorage cmdlet to confirm that you've created the retention label policy by using the Enable-ComplianceTagStorage cmdlet. Retention labels apply retention settings to content. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-ComplianceTagStorage [[-Identity] ] + [-Organization ] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -54,7 +53,7 @@ However, there can be only one label policy in your organization. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -63,17 +62,29 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md b/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md index 52624e110a..d26e9e5e0d 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-CompromisedUserAggregateReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compromiseduseraggregatereport +online version: https://learn.microsoft.com/powershell/module/exchange/get-compromiseduseraggregatereport applicable: Exchange Online, Exchange Online Protection title: Get-CompromisedUserAggregateReport schema: 2.0.0 @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-CompromisedUserAggregateReport cmdlet to return general data about compromised users for the last 90 days. +Use the Get-CompromisedUserAggregateReport cmdlet to return general data about compromised users for the last 10 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +37,7 @@ This cmdlet returns the following information: - UserCount - Action -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,7 +74,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. ```yaml Type: System.DateTime @@ -126,7 +124,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. ```yaml Type: System.DateTime @@ -146,12 +144,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md b/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md index c709533f0c..07d5d63148 100644 --- a/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-CompromisedUserDetailReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-compromiseduserdetailreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-compromiseduserdetailreport applicable: Exchange Online, Exchange Online Protection title: Get-CompromisedUserDetailReport schema: 2.0.0 @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-CompromisedUserDetailReport cmdlet to return detailed information about compromised users for the last 30 days. +Use the Get-CompromisedUserDetailReport cmdlet to return detailed information about compromised users for the last 10 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,13 +37,13 @@ This cmdlet returns the following information: - UserCount - Action -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-MailFlowStatusReport -StartDate 06-01-2020 -EndDate 06-10-2020 -Action Suspicious +Get-CompromisedUserDetailReport -StartDate 06-01-2020 -EndDate 06-10-2020 -Action Suspicious ``` This example returns all suspicious user accounts for the specified date range. @@ -76,7 +74,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. ```yaml Type: System.DateTime @@ -126,9 +124,9 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. -A value for this parameter can´t be older than 30 days. +A value for this parameter can't be older than 30 days. ```yaml Type: System.DateTime @@ -148,12 +146,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md new file mode 100644 index 0000000000..ff118bc38d --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ConfigAnalyzerPolicyRecommendation.md @@ -0,0 +1,126 @@ +--- +external help file: Microsoft.Exchange.TransportMailControl-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-configanalyzerpolicyrecommendation +applicable: Exchange Online +title: Get-ConfigAnalyzerPolicyRecommendation +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ConfigAnalyzerPolicyRecommendation + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ConfigAnalyzerPolicyRecommendation cmdlet to compare the settings in your existing security policies to the settings that are used in the Standard or Strict preset security policies. Settings that are below the recommend value are returned in the results. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ConfigAnalyzerPolicyRecommendation -RecommendedPolicyType + [[-Identity] ] + [-IsAppliedToDisabled] + [] +``` + +## DESCRIPTION +For information about the policies and their recommended Standard and Strict values, see [Recommended settings for EOP and Microsoft Defender for Office 365 security](https://learn.microsoft.com/defender-office-365/recommended-settings-for-eop-and-office365). + +The output of this cmdlet only returns settings that fall below the value that you've specified as a baseline (Standard or Strict). + +The output contains the following information for each setting: + +- PolicyGroup: The type of policy. The value will be Anti-Spam, Anti-Phishing, Anti-Malware, ATP Safe Links, or ATP Safe Attachments +- SettingName: The name of the setting in the policy. +- SettingNameDescription: A description of the setting. +- Policy: The name of the policy. +- AppliedTo: The number of users or domains that the policy applies to. If the policy isn't applied to anyone (for example, it's disabled), this value will be blank. +- CurrentConfiguration: The current value of the setting. +- LastModified: When the policy was last modified. +- Recommendation: The recommended Standard or Strict value for the setting. +- SettingType: For example, Boolean, String, or Integer. + +If a setting is configured at or better than the Standard or Strict protection profile that you're comparing to, those settings/policies aren't returned in the results + +This cmdlet returns the following output for each setting in each policy that falls below the recommended value. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ConfigAnalyzerPolicyRecommendation -RecommendedPolicyType Strict +``` + +This example runs a comparison using the Strict preset security policy settings as a baseline. + +## PARAMETERS + +### -Identity +This parameter is reserved for internal Microsoft use. + +```yaml +Type: ConfigAnalyzerPolicyRecommendationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RecommendedPolicyType +The RecommendedPolicyType parameter specifies the preset security policy that you want to use as a baseline. Valid values are: + +- Standard +- Strict + +```yaml +Type: RecommendedPolicyType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsAppliedToDisabled +The IsAppliedToDisabled switch filters the results by policies that aren't applied to anyone (the AppliedTo property is blank). You don't need to specify a value with this switch. + +If you don't use this switch, the results include policies that are applied to users and policies that aren't applied to anyone. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeDetailReport.md b/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeDetailReport.md deleted file mode 100644 index 4c653786ec..0000000000 --- a/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeDetailReport.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-connectionbyclienttypedetailreport -applicable: Exchange Online -title: Get-ConnectionByClientTypeDetailReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-ConnectionByClientTypeDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-ConnectionByClientTypeDetailReport cmdlet to view details about the different types of clients that connected to mailboxes in your organization. The client types indicate different protocols, for example, Outlook on the web, MAPI, POP3, IMAP4, Exchange ActiveSync, and Exchange Web Services. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-ConnectionByClientTypeDetailReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-ConnectionByClientTypeDetailReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves details about the different types of clients used to connect to mailboxes between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.md b/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.md deleted file mode 100644 index 28d7bba3bf..0000000000 --- a/exchange/exchange-ps/exchange/Get-ConnectionByClientTypeReport.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-connectionbyclienttypereport -applicable: Exchange Online -title: Get-ConnectionByClientTypeReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-ConnectionByClientTypeReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-ConnectionByClientTypeReport cmdlet to view a summary of the different types of clients that connected to all mailboxes in your organization. The client types indicate different protocols, for example, Outlook on the web, MAPI, POP3, IMAP4, Exchange ActiveSync, and Exchange Web Services. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-ConnectionByClientTypeReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -**Note**: There's a 7-day lag in the client connection information that's returned by this cmdlet. For example, if you run the cmdlet on June 18, 2018, you can't retrieve information about connections made to mailboxes between June 13, 2018 and June 15, 2018. To get connection information for that date range, you need to run the cmdlet on June 22, 2018 or later. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-ConnectionByClientTypeReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves a summary of the different types of clients used to connect to all mailboxes between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ConnectionInformation.md b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md new file mode 100644 index 0000000000..97f9d3efd2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ConnectionInformation.md @@ -0,0 +1,140 @@ +--- +external help file: Microsoft.Exchange.Management.ExoPowershellGalleryModule.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-connectioninformation +applicable: Exchange Online +title: Get-ConnectionInformation +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ConnectionInformation + +## SYNOPSIS +This cmdlet is available in the Exchange Online PowerShell module v3.0.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-ConnectionInformation cmdlet to get information about all REST-based connections in the current PowerShell instance with Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default (Default) +``` +Get-ConnectionInformation [] +``` + +### ConnectionId +``` +Get-ConnectionInformation -ConnectionId [] +``` + +### ModulePrefix +``` +Get-ConnectionInformation -ModulePrefix [] +``` + +## DESCRIPTION +The Get-ConnectionInformation cmdlet returns the information about all active REST-based connections with Exchange Online in the current PowerShell instance. This cmdlet is equivalent to the Get-PSSession cmdlet that's used with remote PowerShell sessions. + +The output of the cmdlet contains the following properties: + +- ConnectionId: A unique GUID value for the connection. For example, 8b632b3a-a2e2-8ff3-adcd-6d119d07694b. +- State: For example, Connected. +- Id: An integer that identifies the session in the PowerShell window. The first connection is 1, the second is 2, etc. +- Name: A unique name that's based on the PowerShell environment and Id value. For example, ExchangeOnline_1 for Exchange Online PowerShell or ExchangeOnlineProtection_1 for Security & Compliance PowerShell. +- UserPrincipalName: The account that was used to connect. For example, `laura@contoso.onmicrosoft.com`. +- ConnectionUri: The connection endpoint that was used. For example, `https://outlook.office365.com` for Exchange Online PowerShell or `https://nam12b.ps.compliance.protection.outlook.com` for Security & Compliance PowerShell. +- AzureAdAuthorizationEndpointUri : The Microsoft Entra authorization endpoint for the connection. For example, `https://login.microsoftonline.com/organizations` for Exchange Online PowerShell or `https://login.microsoftonline.com/organizations` for Security & Compliance PowerShell. +- TokenExpiryTimeUTC: When the connection token expires. For example, 9/30/2023 6:42:24 PM +00:00. +- CertificateAuthentication: Whether certificate based authentication (also known as CBA or app-only authentication) was used to connect. Values are True or False. +- ModuleName: The filename and path of the temporary data for the session. For example, C:\Users\laura\AppData\Local\Temp\tmpEXO_a54z135k.qgv +- ModulePrefix: The value specified using the Prefix parameter in the Connect-ExchangeOnline or Connect-IPPSSession command. +- Organization: The value specified using the Organization parameter in the Connect-ExchangeOnline or Connect-IPPSSession command for CBA or managed identity connections. +- DelegatedOrganization: The value specified using the DelegatedOrganization parameter in the Connect-ExchangeOnline or Connect-IPPSSession command. +- AppId: The value specified using the AppId parameter in the Connect-ExchangeOnline or Connect-IPPSSession command for CBA connections. +- PageSize: The default maximum number of entries per page in the connection. The default value is 1000, or you can use the PageSize parameter in the Connect-ExchangeOnline command to specify a lower number. Individual cmdlets might also have a PageSize parameter. +- TenantID: The tenant ID GUID value. For example, 3750b40b-a68b-4632-9fb3-5b1aff664079. +- TokenStatus: For example, Active. +- ConnectionUsedForInbuiltCmdlets +- IsEopSession: For Exchange Online PowerShell connections, the value is False. For Security & Compliance PowerShell connections, the value is True. + +## EXAMPLES + +### Example 1 +```powershell +Get-ConnectionInformation +``` + +This example returns a list of all active REST-based connections with Exchange Online in the current PowerShell instance. + +### Example 2 +```powershell +Get-ConnectionInformation -ConnectionId 1a9e45e8-e7ec-498f-9ac3-0504e987fa85 +``` + +This example returns the active REST-based connection with the specified ConnectionId value. + +### Example 3 +```powershell +Get-ConnectionInformation -ModulePrefix Contoso,Fabrikam +``` + +This example returns a list of active REST-based connections that are using the specified prefix values. + +## PARAMETERS + +### -ConnectionId +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The ConnectionId parameter filters the connections by ConnectionId. ConnectionId is a GUID value in the output of the Get-ConnectionInformation cmdlet that uniquely identifies a connection, even if you have multiple connections open. You can specify multiple ConnectionId values separated by commas. + +Don't use this parameter with the ModulePrefix parameter. + +```yaml +Type: String[] +Parameter Sets: ConnectionId +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModulePrefix +**Note**: This parameter is available in version 3.2.0 or later of the module. + +The ModulePrefix parameter filters the connections by ModulePrefix. When you use the Prefix parameter with the Connect-ExchangeOnline cmdlet, the specified text is added to the names of all Exchange Online cmdlets (for example, Get-InboundConnector becomes Get-ContosoInboundConnector). The ModulePrefix value is visible in the output of the Get-ConnectionInformation cmdlet. You can specify multiple ModulePrefix values separated by commas. + +This parameter is meaningful only for connections that were created with the Prefix parameter. + +Don't use this parameter with the ConnectionId parameter. + +```yaml +Type: String[] +Parameter Sets: ModulePrefix +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Contact.md b/exchange/exchange-ps/exchange/Get-Contact.md index 54a63a0915..389fa44712 100644 --- a/exchange/exchange-ps/exchange/Get-Contact.md +++ b/exchange/exchange-ps/exchange/Get-Contact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-contact +online version: https://learn.microsoft.com/powershell/module/exchange/get-contact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-Contact schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-Contact cmdlet to view existing contact objects in your organization. This cmdlet returns contacts and mail contacts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -51,7 +51,7 @@ Get-Contact [[-Identity] ] ## DESCRIPTION The Get-Contact cmdlet returns no mail-related properties for mail contacts. Use the Get-MailContact to view mail-related properties for mail contacts. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,6 +78,27 @@ This example uses the Anr parameter to retrieve all mail-enabled contacts whose ## PARAMETERS +### -Identity +The Identity parameter specifies the contact that you want to view. You can use any value that uniquely identifies the contact. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: ContactIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -105,7 +126,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -139,16 +160,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -163,33 +184,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the contact that you want to view. You can use any value that uniquely identifies the contact. For example: - -- Name -- Distinguished name (DN) -- Canonical DN -- GUID - -```yaml -Type: ContactIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -231,7 +231,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -318,12 +320,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md b/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md index 0850a3646e..8de0cb720d 100644 --- a/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md +++ b/exchange/exchange-ps/exchange/Get-ContentFilterConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-contentfilterconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-contentfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ContentFilterConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ContentFilterConfig cmdlet to view the content filter configuration for the computer on which the cmdlet is run. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-ContentFilterConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,12 +62,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md index 720b8e5fa1..1b1f47b29b 100644 --- a/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md +++ b/exchange/exchange-ps/exchange/Get-ContentFilterPhrase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-contentfilterphrase +online version: https://learn.microsoft.com/powershell/module/exchange/get-contentfilterphrase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ContentFilterPhrase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ContentFilterPhrase cmdlet to view one or all custom words that the Content Filter agent processes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Get-ContentFilterPhrase [-Phrase ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,39 +62,39 @@ This example returns all custom words and phrases that contain the words free of ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies a custom word or phrase to display. You must enclose the value of the Identity parameter in quotation marks ("). -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +The Identity and Phrase parameters are interchangeable. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: ContentFilterPhraseIdParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies a custom word or phrase to display. You must enclose the value of the Identity parameter in quotation marks ("). +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -The Identity and Phrase parameters are interchangeable. +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: ContentFilterPhraseIdParameter -Parameter Sets: Identity +Type: Fqdn +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -121,12 +121,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md new file mode 100644 index 0000000000..2c884d0e2f --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoAggregateReport.md @@ -0,0 +1,178 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdoaggregatereport +applicable: Exchange Online +title: Get-ContentMalwareMdoAggregateReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ContentMalwareMdoAggregateReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ContentMalwareMdoAggregateReport cmdlet to view a summary detections by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in Microsoft Defender for Office 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ContentMalwareMdoAggregateReport + [-DetectionTechnology ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [-Workload ] + [] +``` + +## DESCRIPTION +For the specified reporting period, the cmdlet returns the following information: + +- Date +- Detection Technology +- Workload +- Count + +By default, the command returns data for the last 14 days. Data for the last 90 days is available. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ContentMalwareMdoAggregateReport -StartDate 1/1/2022 -EndDate 1/4/2022 -Workload OneDriveForBusiness +``` + +This example returns the results for OneDrive detections for the specified date range. + +## PARAMETERS + +### -DetectionTechnology +The DetectionTechnology parameter filters the results by what classified the file as malware. Valid values are: + +- AntiMalware +- AtpSafeAttachment +- Reputation + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The EndDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload +The Workload parameter filters the results by where the detected file is located. Valid values are: + +- OneDriveForBusiness +- SharePoint +- Teams + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md new file mode 100644 index 0000000000..eb99b53c05 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ContentMalwareMdoDetailReport.md @@ -0,0 +1,180 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-contentmalwaremdodetailreport +applicable: Exchange Online +title: Get-ContentMalwareMdoDetailReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ContentMalwareMdoDetailReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the ContentMalwareMdoDetailReport cmdlet to view detection details by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams in Microsoft Defender for Office 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ContentMalwareMdoDetailReport + [-DetectionTechnology ] + [-EndDate ] + [-Page ] + [-PageSize ] + [-StartDate ] + [-Workload ] + [] +``` + +## DESCRIPTION +For the specified reporting period, the cmdlet returns the following information: + +- Date +- File Name +- Workload +- Detection Technology +- File Size +- Last modifying user + +By default, the command returns data for the last 14 days. Data for the last 30 days is available. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ContentMalwareMdoDetailReport -StartDate 1/1/2022 -EndDate 1/4/2022 -DetectionTechnology AtpSafeAttachment +``` + +This example returns the results for detections by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams for the specified date range. + +## PARAMETERS + +### -DetectionTechnology +The DetectionTechnology parameter filters the results by what classified the file as malware. Valid values are: + +- AntiMalware +- AtpSafeAttachment +- Reputation + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The EndDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2021 to specify September 1, 2021. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Workload +The Workload parameter filters the results by where the detected file is located. Valid values are: + +- OneDriveForBusiness +- SharePoint +- Teams + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsAVConferenceTimeReport.md b/exchange/exchange-ps/exchange/Get-CsAVConferenceTimeReport.md deleted file mode 100644 index 1d14d2b5e6..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsAVConferenceTimeReport.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csavconferencetimereport -applicable: Exchange Online -title: Get-CsAVConferenceTimeReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsAVConferenceTimeReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsAVConferenceTimeReport cmdlet to view statistics about the time in minutes that was used during audio and video conferences that were held by Skype for Business Online users in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsAVConferenceTimeReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You can use the Get-CsAVConferenceTimeReport to query information about the length of audio and video conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- AVConferenceMinutes - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsAVConferenceTimeReport -ReportType Monthly -StartDate 06/01/2015 -EndDate 06/30/2015 -``` - -This example shows the time in minutes that was used during all audio and video conferences that were held by Skype for Business Online users for the month of June 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsActiveUserReport.md b/exchange/exchange-ps/exchange/Get-CsActiveUserReport.md deleted file mode 100644 index 1e4dbf6157..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsActiveUserReport.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csactiveuserreport -applicable: Exchange Online -title: Get-CsActiveUserReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsActiveUserReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsActiveUserReport cmdlet to view statistics about Skype for Business Online users in your cloud-based organization. The cmdlet shows the total number of unique users that signed in and took part in at least one peer-to-peer session or conference during the specified time period. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsActiveUserReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You can use the Get-CsActiveUserReport to query information about the activities of Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- ActiveUsers -- ActiveIMUsers -- ActiveAudioUsers -- ActiveVideoUsers -- ActiveApplicationSharingUsers -- ActiveFileTransferUsers -- ActivePSTNConferencingUsers - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsActiveUserReport -ReportType Monthly -StartDate 04/01/2015 -EndDate 04/30/2015 -``` - -This example shows information about Skype for Business Online users for the month of April, 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsClientDeviceDetailReport.md b/exchange/exchange-ps/exchange/Get-CsClientDeviceDetailReport.md deleted file mode 100644 index e92816b3d6..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsClientDeviceDetailReport.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csclientdevicedetailreport -applicable: Exchange Online -title: Get-CsClientDeviceDetailReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsClientDeviceDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsClientDeviceDetailReport cmdlet to view statistics about the number of peer-to-peer sessions and conferences by users and devices that connected to Skype for Business Online in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsClientDeviceDetailReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [-UserName ] - [] -``` - -## DESCRIPTION -The Get-CsClientDeviceDetailReport cmdlet returns the number of peer-to-peer sessions and conferences that a user participated in, and a count of what type of device they used. You can query this information for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- UserName -- WindowsActivities: Note that this includes activity using both Skype for Business and Skype for Business Web App clients. -- WindowsPhoneActivities -- AndroidActivities -- iPhoneActivities -- iPadActivities - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsClientDeviceDetailReport -StartDate 01/01/2015 -EndDate 01/31/2015 -``` - -This example shows activity by device for all users for the month of January. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -The UserName parameter filters the results by user. You identify the user by their account (for example, laura@contoso.com). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsClientDeviceReport.md b/exchange/exchange-ps/exchange/Get-CsClientDeviceReport.md deleted file mode 100644 index 2b7450deaa..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsClientDeviceReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csclientdevicereport -applicable: Exchange Online -title: Get-CsClientDeviceReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsClientDeviceReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsClientDeviceReport cmdlet to view statistics about the client devices that connected to Skype for Business Online in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsClientDeviceReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -The Get-CsClientDeviceReport cmdlet returns the monthly total of unique users that connected to the Skype for Business Online service using different types of client devices. For the reporting period you specify, the cmdlet returns the following information: - -- WindowsUsers -- WindowsPhoneUsers -- AndroidUsers -- iPhoneUsers -- iPadUsers - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get- CsClientDeviceReport -StartDate 10/01/2015 -EndDate 10/31/2015 -``` - -This example gets a report of the device usage by platform for the month of October. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsConferenceReport.md b/exchange/exchange-ps/exchange/Get-CsConferenceReport.md deleted file mode 100644 index f94d43c1a5..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsConferenceReport.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csconferencereport -applicable: Exchange Online -title: Get-CsConferenceReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsConferenceReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsConferenceReport cmdlet to view statistics about the conferences that were held by Skype for Business Online users in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsConferenceReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You can use the Get-CsConferenceReport to query information about the type and number of conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- TotalConferences -- AVConferences -- IMConferences -- ApplicationSharingConferences -- WebConferences -- TelephonyConferences -- PSTNConferences - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsConferenceReport -ReportType Monthly -StartDate 06/01/2015 -EndDate 06/30/2015 -``` - -This example shows information about conferences held by Skype for Business Online users for the month of June 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsP2PAVTimeReport.md b/exchange/exchange-ps/exchange/Get-CsP2PAVTimeReport.md deleted file mode 100644 index 914507aece..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsP2PAVTimeReport.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csp2pavtimereport -applicable: Exchange Online -title: Get-CsP2PAVTimeReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsP2PAVTimeReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsP2PAVTimeReport cmdlet to view statistics about the audio and video time in minutes that was used during peer-to-peer (P2P) sessions that were held by Skype for Business Online users in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsP2PAVTimeReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You can use the Get-CsP2PAVTimeReport to query information about the length of audio and video conferences held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- TotalAudioMinutes -- TotalVideoMinutes - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsP2PAVTimeReport -ReportType Monthly -StartDate 06/01/2015 -EndDate 06/30/2015 -``` - -This example shows information about the number of audio and video minutes used during P2P sessions that were held by Skype for Business Online users for the month of June 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsP2PSessionReport.md b/exchange/exchange-ps/exchange/Get-CsP2PSessionReport.md deleted file mode 100644 index 492c435deb..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsP2PSessionReport.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csp2psessionreport -applicable: Exchange Online -title: Get-CsP2PSessionReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsP2PSessionReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsP2PSessionReport cmdlet to view statistics about the peer-to-peer (P2P) sessions held by Skype for Business Online users in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsP2PSessionReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You can use the Get-CsP2PSessionReport to query information about the number and type of P2P sessions held by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- TotalP2PSessions -- P2PIMSessions -- P2PAudioSessions -- P2PVideoSessions -- P2PApplicationSharingSessions -- P2PFileTransferSessions - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsP2PSessionReport -ReportType Monthly -StartDate 06/01/2015 -EndDate 06/30/2015 -``` - -This example shows information about the P2P sessions used by Skype for Business Online users for the month of June 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsPSTNConferenceTimeReport.md b/exchange/exchange-ps/exchange/Get-CsPSTNConferenceTimeReport.md deleted file mode 100644 index c81aa39839..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsPSTNConferenceTimeReport.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-cspstnconferencetimereport -applicable: Exchange Online -title: Get-CsPSTNConferenceTimeReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsPSTNConferenceTimeReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsPSTNConferenceTimeReport cmdlet to show the number of minutes that Skype for Business Online users spent in dial-in or dial-out conferences. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsPSTNConferenceTimeReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You can use the Get-CsPSTNUsageDetailReport to query information about length of time spent in dial-in and dial-out conferences by Skype for Business Online users in the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- PSTNConferenceDialInMinutes -- PSTNConferenceDialOutMinutes - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsPSTNConferenceTimeReport -ReportType Monthly 11/01/2015 -EndDate 12/30/2015 -``` - -This example shows the number of minutes per month that users spent in PSTN conferences for the months of November and December. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md b/exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md deleted file mode 100644 index 474330a827..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsPSTNUsageDetailReport.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-cspstnusagedetailreport -applicable: Exchange Online -title: Get-CsPSTNUsageDetailReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsPSTNUsageDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsPSTNUsageDetailReport cmdlet to view public switched telephone network (PSTN) usage details for Skype for Business Online users. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsPSTNUsageDetailReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You can use the Get-CsPSTNUsageDetailReport to query information about PSTN usage details in Skype for Business Online for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- SipUri -- DateTimeOfCall -- TelephoneNumber -- CallID -- CallType -- Location -- CallDuration -- Currency -- CallCharge - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsPSTNUsageDetailReport -StartDate 11/01/2015 -EndDate 12/30/2015 -``` - -This example shows the PSTN usage detail for users in November and December. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsUserActivitiesReport.md b/exchange/exchange-ps/exchange/Get-CsUserActivitiesReport.md deleted file mode 100644 index 30e23f1fc9..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsUserActivitiesReport.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csuseractivitiesreport -applicable: Exchange Online -title: Get-CsUserActivitiesReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsUserActivitiesReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsUserActivitiesReport cmdlet to view number and type of activities that a use participated in while connected to Skype for Business Online in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsUserActivitiesReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [-UserName ] - [] -``` - -## DESCRIPTION -You can use the Get-CsUserActivitiesReport to query information about activities in Skype for Business Online by all users or a specified user for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- UserName -- LastLogonTime -- LastActivityTime -- TotalP2PSessions -- TotalP2PIMSessions -- TotalP2PAudioSessions -- TotalP2PVideoSessions -- TotalP2PApplicationSharingSessions -- TotalP2PAudioSessionMinutes -- TotalP2PVideoSessionMinutes -- TotalOrganizedConferences -- TotalOrganizedIMConferences -- TotalOrganizedAVConferences -- TotalOrganizedApplicationSharingConferences -- TotalOrganizedWebConferences -- TotalOrganizedDialInConferences -- TotalOrganizedAVConferenceMinutes -- TotalParticipatedConferences -- TotalParticipatedIMConferences -- TotalParticipatedAVConferences -- TotalParticipatedApplicationSharingConferences -- TotalParticipatedWebConferences -- TotalParticipatedDialInConferences -- TotalParticipatedAVConferenceMinutes -- TotalPlacedPSTNCalls -- TotalReceivedPSTNCalls -- TotalPlacedPSTNCallMinutes -- TotalReceivedPSTNCallMinutes -- TotalMessages -- TotalTransferredFiles - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsUserActivitiesReport -StartDate 01/01/2015 -EndDate 01/31/2015 -``` - -This example shows the activity for all users for the month of January. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -The UserName parameter filters the results by user. You identify the user by their account (for example, laura@contoso.com). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-CsUsersBlockedReport.md b/exchange/exchange-ps/exchange/Get-CsUsersBlockedReport.md deleted file mode 100644 index 99c115243b..0000000000 --- a/exchange/exchange-ps/exchange/Get-CsUsersBlockedReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-csusersblockedreport -applicable: Exchange Online -title: Get-CsUsersBlockedReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-CsUsersBlockedReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-CsUsersBlockedReport cmdlet to view Skype for Business Online users who have been blocked due to fraudulent call activities. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-CsUsersBlockedReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You can use the Get-CsUsersBlockedReport to query information about blocked users in Skype for Business Online for the last 3 months. For the reporting period you specify, the cmdlet returns the following information: - -- ActionDate -- SIPURI -- ActionType -- TelephoneNumber -- Reason - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-CsUsersBlockedReport -StartDate 11/01/2015 -EndDate 12/30/2015 -``` - -This example shows the list of blocked users for November and December. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DataClassification.md b/exchange/exchange-ps/exchange/Get-DataClassification.md index 677244c076..9bfe9cc832 100644 --- a/exchange/exchange-ps/exchange/Get-DataClassification.md +++ b/exchange/exchange-ps/exchange/Get-DataClassification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dataclassification +online version: https://learn.microsoft.com/powershell/module/exchange/get-dataclassification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-DataClassification schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Get-DataClassification ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Get-DlpSensitiveInformationType](https://docs.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype) cmdlet in Security & Compliance Center PowerShell. +In Exchange Online, this cmdlet has been replaced by the [Get-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Get-DataClassification cmdlet to view the data classification rules in your organization. This cmdlet shows built-in data classification rules and rules that you created that use document fingerprints. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Get-DataClassification [[-Identity] ] ## DESCRIPTION Classification rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,22 +82,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The Identity parameter specifies the data classification rule that you want to view. You can use any value that uniquely identifies the data classification rule. For example: @@ -118,17 +102,33 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md b/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md index 04e5117d79..03342c3e31 100644 --- a/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md +++ b/exchange/exchange-ps/exchange/Get-DataClassificationConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dataclassificationconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-dataclassificationconfig applicable: Exchange Online title: Get-DataClassificationConfig schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-DataClassificationConfig cmdlet to view the data classification configuration for your organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +25,7 @@ Get-DataClassificationConfig [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,12 +43,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md index 9918af831c..b58632caa0 100644 --- a/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DataEncryptionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dataencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-dataencryptionpolicy applicable: Exchange Online, Exchange Online Protection title: Get-DataEncryptionPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-DataEncryptionPolicy cmdlet to view data encryption policies in Exchange Online. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,11 +29,11 @@ Get-DataEncryptionPolicy [[-Identity] ] ``` ## DESCRIPTION -Data encryption policy cmdlets are the Exchange Online part of service encryption with Customer Key in Microsoft 365. For more information, see [Controlling your data in Microsoft 365 using Customer Key](https://aka.ms/customerkey). +Data encryption policy cmdlets are the Exchange Online part of Customer Key. For more information, see [Controlling your data in Microsoft 365 using Customer Key](https://aka.ms/customerkey). You can assign a data encryption policy to a mailbox by using the DataEncryptionPolicy parameter on the Set-Mailbox cmdlet in Exchange Online PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,6 +53,26 @@ The example returns detailed information for the data encryption policy named Eu ## PARAMETERS +### -Identity +The Identity parameter specifies the data encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: DataEncryptionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +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. @@ -90,26 +108,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the data encryption policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: DataEncryptionPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -WhatIf This parameter is reserved for internal Microsoft use. @@ -131,12 +129,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md index e62a1ccb1c..1f38d8c687 100644 --- a/exchange/exchange-ps/exchange/Get-DataRetentionReport.md +++ b/exchange/exchange-ps/exchange/Get-DataRetentionReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dataretentionreport -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-dataretentionreport +applicable: Exchange Online, Security & Compliance title: Get-DataRetentionReport schema: 2.0.0 author: chrisda @@ -12,13 +12,11 @@ ms.reviewer: # Get-DataRetentionReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-DataRetentionReport cmdlet to view information about data retention in the Microsoft 365 compliance center. +Use the Get-DataRetentionReport cmdlet to view information about data retention in the Microsoft Purview compliance portal. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +38,7 @@ The following properties are returned by this cmdlet: - DataSource - MessageCount -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -56,13 +54,13 @@ This example lists the data detections for April, 2018. ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -78,7 +76,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -94,7 +92,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -106,13 +104,15 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +The StartDate value can't be older than 92 days from today. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -126,12 +126,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md index 7d3e798821..6f519626b5 100644 --- a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroup +online version: https://learn.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-DatabaseAvailabilityGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-DatabaseAvailabilityGroup cmdlet to obtain a variety of configuration settings, status and other information about a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ In addition to obtaining a list of DAG members, the Get-DatabaseAvailabilityGrou Use the Status parameter with the command to include the values for these listed properties. Without the Status parameter, the values returned for these properties are blank. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,40 +58,40 @@ This example displays the properties of the DAG DAG2. Because it includes the St ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the name of the DAG to query. ```yaml -Type: Fqdn +Type: DatabaseAvailabilityGroupIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the DAG to query. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: DatabaseAvailabilityGroupIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -Status -The Status parameter instructs the command to query Active Directory for additional information and to include real-time status information in the output. +The Status parameter instructs the command to query Active Directory for additional information and to include real-time status information in the output. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -111,12 +111,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md index 8bca869424..deb02d5a8e 100644 --- a/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/exchange/Get-DatabaseAvailabilityGroupNetwork.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroupnetwork +online version: https://learn.microsoft.com/powershell/module/exchange/get-databaseavailabilitygroupnetwork applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-DatabaseAvailabilityGroupNetwork schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-DatabaseAvailabilityGroupNetwork cmdlet to display configuration and state information for a database availability group (DAG) network. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +47,7 @@ Valid states for network interfaces - Unavailable: The network interface isn't enabled for replication or use by the DAG, or the DAG member associated with this network interface is inactive or unavailable.The network interface isn't enabled for replication or use by the DAG, or the DAG member associated with this network interface is inactive or unavailable. - Unknown: The system was unable to determine the state of the network interface. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,35 +74,35 @@ This example gets complete configuration and status information for the network ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the name of a DAG or a DAG network. ```yaml -Type: Fqdn +Type: DatabaseAvailabilityGroupNetworkIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of a DAG or a DAG network. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: DatabaseAvailabilityGroupNetworkIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -132,12 +132,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md new file mode 100644 index 0000000000..13ed2a7226 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantBriefingConfig.md @@ -0,0 +1,84 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig +applicable: Exchange Online +title: Get-DefaultTenantBriefingConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DefaultTenantBriefingConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DefaultTenantBriefingConfig + [-ResultSize ] + [] +``` + +## DESCRIPTION +The default Briefing email configuration for the organization affects only new users and existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +``` +Get-DefaultTenantBriefingConfig +``` + +This example returns the default Briefing email configuration for the organization. + +## PARAMETERS + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md new file mode 100644 index 0000000000..76bb40fd28 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DefaultTenantMyAnalyticsFeatureConfig.md @@ -0,0 +1,80 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig +applicable: Exchange Online +title: Get-DefaultTenantMyAnalyticsFeatureConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DefaultTenantMyAnalyticsFeatureConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-DefaultTenantMyAnalyticsFeatureConfig cmdlet to view the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DefaultTenantMyAnalyticsFeatureConfig [-ResultSize ] [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-DefaultTenantMyAnalyticsFeatureConfig +``` + +This example returns the default opt-in or opt-out information for the various Viva Insights settings. + +## PARAMETERS + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md index 530ccec2c1..363d35c76f 100644 --- a/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/Get-DeliveryAgentConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deliveryagentconnector +online version: https://learn.microsoft.com/powershell/module/exchange/get-deliveryagentconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-DeliveryAgentConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-DeliveryAgentConnector cmdlet to retrieve information about a specific delivery agent connector in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,9 +27,9 @@ Get-DeliveryAgentConnector [[-Identity] ] ``` ## DESCRIPTION -Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://docs.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). +Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://learn.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,37 +49,37 @@ This example retrieves a list of all delivery agent connectors in your organizat ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +The Identity parameter specifies the GUID or name of the delivery agent connector. ```yaml -Type: Fqdn +Type: DeliveryAgentConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the GUID or name of the delivery agent connector. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: DeliveryAgentConnectorIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -88,12 +88,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DetailZapReport.md b/exchange/exchange-ps/exchange/Get-DetailZapReport.md new file mode 100644 index 0000000000..e2332bf377 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DetailZapReport.md @@ -0,0 +1,151 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-detailzapreport +applicable: Exchange Online +title: Get-DetailZapReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DetailZapReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-DetailZapReport cmdlet to view details about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DetailZapReport + [[-EndDate] ] + [[-Page] ] + [[-PageSize] ] + [[-StartDate] ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following default information: + +- Subject +- Received Time +- Sender + +If you append the command with ` | Format-List`, the following additional information is returned for each entry: + +- Recipient +- ZAP Time +- Original Threat +- Original Location +- Updated Threat +- Updated Delivery Location +- Delivery Status +- Detection Technology + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DetailZapReport +``` + +This example retrieves information for the last 3 days. + +### Example 2 +```powershell +Get-DetailZapReport -StartDate 7/1/2023 -EndDate 7/9/2023 +``` + +This example retrieves information for the specified date range. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". + +If you use this parameter, you also need to use the StartDate parameter. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". + +If you use this parameter, you also need to use the StartDate parameter. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DetailsTemplate.md b/exchange/exchange-ps/exchange/Get-DetailsTemplate.md index cce4061a7c..71900617a9 100644 --- a/exchange/exchange-ps/exchange/Get-DetailsTemplate.md +++ b/exchange/exchange-ps/exchange/Get-DetailsTemplate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-detailstemplate +online version: https://learn.microsoft.com/powershell/module/exchange/get-detailstemplate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-DetailsTemplate schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-DetailsTemplate cmdlet to retrieve the attributes for details templates. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Get-DetailsTemplate [[-Identity] ] ## DESCRIPTION The Get-DetailsTemplate cmdlet retrieves the attributes for one or more details templates. Wildcard characters can be used when specifying the type and language of the details templates. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,6 +58,29 @@ This example retrieves all attributes for all User details template types in all ## PARAMETERS +### -Identity +The Identity parameter specifies the GUID of the details template or specifies the details template type and language separated by a backslash, for example, en-us\\User. Details template types are: + +- User +- Group +- PublicFolder +- SearchDialog +- MailboxAgent +- Contact + +```yaml +Type: DetailsTemplateIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +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. @@ -93,29 +116,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the GUID of the details template or specifies the details template type and language separated by a backslash, for example, en-us\\User. Details template types are: - -- User -- Group -- PublicFolder -- SearchDialog -- MailboxAgent -- Contact - -```yaml -Type: DetailsTemplateIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -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. @@ -137,12 +137,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md index e848f51c6b..a79926c166 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deviceconditionalaccesspolicy -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconditionalaccesspolicy +applicable: Exchange Online, Security & Compliance title: Get-DeviceConditionalAccessPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceConditionalAccessPolicy ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-DeviceConditionalAccessPolicy cmdlet to view mobile device conditional access policies in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,9 +33,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -66,7 +66,7 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -80,12 +80,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md index 207b63c513..65fe845674 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConditionalAccessRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deviceconditionalaccessrule -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconditionalaccessrule +applicable: Exchange Online, Security & Compliance title: Get-DeviceConditionalAccessRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceConditionalAccessRule ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-DeviceConditionalAccessRule cmdlet to view mobile device conditional access rules in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,9 +35,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -64,7 +64,7 @@ The Identity parameter specifies the mobile device conditional access rule that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -80,7 +80,7 @@ The CompareToWorkload switch specifies whether to compare the mobile device cond Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -96,7 +96,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -110,12 +110,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md index 015ad2d432..34e6dc1ae0 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deviceconfigurationpolicy -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconfigurationpolicy +applicable: Exchange Online, Security & Compliance title: Get-DeviceConfigurationPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceConfigurationPolicy ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-DeviceConfigurationPolicy cmdlet to view mobile device configuration policies in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,9 +33,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -66,7 +66,7 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -80,12 +80,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md index a7a4cf6bd0..84afa08d75 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceConfigurationRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-deviceconfigurationrule -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-deviceconfigurationrule +applicable: Exchange Online, Security & Compliance title: Get-DeviceConfigurationRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceConfigurationRule ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-DeviceConfigurationRule cmdlet to view mobile device configuration rules in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,9 +35,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -64,7 +64,7 @@ The Identity parameter specifies the mobile device configuration rule that you w Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -80,7 +80,7 @@ The CompareToWorkload switch specifies whether to compare the mobile device conf Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -96,7 +96,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -110,12 +110,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DevicePolicy.md b/exchange/exchange-ps/exchange/Get-DevicePolicy.md index 5e19dd6c20..f7cb5c1dce 100644 --- a/exchange/exchange-ps/exchange/Get-DevicePolicy.md +++ b/exchange/exchange-ps/exchange/Get-DevicePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-devicepolicy -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-devicepolicy +applicable: Exchange Online, Security & Compliance title: Get-DevicePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DevicePolicy ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-DevicePolicy cmdlet to view all types of Basic Mobility and Security policies in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,9 +33,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -66,7 +66,7 @@ The Identity parameter specifies the mobile device policy that you want to view. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -80,12 +80,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md index 1c740ee9ca..ce5c1c516e 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DeviceTenantPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-devicetenantpolicy -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-devicetenantpolicy +applicable: Exchange Online, Security & Compliance title: Get-DeviceTenantPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceTenantPolicy ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-DeviceTenantPolicy cmdlet to view your organization's mobile device tenant policy in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,9 +33,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -55,7 +55,7 @@ The Identity parameter specifies the name of the mobile device tenant policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -69,12 +69,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md index 472f5b9027..3d61488bdc 100644 --- a/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Get-DeviceTenantRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-devicetenantrule -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-devicetenantrule +applicable: Exchange Online, Security & Compliance title: Get-DeviceTenantRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DeviceTenantRule ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-DeviceTenantRule cmdlet to view your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,9 +34,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -49,35 +49,35 @@ This example shows information for your organization's mobile device tenant rule ## PARAMETERS -### -DomainController -This parameter is reserved for internal Microsoft use. +### -Identity +The Identity parameter specifies the name of the mobile device tenant rule that you want to view, but there's only one in your organization. The name of the rule is a GUID value. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. ```yaml -Type: Fqdn +Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the mobile device tenant rule that you want to view, but there's only one in your organization. The name of the rule is a GUID value. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. +### -DomainController +This parameter is reserved for internal Microsoft use. ```yaml -Type: ComplianceRuleIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Security & Compliance Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -86,12 +86,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroup.md b/exchange/exchange-ps/exchange/Get-DistributionGroup.md index 6252511658..601c6b2a36 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Get-DistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-distributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/get-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-DistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-DistributionGroup cmdlet to view existing distribution groups or mail-enabled security groups. To view the members of a group, use the Get-DistributionGroupMember cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,6 +27,12 @@ Get-DistributionGroup [-Anr ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-OrganizationalUnit ] [-ReadFromDomainController] [-RecipientTypeDetails ] @@ -41,6 +47,12 @@ Get-DistributionGroup [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-OrganizationalUnit ] [-ReadFromDomainController] [-RecipientTypeDetails ] @@ -54,6 +66,12 @@ Get-DistributionGroup [-Credential ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-ManagedBy ] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -63,7 +81,7 @@ Get-DistributionGroup [-Credential ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,6 +108,29 @@ This example returns all distribution groups and mail-enabled security groups wh ## PARAMETERS +### -Identity +The Identity parameter specifies the distribution group or mail-enabled security group that you want to view. You can use any values that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: DistributionGroupIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -115,7 +156,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -149,16 +190,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -173,44 +214,141 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to view. You can use any values that uniquely identifies the group. For example: +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. ```yaml -Type: DistributionGroupIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. +### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames +This parameter is available only in the cloud-based service. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromDLMembers recipients in the AcceptMessagesOnlyFromDLMembersWithDisplayNames property. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromDLMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromDLMembersWithDisplayNames property is empty. -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromSendersOrMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property is empty. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFrom recipients in the AcceptMessagesOnlyFromWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFrom recipients are shown as GUIDs and the AcceptMessagesOnlyFromWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, BypassModerationFromSendersOrMembers recipients are shown as GUIDs and the BypassModerationFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, GrantSendOnBehalfTo recipients are shown as GUIDs and the GrantSendOnBehalfToWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeModeratedByWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -266,7 +404,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -356,12 +496,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md index 55399366df..3113e769e2 100644 --- a/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Get-DistributionGroupMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-distributiongroupmember +online version: https://learn.microsoft.com/powershell/module/exchange/get-distributiongroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-DistributionGroupMember schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-DistributionGroupMember cmdlet to view the members of distribution groups and mail-enabled security groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Get-DistributionGroupMember [-Identity] ## DESCRIPTION If your organization has multiple Active Directory domains, you may need to run the Set-ADServerSettings cmdlet with the ViewEntireForest parameter set to $true before running the Get-DistributionGroupMember cmdlet to view the entire forest. For more information, see Example 2. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,11 +48,29 @@ This example returns the existing distribution group members for the distributio ### Example 2 ```powershell Set-ADServerSettings -ViewEntireForest $true + Get-DistributionGroupMember -Identity "Marketing Worldwide" ``` This example sets the scope of the search to the entire forest by running the Set-ADServerSettings cmdlet, then the Get-DistributionGroupMember cmdlet searches the entire forest for the distribution group members in the Marketing Worldwide distribution group. +### Example 3 +```powershell +$Groups = Get-UnifiedGroup -ResultSize Unlimited + +$Groups | ForEach-Object { +$group = $_ +Get-UnifiedGroupLinks -Identity $group.Name -LinkType Members -ResultSize Unlimited | ForEach-Object { + New-Object -TypeName PSObject -Property @{ + Group = $group.DisplayName + Member = $_.Name + EmailAddress = $_.PrimarySMTPAddress + RecipientType= $_.RecipientType +}}} | Export-CSV "$env:USERPROFILE\Desktop\Office365GroupMembers.csv" -NoTypeInformation -Encoding UTF8 +``` + +In the cloud-based service, this example downloads a comma-separated value (CSV) file named Office365GroupMembers.csv that contains all Microsoft 365 Groups and members to the current user's Desktop. + ## PARAMETERS ### -Identity @@ -81,7 +99,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -117,9 +135,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -160,7 +178,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -198,12 +218,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md index cccdca3827..9fe8d4bfd8 100644 --- a/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md +++ b/exchange/exchange-ps/exchange/Get-DkimSigningConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dkimsigningconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection title: Get-DkimSigningConfig schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-DkimSigningConfig cmdlet to view the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Get-DkimSigningConfig [[-Identity] ] ## DESCRIPTION DKIM in Microsoft 365 is an email authentication method that uses a public key infrastructure (PKI), message headers and CNAME records in DNS to authenticate the message sender, which is stamped in the DKIM-Signature header field. DKIM helps prevent forged sender email addresses (also known as spoofing) by verifying that the domain in the From address matches the domain in the DKIM-Signature header field. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,12 +73,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md index a00005720e..f5a379ed1b 100644 --- a/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-DlpCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpcompliancepolicy +applicable: Security & Compliance title: Get-DlpCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,23 +12,29 @@ ms.reviewer: # Get-DlpCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-DlpCompliancePolicy to view Data Loss Prevention (DLP) policies in the Microsoft 365 compliance center. +Use the Get-DlpCompliancePolicy to view data loss prevention (DLP) policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-DlpCompliancePolicy [[-Identity] ] - [-IncludeExtendedProperties ] + [-DisplayName ] [-DistributionDetail] + [-ForceValidate ] + [-IncludeExtendedProperties ] + [-IncludeRulesMetadata ] + [-IncludeSimulationResults ] + [-IRMUserRiskConfiguredAnyRule] + [-Summary] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -37,7 +43,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Get-DlpCompliancePolicy ``` -This example displays summary information for all DLP policies in the Microsoft 365 compliance center. +This example displays summary information for all DLP policies in the Microsoft Purview compliance portal. ### Example 2 ```powershell @@ -58,7 +64,7 @@ This example displays distribution details for a DLP policy. $dlp = Get-DlpCompliancePolicy; ForEach ($d in $dlp){Get-DlpCompliancePolicy -DistributionDetail $d.name | Format-List Name,DistributionStatus} ``` -This example gets all of the DLP policies in a environment and displays the distribution status for each. +This example gets all of the DLP policies in an environment and displays the distribution status for each. ## PARAMETERS @@ -74,7 +80,7 @@ The Identity parameter specifies the DLP policy that you want to view. You can u Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -83,14 +89,48 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -DisplayName +{{ Fill DisplayName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DistributionDetail The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. +**Tip**: The DistributionResults property is unreliable and prone to errors. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceValidate +{{ Fill ForceValidate Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -106,7 +146,71 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeRulesMetadata +{{ Fill IncludeRulesMetadata Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IRMUserRiskConfiguredAnyRule +{{ Fill IRMUserRiskConfiguredAnyRule Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeSimulationResults +{{ Fill IncludeSimulationResults Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Summary +{{ Fill Summary Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -120,12 +224,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md index 0b3169af9c..3ec06ed550 100644 --- a/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-DlpComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpcompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpcompliancerule +applicable: Security & Compliance title: Get-DlpComplianceRule schema: 2.0.0 author: chrisda @@ -12,23 +12,24 @@ ms.reviewer: # Get-DlpComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-DlpComplianceRule to view Data Loss Prevention (DLP) rules in the Microsoft 365 compliance center. DLP rules identify and protect sensitive information. +Use the Get-DlpComplianceRule to view data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules identify and protect sensitive information. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-DlpComplianceRule [[-Identity] ] + [-DisplayName ] [-IncludeExecutionRuleGuids ] [-Policy ] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -37,7 +38,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Get-DlpComplianceRule ``` -This example displays summary information for all DLP rules in the Microsoft 365 compliance center. +This example displays summary information for all DLP rules in the Microsoft Purview compliance portal. ### Example 2 ```powershell @@ -67,7 +68,7 @@ The Identity parameter specifies the DLP rule that you want to view. You can use Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -76,6 +77,22 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -DisplayName +{{ Fill DisplayName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeExecutionRuleGuids {{ Fill IncludeExecutionRuleGuids Description }} @@ -83,7 +100,7 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -104,7 +121,7 @@ The Policy parameter specifies the DLP policy that contains the rules. Using thi Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -118,12 +135,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md index 2008197ac6..ec4460246a 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetailReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpdetailreport -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpdetailreport +applicable: Exchange Online, Security & Compliance title: Get-DlpDetailReport schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Get-DlpDetailReport ## SYNOPSIS -This cmdlet is available only in the cloud-based service. +**Note**: This cmdlet has been retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. -Use the Get-DlpDetailReport cmdlet to list details about Data Loss Prevention (DLP) rule matches for Exchange Online, SharePoint Online, and OneDrive for Business in your cloud-based organization for the last 30 days. +This cmdlet is available only in the cloud-based service. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Get-DlpDetailReport cmdlet to list details about data loss prevention (DLP) rule matches for Exchange Online, SharePoint, and OneDrive in your cloud-based organization for the last 30 days. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -58,9 +58,9 @@ The Get-DlpDetailReport cmdlet returns detailed information about specific DLP r - Recipients - AttachmentNames -To see DLP detection data that's aggregated per day, use the [Get-DlpDetectionsReport](https://docs.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport) cmdlet. +To see DLP detection data that's aggregated per day, use the [Get-DlpDetectionsReport](https://learn.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport) cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,7 +86,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -104,7 +104,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -122,7 +122,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -140,7 +140,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -152,13 +152,13 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -186,7 +186,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -202,7 +202,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -218,7 +218,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -231,8 +231,8 @@ Accept wildcard characters: False The Source parameter filters the report by workload. Valid values are: - EXCH: Exchange Online -- ODB: OneDrive for Business -- SPO: SharePoint Online +- ODB: OneDrive +- SPO: SharePoint You can specify multiple values separated by commas. @@ -240,7 +240,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -252,13 +252,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -272,12 +272,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md index 5c99f8a9a9..be1c5ba605 100644 --- a/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpdetectionsreport +applicable: Exchange Online, Security & Compliance title: Get-DlpDetectionsReport schema: 2.0.0 author: chrisda @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-DlpDetectionsReport cmdlet to list a summary of Data Loss Prevention (DLP) rule matches for Exchange Online, SharePoint Online and OneDrive for Business in your cloud-based organization for the last 30 days. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Get-DlpDetectionsReport cmdlet to list a summary of data loss prevention (DLP) rule matches for Exchange Online, SharePoint and OneDrive in your cloud-based organization for the last 30 days. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,7 +52,7 @@ To see all of these columns (width issues), write the output to a file. For exam To see detailed information about each DLP rule match, use the Get-DlpDetailReport cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,7 +78,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -94,7 +94,7 @@ The AggregateBy parameter specifies the reporting period. Valid values are Hour, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -112,7 +112,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -130,7 +130,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -142,13 +142,13 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -183,7 +183,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -193,7 +193,7 @@ Accept wildcard characters: False ``` ### -Expression -This parameter is available only in Security & Compliance Center PowerShell +This parameter is available only in Security & Compliance PowerShell This parameter is reserved for internal Microsoft use. @@ -201,7 +201,7 @@ This parameter is reserved for internal Microsoft use. Type: Expression Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -217,7 +217,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -233,7 +233,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -246,8 +246,8 @@ Accept wildcard characters: False The Source parameter filters the report by workload. Valid values are: - EXCH: Exchange Online -- ODB: OneDrive for Business -- SPO: SharePoint Online +- ODB: OneDrive +- SPO: SharePoint You can specify multiple values separated by commas. @@ -255,7 +255,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -267,13 +267,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -285,7 +285,7 @@ Accept wildcard characters: False ### -SummarizeBy The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. -Valid values are: +For this cmdlet, valid values are: - DLPPolicy - Domain @@ -297,7 +297,7 @@ You can specify multiple values separated by commas. The values that you specify Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -311,12 +311,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md index 7fe2a88f29..d9052762b8 100644 --- a/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Get-DlpEdmSchema.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Get-DlpEdmSchema -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpedmschema +applicable: Security & Compliance title: Get-DlpEdmSchema schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DlpEdmSchema ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-DlpEdmSchema cmdlet to view exact data match (EDM) data loss prevention (DLP) schemas in the Microsoft 365 compliance center. +Use the Get-DlpEdmSchema cmdlet to view exact data match (EDM) data loss prevention (DLP) schemas in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-DlpEdmSchema [[-Identity] ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -56,7 +56,7 @@ The Identity parameter specifies the DLP EDM schema that you want to view. You c Type: EdmStorageIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -70,14 +70,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Create custom sensitive information types with Exact Data Match based classification](https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification) +[Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits) diff --git a/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md new file mode 100644 index 0000000000..59707c5464 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DlpIncidentDetailReport.md @@ -0,0 +1,284 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpincidentdetailsreport +applicable: Exchange Online, Security & Compliance +title: Get-DlpIncidentDetailReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DlpIncidentDetailReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) instead. + +Use the Get-DlpIncidentDetailReport cmdlet to view the details of incidents that happened in the last 30 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DlpIncidentDetailReport + [-Action ] + [-Actor ] + [-DlpCompliancePolicy ] + [-DlpComplianceRule ] + [-EndDate ] + [-EventType ] + [-Page ] + [-PageSize ] + [-Source ] + [-StartDate ] + [] +``` + +## DESCRIPTION +The output of the Get-DlpIncidentDetailReport cmdlet includes the following properties: + +- Date +- Title +- Location +- Severity +- Size +- Source +- Actor +- DlpCompliancePolicy +- DlpComplianceRule +- UserAction +- Justification +- SensitiveInformationType +- SensitiveInformationCount +- SensitiveInformationConfidence +- EventType +- Action +- DistinctRuleCount +- DistinctPolicyCount +- RuleList +- PolicyList +- ActionList +- SensitiveInformationTypeList +- SensitiveInformationCountList +- SensitiveInformationConfidenceList + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-DlpIncidentDetailReport -StartDate 2022/11 -EndDate 2022/11/30 +``` + +This example lists the details of the all incidents that occurred between the dates specified. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken by DLP policies. Valid values are: + +- BlockAccess +- GenerateIncidentReport +- NotifyUser + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Actor +The Actor parameter filters the report by the user who last modified the item. You can enter multiple users separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpCompliancePolicy +The DlpCompliancePolicy parameter filters the report by the name of the DLP compliance policy. You can specify multiple policies separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpComplianceRule +The DlpComplianceRule parameter filters the report by the name of the DLP compliance rule. You can specify multiple rules separated by commas. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- DLPByIncidentIdActionHits +- DLPByIncidentIdMessages +- DLPByIncidentIdPolicyFalsePositive +- DLPByIncidentIdPolicyHits +- DLPByIncidentIdPolicyOverride +- DLPByIncidentIdRuleHits + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify DLP incident event types for DLP incident reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +The Source parameter filters the report by workload. Valid values are: + +- EXCH: Exchange Online +- ODB: OneDrive +- SPO: SharePoint +- TEAMS + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md index 442aef9589..cf21bb85d5 100644 --- a/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Get-DlpKeywordDictionary.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpkeyworddictionary -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpkeyworddictionary +applicable: Exchange Online, Security & Compliance title: Get-DlpKeywordDictionary schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-DlpKeywordDictionary ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-DlpKeywordDictionary cmdlet to view data loss prevention (DLP) keyword dictionaries in the Microsoft 365 compliance center. +Use the Get-DlpKeywordDictionary cmdlet to view data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-DlpKeywordDictionary [-Name ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -53,7 +53,7 @@ The Name parameter specifies the name of the DLP keyword dictionary that you wan Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -67,12 +67,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicy.md b/exchange/exchange-ps/exchange/Get-DlpPolicy.md index 13feb325aa..ef75ad1628 100644 --- a/exchange/exchange-ps/exchange/Get-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/Get-DlpPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlppolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlppolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-DlpPolicy schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Get-DlpPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: This cmdlet has been retired from the cloud-based service. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/exchange-online-etrs-to-stop-supporting-dlp-policies/ba-p/3886713). Use the Get-DlpCompliancePolicy and Get-DlpComplianceRule cmdlets instead. -Use the Get-DlpPolicy cmdlet to view information about existing data loss prevention (DLP) policies. +This cmdlet is functional only in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the Get-DlpPolicy cmdlet to view existing data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +29,7 @@ Get-DlpPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,37 +49,39 @@ This example returns detailed information about the DLP policy named Employee Nu ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. +### -Identity +The Identity parameter specifies the DLP policy that you want to view. You can use any value that uniquely identifies the policy. For example: -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: Fqdn +Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the DLP policy you want to remove. You can use any value that uniquely identifies the DLP policy. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: DlpPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -86,12 +90,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md index 5defbc4f4d..bafb90d765 100644 --- a/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/exchange/Get-DlpPolicyTemplate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlppolicytemplate +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlppolicytemplate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-DlpPolicyTemplate schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Get-DlpPolicyTemplate ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: This cmdlet has been retired from the cloud-based service. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/exchange-online-etrs-to-stop-supporting-dlp-policies/ba-p/3886713). -Use the Get-DlpPolicyTemplate cmdlet to view existing data loss prevention (DLP) policy templates in your Exchange organization. +This cmdlet is functional only in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the Get-DlpPolicyTemplate cmdlet to view existing data loss prevention (DLP) policy templates that are based on transport rules (mail flow rules) in your Exchange organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +29,7 @@ Get-DlpPolicyTemplate [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,37 +49,37 @@ This example returns detailed information about the DLP policy template named GL ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the DLP policy template you want to view. You can use any value that uniquely identifies the DLP policy template. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy template. ```yaml -Type: Fqdn +Type: DlpPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the DLP policy template you want to view. You can use any value that uniquely identifies the DLP policy template. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy template. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: DlpPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -86,12 +88,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md index 816f04e3f8..99d0a14db7 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Get-DlpSensitiveInformationType.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsensitiveinformationtype +applicable: Exchange Online, Security & Compliance title: Get-DlpSensitiveInformationType schema: 2.0.0 author: chrisda @@ -12,16 +12,17 @@ ms.reviewer: # Get-DlpSensitiveInformationType ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-DlpSensitiveInformationType cmdlet to list the sensitive information types that are defined for your organization in the Microsoft 365 compliance center. Sensitive information types are used by Data Loss Prevention (DLP) rules to check for sensitive information such as social security, passport, or credit card numbers. +Use the Get-DlpSensitiveInformationType cmdlet to list the sensitive information types that are defined for your organization in the Microsoft Purview compliance portal. Sensitive information types are used by data loss prevention (DLP) rules to check for sensitive information such as social security, passport, or credit card numbers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-DlpSensitiveInformationType [[-Identity] ] + [-Capability ] [-IncludeDetails] [-IncludeElements ] [-Organization ] @@ -31,7 +32,7 @@ Get-DlpSensitiveInformationType [[-Identity] ] + [-Capability ] [] ``` ## DESCRIPTION Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,7 +60,7 @@ The Identity parameter specifies the sensitive information type rule package tha Type: SensitiveInformationTypeRuleCollectionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -70,17 +69,29 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Capability +{{ Fill Capability Description }} + +```yaml +Type: ClassificationCapabilityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md index a58e87d2b0..b89d2416f2 100644 --- a/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md +++ b/exchange/exchange-ps/exchange/Get-DlpSiDetectionsReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dlpsidetectionsreport -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-dlpsidetectionsreport +applicable: Exchange Online, Security & Compliance title: Get-DlpSiDetectionsReport schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Get-DlpSiDetectionsReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Microsoft 365 compliance center for the last 90 days. +**Note**: This cmdlet will be retired. Use the [Export-ActivityExplorerData](https://learn.microsoft.com/powershell/module/exchange/export-activityexplorerdata) cmdlet to view DLP information. Data from Export-ActivityExplorerData is the same as the retired Get-DlpIncidentDetailReport cmdlet. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Get-DlpSiDetectionsReport cmdlet to view information about data loss prevention (DLP) sensitive information type detections in the Microsoft Purview compliance portal for the last 90 days. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ For the reporting period you specify, the cmdlet returns the following informati - ProtectionStatus: Values are Unprotected (the sensitive information type is not defined in any DLP policy) or Protected (the sensitive information type is defined in a DLP policy). - DlpComplianceRuleIds: The GUID value of the DLP compliance rule that detected the sensitive information type (for ProtectionStatus values of Protected). To match the GUID value to the name of the DLP compliance rule, replace `` with the GUID value and run this command: `Get-DlpComplianceRule -Identity `. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,13 +61,13 @@ This example returns detections for the sensitive information type 0e9b3178-9678 ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ You can enter multiple values separated by commas: `"Value1","Value2",..."ValueN Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -99,12 +99,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md b/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md new file mode 100644 index 0000000000..05ddacb11c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-DnssecStatusForVerifiedDomain.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-dnssecstatusforverifieddomain +applicable: Exchange Online +title: Get-DnssecStatusForVerifiedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-DnssecStatusForVerifiedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-DnssecStatusForVerifiedDomain cmdlet to view information about Domain Name System Security (DNSSEC) for accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-DnssecStatusForVerifiedDomain [-DomainName] + [-Confirm] + [-SkipDnsValidation] + [-SkipMtaStsValidation] + [-SkipMxValidation] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Get-DnssecStatusForVerifiedDomain -DomainName contoso.com + +DnssecFeatureStatus : Enabled +ExpectedMxRecord : Microsoft.Exchange.Management.ProvisioningTasks.ExpectedMxRecordInfo +Errors : {} +Warnings : {} +DnsValidation : Microsoft.Exchange.Management.ProvisioningTasks.DnsValidationResult +MxValidation : Microsoft.Exchange.Management.ProvisioningTasks.MxValidationResult +MtaStsValidation : Microsoft.Exchange.Management.ProvisioningTasks.MtaStsValidationResult +``` + +This example shows the basic output of the cmdlet for the domain contoso.com. + +### Example 2 +```powershell +PS C:\> $result = Get-DnssecStatusForVerifiedDomain -DomainName contoso.com; $result; "DNSSEC feature"; $result.DnssecFeatureStatus; "DNSSEC validation"; $result.DnsValidation; "Expected MX record: [$($result.ExpectedMxRecord.Record)]"; "", "MX validation"; $result.MxValidation; "MTA-STS validation"; $result.MtaStsValidation + +DnssecFeatureStatus : Enabled +ExpectedMxRecord : Microsoft.Exchange.Management.ProvisioningTasks.ExpectedMxRecordInfo +Errors : {} +Warnings : {} +DnsValidation : Microsoft.Exchange.Management.ProvisioningTasks.DnsValidationResult +MxValidation : Microsoft.Exchange.Management.ProvisioningTasks.MxValidationResult +MtaStsValidation : Microsoft.Exchange.Management.ProvisioningTasks.MtaStsValidationResult + +DNSSEC feature +Value : Enabled + +DNSSEC validation +DnssecSupport : Valid +Errors : {} +Warnings : {} + +Expected MX record: [@ 60 IN MX 10 contoso-com.e-v1.mx.microsoft] + +MX validation +Status : Valid +ActualMxRecords : {@ 60 IN MX 10 contoso-com.e-v1.mx.microsoft} +Errors : {} +Warnings : {} + +MTA-STS validation +Status : Valid +MtaStsAvailable : False +MtaStsMode : Unavailable +Errors : {} +Warnings : {} +``` + +This example contains the output from Example 1 and readable values for the DnsValidation, MxValidation, and MtaStsValidation properties. This command confirms the following information: + +- The DNSSEC-secured MX record is present in the domain. +- The priority of the MX record is 10. +- The MTA-STS Policy contains the DNSSEC-secured mail host (if MTA-STS present). + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to view information about DNSSEC (for example, contoso.com). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDnsValidation +The SkipDnsValidation switch specifies whether to skip the check for the DNSSEC-secured MX record in the domain. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMtaStsValidation +The SkipMtaStsValidation switch specifies whether to skip the check for the DNSSEC-secured mail host in the MTA-STS Policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipMxValidation +The SkipMxValidation switch specifies whether to skip the check for the priority value 10 in the DNSSEC-secured MX record. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-DomainController.md b/exchange/exchange-ps/exchange/Get-DomainController.md index 3f64b84c78..b36194819e 100644 --- a/exchange/exchange-ps/exchange/Get-DomainController.md +++ b/exchange/exchange-ps/exchange/Get-DomainController.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-domaincontroller +online version: https://learn.microsoft.com/powershell/module/exchange/get-domaincontroller applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-DomainController schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-DomainController cmdlet to view a list of domain controllers that exist in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,13 +39,14 @@ Get-DomainController [-DomainName ] The Get-DomainController cmdlet is used by the Exchange admin center to populate fields that display domain controller information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $UserCredentials = Get-Credential + Get-DomainController -DomainName corp.contoso.com -Credential $UserCredentials | Format-Table -AutoSize Name,ADSite ``` @@ -53,7 +54,7 @@ This example retrieves a list of global catalog servers in the corp.contoso.com The first command displays a prompt to the user that accepts the username and password. The credentials are then stored in the $UserCredentials variable. The second command uses the $UserCredentials variable for the Credential parameter value. To make the list more readable, the output is piped to the Format-Table cmdlet and only the Name and ADSite properties are displayed. -For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ## PARAMETERS @@ -76,7 +77,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). If you use the Forest parameter, the credentials are used to access the forest. @@ -130,12 +131,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md index e3a4580820..d988b7788e 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-DynamicDistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-DynamicDistributionGroup cmdlet to view existing dynamic distribution groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,6 +27,12 @@ Get-DynamicDistributionGroup [-Anr ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -42,6 +48,12 @@ Get-DynamicDistributionGroup [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -57,6 +69,12 @@ Get-DynamicDistributionGroup [-ManagedBy ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] [-IncludeSystemObjects] [-OrganizationalUnit ] [-ReadFromDomainController] @@ -68,7 +86,7 @@ Get-DynamicDistributionGroup [-ManagedBy ] ## DESCRIPTION A dynamic distribution group queries mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an email message is sent to the group. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -96,6 +114,7 @@ This example returns all dynamic distribution groups whose names contain the str ### Example 4 ```powershell $FTE = Get-DynamicDistributionGroup "Full Time Employees" + Get-Recipient -RecipientPreviewFilter $FTE.RecipientFilter -OrganizationalUnit $FTE.RecipientContainer ``` @@ -151,7 +170,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -185,16 +204,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -212,9 +231,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -232,6 +251,126 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromDLMembers recipients in the AcceptMessagesOnlyFromDLMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromDLMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromDLMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromSendersOrMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeAcceptMessagesOnlyFromWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFrom recipients in the AcceptMessagesOnlyFromWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFrom recipients are shown as GUIDs and the AcceptMessagesOnlyFromWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, BypassModerationFromSendersOrMembers recipients are shown as GUIDs and the BypassModerationFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, GrantSendOnBehalfTo recipients are shown as GUIDs and the GrantSendOnBehalfToWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeModeratedByWithDisplayNames +This parameter is available only in the cloud-based service. + +The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeSystemObjects This parameter is available only in on-premises Exchange. @@ -297,7 +436,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -359,12 +500,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md index 332a36a97d..d93483e17c 100644 --- a/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Get-DynamicDistributionGroupMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroupmember -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-dynamicdistributiongroupmember +applicable: Exchange Online, Exchange Online Protection title: Get-DynamicDistributionGroupMember schema: 2.0.0 author: chrisda @@ -18,7 +18,7 @@ Use the Get-DynamicDistributionGroupMember cmdlet to view the calculated members Use the Get-DistributionGroupMember cmdlet to view the members of distribution groups and mail-enabled security groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Get-DynamicDistributionGroupMember [-Identity] ] + [-State ] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-EOPProtectionPolicyRule | Format-Table Name,State +``` + +This example returns a summary list of the rules for EOP protections in preset security policies. + +### Example 2 +```powershell +Get-EOPProtectionPolicyRule -Identity "Strict Preset Security Policy" +``` + +This example returns detailed information about the rule named Strict Preset Security Policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the state of the rule. Valid values are: + +- Enabled +- Disabled. + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md index 12b7d43c70..72e7aca6f2 100644 --- a/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md +++ b/exchange/exchange-ps/exchange/Get-EXOCasMailbox.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exocasmailbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-exocasmailbox applicable: Exchange Online title: Get-EXOCasMailbox schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXOCasMailbox ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-EXOCasMailbox cmdlet to view the Client Access settings that are configured on mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -154,7 +154,7 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId -The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Azure Active Directory. +The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -172,16 +172,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Get-EXOCasMailbox property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Get-EXOCasMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -286,7 +286,7 @@ Accept wildcard characters: False ### -Properties The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. -For more information about the available properties, see [Get-EXOCasMailbox property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets). +For more information about the available properties, see [Get-EXOCasMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets). ```yaml Type: String[] @@ -315,7 +315,7 @@ The PropertySets parameter specifies a logical grouping of properties that are r You can specify multiple values separated by commas. -For more information about the properties that are included in each property set, see [Get-EXOCasMailbox property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets). +For more information about the properties that are included in each property set, see [Get-EXOCasMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets). ```yaml Type: PropertySet[] @@ -428,7 +428,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types The following Get-CasMailbox parameters are not available or supported in Get-EXOCasMailbox: - IgnoreDefaultScope @@ -437,7 +437,7 @@ The following Get-CasMailbox parameters are not available or supported in Get-EX ## OUTPUTS -### +### Output types The following properties are removed by design from Get-EXOCasMailbox output: - RunspaceId diff --git a/exchange/exchange-ps/exchange/Get-EXOMailbox.md b/exchange/exchange-ps/exchange/Get-EXOMailbox.md index ff7a78a2e5..fb1295de5f 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailbox.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailbox.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exomailbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailbox applicable: Exchange Online title: Get-EXOMailbox schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXOMailbox ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-EXOMailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -83,7 +83,7 @@ This example returns a summary list of all mailboxes in the organization, and in Get-EXOMailbox -PropertySets Archive ``` -This example returns the Properties that are defined in Archive property set. For a complete list of these properties, see [Get-EXOMailbox property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). +This example returns the Properties that are defined in Archive property set. For a complete list of these properties, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). ### Example 3 ```powershell @@ -192,7 +192,7 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId -The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Azure Active Directory. +The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -210,16 +210,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Get-EXOMailbox property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -372,7 +372,7 @@ Accept wildcard characters: False ### -Properties The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. -For more information about the available properties, see [Get-EXOMailbox property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). +For more information about the available properties, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). ```yaml Type: String[] @@ -411,7 +411,7 @@ The PropertySets parameter specifies a logical grouping of properties that are r You can specify multiple values separated by commas. -For more information about the properties that are included in each property set, see [Get-EXOMailbox property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). +For more information about the properties that are included in each property set, see [Get-EXOMailbox property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets). ```yaml Type: PropertySet[] @@ -529,7 +529,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types The following Get-Mailbox parameters aren't available or functional in Get-EXOMailbox: @@ -541,7 +541,7 @@ The following Get-Mailbox parameters aren't available or functional in Get-EXOMa ## OUTPUTS -### +### Output types The following properties aren't included in the output of Get-EXOMailbox: - RunspaceId diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md index 68fc940eff..d15ff5ab3c 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderPermission.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission applicable: Exchange Online title: Get-EXOMailboxFolderPermission schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXOMailboxFolderPermission ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-ExOMailboxFolderPermission cmdlet to view folder-level permissions in mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -80,7 +80,7 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId -The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Azure Active Directory. +The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -120,7 +120,7 @@ You can't use this parameter with the ExternalDirectoryObjectId, Identity, or Us ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -179,20 +179,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Get-MailboxFolderPermission](Get-MailboxFolderPermission.md) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](Set-MailboxFolderPermission.md) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](Remove-MailboxFolderPermission.md) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) -[Add-MailboxFolderPermission](Add-MailboxFolderPermission.md) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md index 6157121646..b6d21cf8d8 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxFolderStatistics.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics applicable: Exchange Online title: Get-EXOMailboxFolderStatistics schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXOMailboxFolderStatistics ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-EXOMailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -64,7 +64,6 @@ Get-EXOMailbox -ResultSize Unlimited | Get-EXOMailboxFolderStatistics -FolderSco This example uses the FolderScope parameter to view Inbox folder statistics for all mailboxes. - ## PARAMETERS ### -Archive @@ -86,7 +85,7 @@ Accept wildcard characters: False ``` ### -DiagnosticInfo -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. +This parameter is reserved for internal Microsoft use. ```yaml Type: String @@ -102,7 +101,7 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId -The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Azure Active Directory. +The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -180,7 +179,7 @@ Applicable: Exchange Online Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -275,12 +274,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md index 1e0e513e2a..d008aa8f24 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxPermission.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exomailboxpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxpermission applicable: Exchange Online title: Get-EXOMailboxPermission schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXOMailboxPermission ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-EXOMailboxPermission cmdlet to retrieve permissions on a mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -72,7 +72,7 @@ This example return the permission the user has on mailboxes ## PARAMETERS ### -ExternalDirectoryObjectId -The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Azure Active Directory. +The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -111,7 +111,7 @@ Applicable: Exchange Online Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -231,12 +231,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md index 204e03c715..cbe03cc816 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMailboxStatistics.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exomailboxstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomailboxstatistics applicable: Exchange Online title: Get-EXOMailboxStatistics schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXOMailboxStatistics ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-EXOMailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -61,7 +61,7 @@ This example retrieves the minimum set of properties and the specified propertie ## PARAMETERS ### -Archive -The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch. +The Archive switch specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -93,7 +93,7 @@ Accept wildcard characters: False ``` ### -ExchangeGuid -The ExchangeGuid parameter filters the results by the GUID of mailbox (aso known as the Mailbox GUID). You can find this property value by using the Get-EXOMailbox cmdlet with Properies filter set to ExchangeGuid. +The ExchangeGuid parameter filters the results by the GUID of mailbox (aso known as the Mailbox GUID). You can find this property value by using the Get-EXOMailbox cmdlet with Properties filter set to ExchangeGuid. ```yaml Type: Guid @@ -132,7 +132,7 @@ Applicable: Exchange Online Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -207,7 +207,7 @@ Accept wildcard characters: False ### -Properties The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. -For more information about the available properties, see [Get-EXOMailboxStatistics property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets). +For more information about the available properties, see [Get-EXOMailboxStatistics property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets). ```yaml Type: String[] @@ -230,7 +230,7 @@ The PropertySets parameter specifies a logical grouping of properties that are r You can specify multiple values separated by commas. -For more information about the properties that are included in each property set, see [Get-EXOMailboxStatistics property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets). +For more information about the properties that are included in each property set, see [Get-EXOMailboxStatistics property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets). ```yaml Type: PropertySet[] @@ -268,12 +268,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md index bed80d5dd9..91b5ebab64 100644 --- a/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-EXOMobileDeviceStatistics.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics applicable: Exchange Online title: Get-EXOMobileDeviceStatistics schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXOMobileDeviceStatistics ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-EXOMobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -60,14 +60,14 @@ This cmdlet returns a list of statistics about each mobile device. Additionally, Get-EXOMobileDeviceStatistics -Mailbox john.doe@contoso.com ``` -Above example fetches the statstics of all devices linked to user with email john.doe@contoso.com +This example returns the statistics of all devices linked to user with email john.doe@contoso.com ### Example 2 ```powershell Get-EXOMobileDeviceStatistics -Mailbox john.doe@contoso.com -ActiveSync ``` -Above example fetches the statstics for active sync devices linked to user with email john.doe@contoso.com +This example returns the statistics for active sync devices linked to user with email john.doe@contoso.com ## PARAMETERS @@ -109,7 +109,7 @@ Applicable: Exchange Online Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -130,7 +130,7 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId -The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Azure Active Directory. +The ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -284,12 +284,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXORecipient.md b/exchange/exchange-ps/exchange/Get-EXORecipient.md index 75ef6f3c27..fd34b10f9d 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipient.md +++ b/exchange/exchange-ps/exchange/Get-EXORecipient.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exorecipient +online version: https://learn.microsoft.com/powershell/module/exchange/get-exorecipient applicable: Exchange Online title: Get-EXORecipient schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXORecipient ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Get-ExORecipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups). +Use the Get-EXORecipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -131,7 +131,7 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId -The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Azure Active Directory. +The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -149,16 +149,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Get-EXORecipient property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Get-EXORecipient property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -233,7 +233,7 @@ Accept wildcard characters: False ### -Properties The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. -For more information about the available properties, see [Get-EXORecipient property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets). +For more information about the available properties, see [Get-EXORecipient property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets). ```yaml Type: String[] @@ -257,7 +257,7 @@ The PropertySets parameter specifies a logical grouping of properties that are r - MailboxMove - Policy -For more information about the properties that are included in each property set, see [Get-EXORecipient property sets](https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets). +For more information about the properties that are included in each property set, see [Get-EXORecipient property sets](https://learn.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets). ```yaml Type: PropertySet[] @@ -343,6 +343,7 @@ The RecipientTypeDetails parameter filters the results by the specified recipien - RoomMailbox - SchedulingMailbox - SharedMailbox +- SharedWithMailUser - TeamMailbox - UserMailbox @@ -402,12 +403,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md b/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md index d23d5e6ab3..3ec37b7a9d 100644 --- a/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md +++ b/exchange/exchange-ps/exchange/Get-EXORecipientPermission.md @@ -1,23 +1,23 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-exorecipientpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-exorecipientpermission applicable: Exchange Online title: Get-EXORecipientPermission schema: 2.0.0 author: chrisda ms.author: chrisda -ms.reviewer: navgupta +ms.reviewer: --- # Get-EXORecipientPermission ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-EXORecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -111,7 +111,7 @@ Accept wildcard characters: False ``` ### -ExternalDirectoryObjectId -The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Azure Active Directory. +The ExternalDirectoryObjectId parameter identifies the recipient that you want to view by the ObjectId in Microsoft Entra ID. You can't use this parameter with the Identity, PrimarySmtpAddress, or UserPrincipalName parameters. @@ -183,7 +183,7 @@ You need to use this parameter with the Identity, PrimarySmtpAddress, UserPrinci ```yaml Type: String -Parameter Sets: Identity +Parameter Sets: (All) Aliases: Applicable: Exchange Online @@ -217,12 +217,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md index 1de4dd43f6..1235c14ba1 100644 --- a/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-EcpVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ecpvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/get-ecpvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-EcpVirtualDirectory schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Get-EcpVirtualDirectory cmdlet to view Exchange Control Panel (ECP) virt The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013 and Exchange 2016 servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ Get-EcpVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,7 +116,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -172,12 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-EdgeSubscription.md b/exchange/exchange-ps/exchange/Get-EdgeSubscription.md index 89f1080c6b..4e288d9293 100644 --- a/exchange/exchange-ps/exchange/Get-EdgeSubscription.md +++ b/exchange/exchange-ps/exchange/Get-EdgeSubscription.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-edgesubscription +online version: https://learn.microsoft.com/powershell/module/exchange/get-edgesubscription applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-EdgeSubscription schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-EdgeSubscription cmdlet to retrieve information about Edge Subscriptions in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-EdgeSubscription [[-Identity] ] ## DESCRIPTION Run the Get-EdgeSubscription cmdlet on an Exchange server in your organization. This cmdlet retrieves the list of Edge Subscriptions. Each Edge Transport server that's subscribed to the Exchange organization has a separate Edge Subscription. You can use this cmdlet to view the Edge Subscription information for a specific Edge Transport server. You can also use this cmdlet to view the Edge Subscription information for all Edge Transport servers subscribed to Active Directory sites. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,37 +49,37 @@ This example retrieves the Edge Subscription information for the Edge Transport ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +The Identity parameter specifies the name of the Edge Transport server for which you want to retrieve Edge Subscription information. The identity is expressed as the host name of the Edge Transport server. If no identity is specified, all Edge Subscriptions are returned. ```yaml -Type: Fqdn +Type: TransportServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the Edge Transport server for which you want to retrieve Edge Subscription information. The identity is expressed as the host name of the Edge Transport server. If no identity is specified, all Edge Subscriptions are returned. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: TransportServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -88,12 +88,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md index 200ad43504..fa33987f4c 100644 --- a/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/exchange/Get-EdgeSyncServiceConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-edgesyncserviceconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-edgesyncserviceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-EdgeSyncServiceConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-EdgeSyncServiceConfig cmdlet to retrieve the edge synchronization services settings that control the general synchronization behavior shared by all Microsoft Exchange EdgeSync services. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-EdgeSyncServiceConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -94,12 +94,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md index 5f0cddb6c3..fe9c386e7f 100644 --- a/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md +++ b/exchange/exchange-ps/exchange/Get-EligibleDistributionGroupForMigration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-eligibledistributiongroupformigration +online version: https://learn.microsoft.com/powershell/module/exchange/get-eligibledistributiongroupformigration applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-EligibleDistributionGroupForMigration schema: 2.0.0 @@ -12,13 +12,11 @@ ms.reviewer: # Get-EligibleDistributionGroupForMigration ## SYNOPSIS -This cmdlet is available or functional only in the cloud-based service. +This cmdlet is functional only in the cloud-based service. Use the Get-EligibleDistributionGroupForMigration cmdlet to identify distribution groups that can be upgraded to Microsoft 365 Groups. You can't upgrade mail-enabled security groups to Microsoft 365 Groups. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +37,7 @@ Get-EligibleDistributionGroupForMigration [-ManagedBy ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,48 +48,50 @@ This example returns detailed information for the email address policy named Con ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. +### -Identity +The Identity parameter specifies the email address policy that you want to view. You can use any value that uniquely identifies the policy. For example: -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: Fqdn +Type: EmailAddressPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the email address policy that you want to view. You can use any value that uniquely identifies the policy. For example: +### -DomainController +This parameter is available only in on-premises Exchange. -- Name -- Distinguished name (DN) -- GUID +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: EmailAddressPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -IncludeMailboxSettingOnlyPolicy -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. + +The IncludeMailboxSettingOnlyPolicy switch retrieves Microsoft Exchange Server 2003 address policies that contain only mailbox management configuration. You don't need to specify a value with this switch. -The IncludeMailboxSettingOnlyPolicy parameter retrieves Microsoft Exchange Server 2003 address policies that contain only mailbox management configuration. Microsoft Exchange Server 2010 supports both policies that contain only address policy settings and policies that contain address policy settings and mailbox management configuration. Exchange 2010 doesn't support policies that contain only mailbox management configuration, but Exchange 2003 policies that contain only mailbox management configuration are, by default, preserved and not upgraded. The IncludeMailboxSettingOnlyPolicy parameter is required to retrieve these policies. +Microsoft Exchange Server 2010 supports policies that contain only address policy settings and policies that contain address policy settings and mailbox management configuration. Exchange 2010 doesn't support policies that contain only mailbox management configuration, but Exchange 2003 policies that contain only mailbox management configuration are, by default, preserved and not upgraded. The attributes of address policies that contain only mailbox management configuration can't be modified in Exchange 2010. These policies can only be removed. @@ -111,12 +113,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md b/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md new file mode 100644 index 0000000000..025fdca73a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EmailTenantSettings.md @@ -0,0 +1,66 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-emailtenantsettings +applicable: Exchange Online +title: Get-EmailTenantSettings +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EmailTenantSettings + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-EmailTenantSettings cmdlet to view whether priority account protection is enabled or disabled in your Microsoft Defender for Office 365 organization. For more information about priority accounts, see [Manage and monitor priority accounts](https://learn.microsoft.com/microsoft-365/admin/setup/priority-accounts). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EmailTenantSettings [[-Identity] ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-EmailTenantSettings | Format-List Identity,EnablePriorityAccountProtection +``` + +This example shows whether priority account protection is enabled or disabled in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the settings object that you want to view. The only settings object in the organization is named Default. + +```yaml +Type: EmailTenantSettingsIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EtrLimits.md b/exchange/exchange-ps/exchange/Get-EtrLimits.md new file mode 100644 index 0000000000..759a8d045c --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-EtrLimits.md @@ -0,0 +1,50 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-etrlimits +applicable: Exchange Online, Exchange Online Protection +title: Get-EtrLimits +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-EtrLimits + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-EtrLimits cmdlet to show information about [mail flow rule (also known as transport rule) limits in Exchange Online](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#journal-transport-and-inbox-rule-limits), as well the current usage and the largest rule IDs in terms of size and regular expression character count. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-EtrLimits [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-EtrLimits +``` + +This example returns information about the number and size of mail flow rules in the organization, and the organizational limits for mail flow rules. + +## 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-EventLogLevel.md b/exchange/exchange-ps/exchange/Get-EventLogLevel.md index 55d6c5be06..cc925f4f3d 100644 --- a/exchange/exchange-ps/exchange/Get-EventLogLevel.md +++ b/exchange/exchange-ps/exchange/Get-EventLogLevel.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-eventloglevel +online version: https://learn.microsoft.com/powershell/module/exchange/get-eventloglevel applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-EventLogLevel schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-EventLogLevel cmdlet to display a list of Exchange event categories and the corresponding log levels on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Get-EventLogLevel [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,6 +48,24 @@ This example displays the event categories and log levels for the server Exchang ## PARAMETERS +### -Identity +The Identity parameter filters the results by the name of the event category. To see the available event categories, run the following command: Get-EventLogLevel. + +You can't use this parameter with the Server parameter. + +```yaml +Type: ECIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Server The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example: @@ -89,35 +107,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter filters the results by the name of the event category. To see the available event categories, run the following command: Get-EventLogLevel. - -You can't use this parameter with the Server parameter. - -```yaml -Type: ECIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md index 9e03f16369..30df67b8a5 100644 --- a/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-EventsFromEmailConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-eventsfromemailconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-eventsfromemailconfiguration applicable: Exchange Online title: Get-EventsFromEmailConfiguration schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-EventsFromEmailConfiguration ## SYNOPSIS -This cmdlet is only available in the cloud-based service. +This cmdlet is available only in the cloud-based service. Use the Get-EventsFromEmailConfiguration cmdlet to view the events from email settings on a mailbox. These settings define whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to the user's calendar. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-EventsFromEmailConfiguration [-Identity] ## DESCRIPTION **Note**: The following output properties have been deprecated: EventReservationProcessingLevel, FoodEstablishmentReservationProcessingLevel, InvoiceProcessingLevel, and ServiceReservationProcessingLevel. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,12 +62,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md b/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md index de347662f6..d2853de47a 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeAssistanceConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exchangeassistanceconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeassistanceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ExchangeAssistanceConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ExchangeAssistanceConfig cmdlet to view the configuration information for the URLs that Microsoft Exchange Help uses to connect to the source of the documentation. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-ExchangeAssistanceConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,37 +47,37 @@ This example shows the configuration information for all organizations and forma ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +The Identity parameter specifies the identity of the organization. ```yaml -Type: Fqdn +Type: OrganizationIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identity of the organization. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: OrganizationIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -86,12 +86,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md index 76d37cbbc9..eec9e123ff 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exchangecertificate +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ExchangeCertificate schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ExchangeCertificate cmdlet to view Exchange certificates that are installed on Exchange servers. This cmdlet returns Exchange self-signed certificates, certificates that were issued by a certification authority and pending certificate requests (also known as certificate signing requests or CSRs). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -91,7 +91,7 @@ If you append ` | Format-List *` to the command, the cmdlet returns these additi - SubjectName: Typically, this value is System.Security.Cryptography.X509Certificates.X500DistinguishedName. - Version: Typically, this value is 3. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -246,12 +246,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md index 1642dac98b..ca36c14478 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeDiagnosticInfo.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.Management-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exchangediagnosticinfo +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangediagnosticinfo applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ExchangeDiagnosticInfo schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ExchangeDiagnosticInfo cmdlet to return information about processes that are running on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-ExchangeDiagnosticInfo [-Argument ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +44,7 @@ This example returns a summary list of all Exchange processes that are running o ### Example 2 ```powershell [xml]$edi = Get-ExchangeDiagnosticInfo + $edi.Diagnostics.Processlocator.Process | Format-Table -Auto Name,ID,Guid ``` @@ -151,12 +152,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExchangeFeature.md b/exchange/exchange-ps/exchange/Get-ExchangeFeature.md new file mode 100644 index 0000000000..6bf6bb29bf --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExchangeFeature.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangefeature +applicable: Exchange Server 2019 +title: Get-ExchangeFeature +schema: 2.0.0 +author: lusassl-msft +ms.author: lusassl +ms.reviewer: srvar +--- + +# Get-ExchangeFeature + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Get-ExchangeFeature cmdlet to return information about features that are flighted on Exchange servers. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExchangeFeature [-Identity ] + [-FeatureID ] + [-RingLevel ] + [-Status ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExchangeFeature -Status "Enabled" +``` + +This example returns all enabled features. + +### Example 2 +```powershell +Get-ExchangeFeature -FeatureID "PING.1.0" +``` + +This example returns information about the feature with the feature id PING.1.0. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange server that you want to modify. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command returns information for all Exchange servers. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FeatureID +The FeatureID parameter specifies the feature you want to query information about. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RingLevel +The RingLevel parameter specifies the ring level you want to query information about. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The Status parameter specifies the status you want to query information about. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServer.md b/exchange/exchange-ps/exchange/Get-ExchangeServer.md index c7fbb2d93e..4331ccbb63 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServer.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exchangeserver +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ExchangeServer schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Get-ExchangeServer cmdlet to view the properties of Exchange servers. When you run the Get-ExchangeServer cmdlet with no parameters, it returns the attributes of all the servers in the Exchange organization. To return specific server properties (including domain controller information) where the Get-ExchangeServer cmdlet has to contact servers directly or perform a complex or slow calculation, make sure you use the Status parameter. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ Get-ExchangeServer [[-Identity] ] ## DESCRIPTION The ExchangeVersion attribute returned is the minimum version of Microsoft Exchange that you can use to manage the returned object. This attribute isn't the same as the version of Exchange displayed in the Exchange admin center when you select Server Configuration. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,6 +61,29 @@ This example returns detailed information about the Exchange server named Mailbo ## PARAMETERS +### -Identity +The Identity parameter specifies the Exchange server that you want to view. You can use any value that uniquely identifies the Exchange server. For example: + +- Name +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use this parameter with the Domain parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Domain The Domain parameter filters the results by the fully qualified domain name (FQDN) of the domain (for example, contoso.com). @@ -97,29 +120,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Exchange server that you want to view. You can use any value that uniquely identifies the Exchange server. For example: - -- Name -- GUID -- Distinguished name (DN) -- ExchangeLegacyDN - -You can't use this parameter with the Domain parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Status The Status switch specifies whether to include additional property values in the results, for example, the Watson state, StaticDomainControllers, and runtime domain controller usage. You don't need to specify a value with this switch. @@ -143,12 +143,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md index 48788a0db5..4d95f68bfd 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicense.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicense +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicense applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ExchangeServerAccessLicense schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ExchangeServerAccessLicense cmdlet to return a list of licenses in use in your Exchange organization. This refers to the specific legal name of the license, as defined in the Microsoft Product List and is representative of your licenses when you run this cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ The Get-ExchangeServerAccessLicense cmdlet returns a collection of these license - Exchange Server Standard Edition - Exchange Server Enterprise Edition -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,12 +50,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md index 718d24c41f..4c62c163e4 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeServerAccessLicenseUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicenseuser +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangeserveraccesslicenseuser applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ExchangeServerAccessLicenseUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ExchangeServerAccessLicenseUser cmdlet to return a list of unique users for the specified license name. Each object contains the FQDN or primary SMTP address of the mailbox and the license that's associated with it. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-ExchangeServerAccessLicenseUser -LicenseName ## DESCRIPTION The Get-ExchangeServerAccessLicenseUser cmdlet returns a collection of unique users for the specified license name. The list of unique users represents an estimate of your licenses when you run this cmdlet. Each object contains the FQDN or primary SMTP address of the mailbox and the license name to which it's associated. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,12 +69,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md b/exchange/exchange-ps/exchange/Get-ExchangeSettings.md index 3e56f03200..9088353301 100644 --- a/exchange/exchange-ps/exchange/Get-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/Get-ExchangeSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-exchangesettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-exchangesettings applicable: Exchange Server 2016, Exchange Server 2019 title: Get-ExchangeSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ExchangeSettings cmdlet to view customized Exchange setting objects that are stored in Active Directory. Use the New-ExchangeSettings to create the settings object, and the Set-ExchangeSettings cmdlet to define the actual settings. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Get-ExchangeSettings [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +59,26 @@ This example returns a summary list of all Exchange setting objects. ## PARAMETERS +### -Identity +The Identity parameter specifies the name of the Exchange setting object. You can use any value that uniquely identifies the object. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ExchangeSettingsIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -ConfigName The ConfigName parameter filter the results by the specified property name. The value you specify is visible in the EffectiveSetting property. @@ -99,10 +119,12 @@ Accept wildcard characters: False ``` ### -Diagnostic -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. The detailed information is visible in the DiagnosticInfo property. +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -149,7 +171,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -212,26 +236,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the Exchange setting object. You can use any value that uniquely identifies the object. For example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: ExchangeSettingsIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Organization This parameter is reserved for internal Microsoft use. @@ -306,12 +310,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md new file mode 100644 index 0000000000..08f6210738 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierPolicy.md @@ -0,0 +1,99 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierpolicy +applicable: Exchange Online +title: Get-ExoInformationBarrierPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoInformationBarrierPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoInformationBarrierPolicy cmdlet to view information barrier policies in your Exchange Online organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoInformationBarrierPolicy [[-Identity] ] [-ShowFriendlyValues] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoInformationBarrierPolicy -ShowFriendlyValues| Format-List Name,FriendlyRecipientFilter,InformationBarrierSegmentName +``` + +This example shows a summary list of all Exchange Online information barrier policies in the organization. + +### Example 2 +```powershell +Get-ExoInformationBarrierPolicy -Identity bf542929-a8c4-4167-88fb-3e5ef68a1dca -ShowFriendlyValues +``` + +This example shows detailed information for the specified Exchange Online information barrier policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange Online information barrier policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Display name +- Distinguished name (DN) +- GUID + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShowFriendlyValues +The ShowFriendlyValues switch specifies whether to show friendly values in the output of the command. You don't need to specify a value with this switch. + +When you use this switch, the following property values are shown: + +- FriendlyRecipientFilter +- InformationBarrierSegmentName + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md new file mode 100644 index 0000000000..8e1ddb9d25 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierRelationship.md @@ -0,0 +1,97 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarrierrelationship +applicable: Exchange Online +title: Get-ExoInformationBarrierRelationship +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoInformationBarrierRelationship + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoInformationBarrierRelationship cmdlet to view information barrier relationships in your Exchange Online organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoInformationBarrierRelationship -RecipientId1 -RecipientId2 + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoInformationBarrierRelationship -RecipientId1 "Akia Al-Zuhairi" -RecipientId2 "Gabriela Laureano" +``` + +This example shows the Exchange Online information barrier relationship between the two specified recipients. + +## PARAMETERS + +### -RecipientId1 +The RecipientId1 parameter specifies the first recipient in the Exchange Online barrier relationship. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientId2 +The RecipientId2 parameter specifies the second recipient in the Exchange Online barrier relationship. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md new file mode 100644 index 0000000000..b0caf1efcb --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoInformationBarrierSegment.md @@ -0,0 +1,96 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exoinformationbarriersegment +applicable: Exchange Online +title: Get-ExoInformationBarrierSegment +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoInformationBarrierSegment + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoInformationBarrierSegment to view information barrier segments in your Exchange Online organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoInformationBarrierSegment [[-Identity] ] [-ShowFriendlyValues] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoInformationBarrierSegment -ShowFriendlyValues| Format-List DisplayName,Name,FriendlyRecipientFilter,AssociatedPolicy +``` + +This example shows a summary list of all Exchange Online information barrier segments in the organization. + +### Example 2 +```powershell +Get-ExoInformationBarrierSegment -Identity "Investment Banking" -ShowFriendlyValues +``` + +This example shows detailed information for the specified Exchange Online information barrier segment. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange Online information barrier segment that you want to view. You can use any value that uniquely identifies the segment. For example: + +- Name +- Display name +- Distinguished name (DN) +- GUID + +```yaml +Type: InformationBarrierSegmentIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ShowFriendlyValues +The ShowFriendlyValues switch specifies whether to show friendly values in the output of the command. You don't need to specify a value with this switch. + +When you use this switch, the FriendlyMembershipFilter property value is shown. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md new file mode 100644 index 0000000000..0baced66e2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoPhishSimOverrideRule.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exophishsimoverriderule +applicable: Exchange Online +title: Get-ExoPhishSimOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoPhishSimOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoPhishSimOverrideRule cmdlet to view third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoPhishSimOverrideRule [[-Identity] ] + [-Confirm] + [-DomainController ] + [-Policy ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoPhishSimOverrideRule +``` + +This example returns detailed information about the phishing simulation override (there should be only one). + +### Example 2 +```powershell +Get-ExoPhishSimOverrideRule | Format-Table Name,Mode +``` + +This example identifies the valid rule (one) and any invalid rules. + +Although the previous command should return only one rule, a rule that's pending deletion might also be included in the results. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the phishing simulation override rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +The name of the rule uses the following syntax: `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter filters the results by phishing simulator override policy. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md new file mode 100644 index 0000000000..4f8ca933c6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ExoSecOpsOverrideRule.md @@ -0,0 +1,156 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exosecopsoverriderule +applicable: Exchange Online +title: Get-ExoSecOpsOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ExoSecOpsOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ExoSecOpsOverrideRule cmdlet to view SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ExoSecOpsOverrideRule [[-Identity] ] + [-Confirm] + [-DomainController ] + [-Policy ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoSecOpsOverrideRule +``` + +This example returns detailed information about the SecOps mailbox override rule (there should be only one). + +### Example 2 +```powershell +Get-ExoSecOpsOverrideRule | Format-Table Name,Mode +``` + +This example identifies the valid rule (one) and any invalid rules. + +Although the previous command should return only one rule, a rule that's pending deletion might also be included in the results. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the SecOps override rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +The name of the rule uses the following syntax: `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter filters the results by SecOps mailbox override policy. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md b/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md index 899795fca4..451de0b213 100644 --- a/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md +++ b/exchange/exchange-ps/exchange/Get-ExternalInOutlook.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-externalinoutlook +online version: https://learn.microsoft.com/powershell/module/exchange/get-externalinoutlook applicable: Exchange Online, Exchange Online Protection title: Get-ExternalInOutlook schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-ExternalInOutlook cmdlet to view the configuration of external sender identification that's available in Outlook, Outlook for Mac, Outlook on the web, and Outlook for iOS and Android. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ The important properties that are returned in the output of this cmdlet are: - Enabled: True means the feature is enabled; False means the feature is disabled. - AllowList: The list of exceptions. Messages received from the specified senders or senders in the specified domains don't receive the External icon in the area of subject line. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,12 +64,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md b/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md index 0cb9a08afe..14df25198f 100644 --- a/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md +++ b/exchange/exchange-ps/exchange/Get-FailedContentIndexDocuments.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-failedcontentindexdocuments +online version: https://learn.microsoft.com/powershell/module/exchange/get-failedcontentindexdocuments applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-FailedContentIndexDocuments schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-FailedContentIndexDocuments ## SYNOPSIS -This cmdlet is available or functional only in Exchange Server 2016 or earlier. +This cmdlet is functional only in Exchange Server 2016 or earlier. Use the Get-FailedContentIndexDocuments cmdlet to retrieve a list of documents for a mailbox, mailbox database, or Mailbox server that couldn't be indexed by Exchange Search. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -70,7 +70,7 @@ After a new filter is installed, only new messages with attachments of the type The cmdlet output provides details about items in a mailbox that couldn't be indexed, including an error code and the reason for failure. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,7 +86,7 @@ This example retrieves a list of items that couldn't be indexed by Exchange Sear Get-FailedContentIndexDocuments -MailboxDatabase "Mailbox Database MDB2" ``` -This example retrieves a list of items that couldn't be indexed by Exchange Search from the mailbox database Mailbox Database MDB2. +This example retrieves a list of items that couldn't be indexed by Exchange Search from the mailbox database named Mailbox Database MDB2. ## PARAMETERS @@ -193,7 +193,9 @@ Accept wildcard characters: False ``` ### -Archive -The Archive switch restricts the scope of the cmdlet to the user's archive. When using the Archive switch, you must also specify the Identity parameter. +The Archive switch restricts the scope of the cmdlet to the user's archive. You don't need to specify a value with this switch. + +When using the Archive switch, you must also specify the Identity parameter. ```yaml Type: SwitchParameter @@ -211,7 +213,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -281,7 +283,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -317,12 +319,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md b/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md new file mode 100644 index 0000000000..87063ff596 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-FeatureConfiguration.md @@ -0,0 +1,133 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-featureconfiguration +applicable: Security & Compliance +title: Get-FeatureConfiguration +schema: 2.0.0 +--- + +# Get-FeatureConfiguration + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. + +Use the Get-FeatureConfiguration cmdlet to view Microsoft Purview feature configurations within your organization, including: + +- Collection policies. +- Advanced label based protection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-FeatureConfiguration [[-Identity] ] [-FeatureScenario] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Get-FeatureConfiguration -FeatureScenario KnowYourData | Format-Table Name,Mode +``` + +This example returns a summary list of all collection policies in the organization. + +### Example 2 +```powershell +Get-FeatureConfiguration -FeatureScenario KnowYourData -Identity "Engineering Group" +``` + +This example returns detailed information about the specified collection policy. + +## PARAMETERS + +### -Identity +The Identity policy specifies the feature configuration that you want to view. You can use any value that uniquely identifies the configuration. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -FeatureScenario +The FeatureScenario parameter specifies the scenario for the feature configuration. Currently, the only valid values are: +- `KnowYourData` for collection policies +- `TrustContainer` for Endpoint DLP trust container + +```yaml +Type: PolicyScenario +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md b/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md index d0916531c5..498c943b79 100644 --- a/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md +++ b/exchange/exchange-ps/exchange/Get-FederatedDomainProof.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-federateddomainproof +online version: https://learn.microsoft.com/powershell/module/exchange/get-federateddomainproof applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-FederatedDomainProof schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-FederatedDomainProof cmdlet to generate a cryptographically secure string for the domain used for federated sharing in your Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-FederatedDomainProof -DomainName ## DESCRIPTION The Get-FederatedDomainProof cmdlet generates a cryptographically secure string for the domain used for federated sharing. The resulting string is used to manually configure a text (TXT) record in the Domain Name System (DNS) zone for the domain used by the administrator when running the cmdlet. A TXT record needs to be added to DNS for all accepted domains used for federated sharing. If the thumbprint of a certificate isn't provided, the task generates strings for all the certificates currently configured for the federation trust. Upon initial configuration of federated sharing, the proof string generated for the current certificate needs to be put into the TXT record for the federated domain in DNS. We recommend you update the TXT records whenever a new certificate is configured for the federation trust. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,12 +103,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md index 70d7925f6b..141f7f644a 100644 --- a/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md +++ b/exchange/exchange-ps/exchange/Get-FederatedOrganizationIdentifier.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-federatedorganizationidentifier +online version: https://learn.microsoft.com/powershell/module/exchange/get-federatedorganizationidentifier applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-FederatedOrganizationIdentifier schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-FederatedOrganizationIdentifier cmdlet to retrieve the Exchange organization's federated organization identifier and related details, such as federated domains, organization contact and status. -For more information, see [Federation](https://docs.microsoft.com/exchange/federation-exchange-2013-help). +For more information, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-FederatedOrganizationIdentifier [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,42 +50,44 @@ This example retrieves the Exchange organization's federated organization identi ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the organization ID. ```yaml -Type: Fqdn +Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the organization ID. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: OrganizationIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -IncludeExtendedDomainInfo -The IncludeExtendedDomainInfo switch specifies that the command query Microsoft Federation Gateway for the status of each accepted domain that's federated. The status is returned with each domain in the Domains property. +The IncludeExtendedDomainInfo switch specifies that the command query Microsoft Federation Gateway for the status of each accepted domain that's federated. You don't need to specify a value with this switch. + +The status is returned with each domain in the Domains property. ```yaml Type: SwitchParameter @@ -105,12 +107,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-FederationInformation.md b/exchange/exchange-ps/exchange/Get-FederationInformation.md index cd83b73f14..53be62c5c2 100644 --- a/exchange/exchange-ps/exchange/Get-FederationInformation.md +++ b/exchange/exchange-ps/exchange/Get-FederationInformation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-federationinformation +online version: https://learn.microsoft.com/powershell/module/exchange/get-federationinformation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-FederationInformation schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-FederationInformation cmdlet to get federation information, including federated domain names and target URLs, from an external Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Get-FederationInformation cmdlet retrieves federation information from the d The domain specified should have federation enabled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,7 +81,7 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the host name in the Autodiscover endpoint of the domain doesn't match the Secure Sockets Layer (SSL) certificate presented by the endpoint and the host name isn't specified in the TrustedHostnames parameter. @@ -119,12 +119,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-FederationTrust.md b/exchange/exchange-ps/exchange/Get-FederationTrust.md index 69eac8c478..98175c1a29 100644 --- a/exchange/exchange-ps/exchange/Get-FederationTrust.md +++ b/exchange/exchange-ps/exchange/Get-FederationTrust.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-federationtrust +online version: https://learn.microsoft.com/powershell/module/exchange/get-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-FederationTrust schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-FederationTrust cmdlet to view the federation trust configured for the Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-FederationTrust [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,12 +79,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md index 58f4045d96..023b70021a 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertyAuthority.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-fileplanpropertyauthority -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertyauthority +applicable: Security & Compliance title: Get-FilePlanPropertyAuthority schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Get-FilePlanPropertyAuthority ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-FilePlanPropertyAuthority cmdlet to view file plan property authorities. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -22,7 +22,7 @@ Get-FilePlanPropertyAuthority [[-Identity] ] [] [] [] [] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -42,7 +42,7 @@ The IncludeAdditionalInfo switch specifies whether to include additional informa Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -56,12 +56,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md index 25be4615e2..ed2bc3113e 100644 --- a/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/Get-FilePlanPropertySubCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-fileplanpropertysubcategory -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-fileplanpropertysubcategory +applicable: Security & Compliance title: Get-FilePlanPropertySubCategory schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Get-FilePlanPropertySubCategory ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-FilePlanPropertySubCategory cmdlet to view file plan property subcategories. +Use the Get-FilePlanPropertySubCategory cmdlet to view file plan property subcategories. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -22,7 +22,7 @@ Get-FilePlanPropertySubCategory [[-Identity] ] [ + [-UseCustomRouting] [] ``` ## DESCRIPTION Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,17 +69,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ForeignConnector.md b/exchange/exchange-ps/exchange/Get-ForeignConnector.md index 66bfcf4316..1d19d0d26f 100644 --- a/exchange/exchange-ps/exchange/Get-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/Get-ForeignConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-foreignconnector +online version: https://learn.microsoft.com/powershell/module/exchange/get-foreignconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ForeignConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ForeignConnector cmdlet to view the configuration information for a Foreign connector in the Transport service of a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-ForeignConnector [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,41 +47,41 @@ This example displays detailed configuration information for the Foreign connect ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the Foreign connector that you want to examine. The Identity parameter can take any of the following values for the Foreign connector object: -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +- GUID +- Connector name +- ServerName\\ConnectorName ```yaml -Type: Fqdn +Type: ForeignConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Foreign connector that you want to examine. The Identity parameter can take any of the following values for the Foreign connector object: +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -- GUID -- Connector name -- ServerName\\ConnectorName +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: ForeignConnectorIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -90,12 +90,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-FrontendTransportService.md b/exchange/exchange-ps/exchange/Get-FrontendTransportService.md index dffcbef7d7..e768cd1838 100644 --- a/exchange/exchange-ps/exchange/Get-FrontendTransportService.md +++ b/exchange/exchange-ps/exchange/Get-FrontendTransportService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-frontendtransportservice +online version: https://learn.microsoft.com/powershell/module/exchange/get-frontendtransportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-FrontendTransportService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-FrontEndTransportService cmdlet to view the configuration of the Front End Transport service on Exchange 2013 or later servers that have the Client Access server role installed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-FrontendTransportService [[-Identity] ] ## DESCRIPTION The Front End Transport service acts as a stateless proxy for all inbound and outbound external SMTP traffic for the Exchange organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,22 +49,6 @@ This example retrieves the detailed configuration information for the Front End ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The Identity parameter specifies the Exchange server with the Client Access server role installed that you want to view. @@ -88,17 +72,33 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-GlobalAddressList.md b/exchange/exchange-ps/exchange/Get-GlobalAddressList.md index ac019e9c22..0a3a6daa60 100644 --- a/exchange/exchange-ps/exchange/Get-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/Get-GlobalAddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-globaladdresslist +online version: https://learn.microsoft.com/powershell/module/exchange/get-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-GlobalAddressList schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-GlobalAddressList cmdlet to view a global address list (GAL) or a set of GALs. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Get-GlobalAddressList [[-Identity] ] ## DESCRIPTION The Get-GlobalAddressList cmdlet is mainly used to populate the GAL property pages in the Exchange admin center. This command doesn't provide a filtering capability. If filtering is required, you should use a WHERE clause with the command. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,6 +59,26 @@ This example returns detailed information about the GAL named GAL\_AgencyB. ## PARAMETERS +### -Identity +The Identity parameter specifies the global address list that you want to view. You can use any value that uniquely identifies the GAL. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: GlobalAddressListIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -DefaultOnly The DefaultOnly switch filters the results so only the default GAL is returned. You don't need to use a value with this switch. @@ -93,37 +113,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the global address list that you want to view. You can use any value that uniquely identifies the GAL. For example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: GlobalAddressListIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md index dd5d4e08c3..24e4681b00 100644 --- a/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Get-GlobalMonitoringOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-globalmonitoringoverride +online version: https://learn.microsoft.com/powershell/module/exchange/get-globalmonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-GlobalMonitoringOverride schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-GlobalMonitoringOverride cmdlet to view the overrides of the thresholds and parameters of the managed availability probes, monitors and responders that are configured for all Exchange 2013 or later servers in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-GlobalMonitoringOverride [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,12 +69,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-Group.md b/exchange/exchange-ps/exchange/Get-Group.md index 1d21034c52..b940181519 100644 --- a/exchange/exchange-ps/exchange/Get-Group.md +++ b/exchange/exchange-ps/exchange/Get-Group.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-group -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-group +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-Group schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Get-Group cmdlet to view existing group objects in your organization. This cmdlet returns security groups, mail-enabled security groups, distribution groups, and role groups. +Use the Get-Group cmdlet to view existing group objects in your organization. In all environments, this cmdlet returns mail-enabled security groups, distribution groups, role groups, and room lists. For details about other supported group types in on-premises Exchange environments, see the RecipientTypeDetails parameter description. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,7 +53,7 @@ Get-Group [[-Identity] ] ## DESCRIPTION The Get-Group cmdlet returns no mail-related properties for distribution groups or mail-enabled security groups, and no role group-related properties for role groups. To view the object-specific properties for a group, you need to use the corresponding cmdlet based on the object type (for example, Get-DistributionGroup or Get-RoleGroup). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,6 +80,27 @@ This example uses the Anr parameter to return all groups that begin with "Mar". ## PARAMETERS +### -Identity +The Identity parameter specifies the group object that you want to view. You can use any value that uniquely identifies the group. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: GroupIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -107,7 +128,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -143,16 +164,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -167,33 +188,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the group object that you want to view. You can use any value that uniquely identifies the group. For example: - -- Name -- Distinguished name (DN) -- Canonical DN -- GUID - -```yaml -Type: GroupIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -235,7 +235,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -258,7 +260,10 @@ The RecipientTypeDetails parameter filters the results by the specified group su - MailNonUniversalGroup - MailUniversalDistributionGroup - MailUniversalSecurityGroup +- NonUniversalGroup (on-premises Exchange Server only) - RoomList +- UniversalDistributionGroup (on-premises Exchange Server only) +- UniversalSecurityGroup (on-premises Exchange Server only) You can specify multiple values separated by commas. @@ -266,7 +271,7 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -282,7 +287,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -305,7 +310,7 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -319,12 +324,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-GroupActivityReport.md b/exchange/exchange-ps/exchange/Get-GroupActivityReport.md deleted file mode 100644 index 0f09842141..0000000000 --- a/exchange/exchange-ps/exchange/Get-GroupActivityReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-groupactivityreport -applicable: Exchange Online, Exchange Online Protection -title: Get-GroupActivityReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-GroupActivityReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-GroupActivityReport cmdlet to view the number of distribution groups that were created and deleted in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-GroupActivityReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-GroupActivityReport -ReportType Monthly -StartDate 05/01/2015 -EndDate 05/31/2015 -``` - -This example shows the number of distribution groups created and deleted for the month of May, 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HealthReport.md b/exchange/exchange-ps/exchange/Get-HealthReport.md index 7e514ed7fb..fb4ff840c9 100644 --- a/exchange/exchange-ps/exchange/Get-HealthReport.md +++ b/exchange/exchange-ps/exchange/Get-HealthReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-healthreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-healthreport applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-HealthReport schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-HealthReport cmdlet to return health information for the Exchange server that you specify. You can use the health values to determine the state of the server. The cmdlet also returns an alert value that provides the specific state of your server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ The following list contains the health values that are returned: - Functional - Unavailable -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -159,12 +159,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-HistoricalSearch.md b/exchange/exchange-ps/exchange/Get-HistoricalSearch.md index ec67e2baf8..9aa5b5f171 100644 --- a/exchange/exchange-ps/exchange/Get-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Get-HistoricalSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-historicalsearch +online version: https://learn.microsoft.com/powershell/module/exchange/get-historicalsearch applicable: Exchange Online, Exchange Online Protection title: Get-HistoricalSearch schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-HistoricalSearch cmdlet to view information about historical searches that have been performed within the last ten days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Get-HistoricalSearch [-JobId ] ## DESCRIPTION A historical search provides message trace and report details in a comma-separated value (CSV) file for messages that are less than 90 days old. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,12 +69,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md index 6657ca22ae..ec353acb7a 100644 --- a/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-HoldCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-holdcompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-holdcompliancepolicy +applicable: Security & Compliance title: Get-HoldCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Get-HoldCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-HoldCompliancePolicy to view existing preservation policies in the Microsoft 365 compliance center. +Use the Get-HoldCompliancePolicy to view existing preservation policies in the Microsoft Purview compliance portal. **Note**: The Get-HoldCompliancePolicy cmdlet has been replaced by the Get-RetentionCompliancePolicy cmdlet. If you have scripts that use Get-HoldCompliancePolicy, update them to use Get-RetentionCompliancePolicy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ This list describes the properties displayed by default. - Enabled: The value True means the policy is enabled. - Mode: The current operating mode of the policy. The possible values are Test (the content is tested, but no rules are enforced), AuditAndNotify (when content matches the conditions specified by the policy, the rule is not enforced, but notification emails are sent) or Enforce (all aspects of the policy are enabled and enforced). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -56,39 +56,39 @@ This example displays detailed information for the policy named "Regulation 123 ## PARAMETERS -### -DistributionDetail -The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. +### -Identity +The Identity parameter specifies the preservation policy that you want to view. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: SwitchParameter +Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the preservation policy that you want to view. You can use any value that uniquely identifies the policy. For example: - -- Name -- Distinguished name (DN) -- GUID +### -DistributionDetail +The DistributionDetail switch returns detailed policy distribution information in the DistributionResults property. You don't need to specify a value with this switch. ```yaml -Type: PolicyIdParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -97,12 +97,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md index 24d3189ca5..898c6c476a 100644 --- a/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-HoldComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-holdcompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-holdcompliancerule +applicable: Security & Compliance title: Get-HoldComplianceRule schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Get-HoldComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-HoldComplianceRule to view preservation rules in the Microsoft 365 compliance center. +Use the Get-HoldComplianceRule to view preservation rules in the Microsoft Purview compliance portal. **Note**: The Get-HoldComplianceRule cmdlet has been replaced by the Get-RetentionComplianceRule cmdlet. If you have scripts that use Get-HoldComplianceRule, update them to use Get-RetentionComplianceRule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ This list describes the properties that are displayed by default in the summary - Mode: The current operating mode of the rule (for example, Enforce). - Comment: An administrative comment. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -67,7 +67,7 @@ The Identity parameter specifies the preservation rule you want to view. You can Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -89,7 +89,7 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -103,12 +103,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md index 4c17f8b3fe..95c62d1b40 100644 --- a/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Get-HostedConnectionFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-hostedconnectionfilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedconnectionfilterpolicy applicable: Exchange Online, Exchange Online Protection title: Get-HostedConnectionFilterPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-HostedConnectionFilterPolicy cmdlet to view the settings of connection filter policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +26,7 @@ Get-HostedConnectionFilterPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -110,12 +108,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md index bfc1345fb6..1e40b52a4d 100644 --- a/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Get-HostedOutboundSpamFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection title: Get-HostedOutboundSpamFilterPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-HostedOutboundSpamFilterPolicy cmdlet to view outbound spam filter policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +26,7 @@ Get-HostedOutboundSpamFilterPolicy [-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,12 +91,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HybridConfiguration.md b/exchange/exchange-ps/exchange/Get-HybridConfiguration.md index 3c4dbde527..426766c54c 100644 --- a/exchange/exchange-ps/exchange/Get-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-HybridConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-hybridconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-hybridconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-HybridConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-HybridConfiguration cmdlet to view the hybrid configuration for the Microsoft Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-HybridConfiguration [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,12 +60,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-HybridMailflow.md b/exchange/exchange-ps/exchange/Get-HybridMailflow.md deleted file mode 100644 index b068c0e848..0000000000 --- a/exchange/exchange-ps/exchange/Get-HybridMailflow.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-hybridmailflow -applicable: Exchange Online -title: Get-HybridMailflow -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-HybridMailflow - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet has been deprecated and is no longer used. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-HybridMailflow [] -``` - -## DESCRIPTION -This cmdlet has been deprecated and is no longer used. - -## EXAMPLES - -### Example 1 -```powershell -Get-HybridMailflow -``` - -This cmdlet has been deprecated and is no longer used. - -## 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md b/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md index dc509db0b6..4f793be1a3 100644 --- a/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md +++ b/exchange/exchange-ps/exchange/Get-HybridMailflowDatacenterIPs.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-hybridmailflowdatacenterips +online version: https://learn.microsoft.com/powershell/module/exchange/get-hybridmailflowdatacenterips applicable: Exchange Online title: Get-HybridMailflowDatacenterIPs schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. This cmdlet has been deprecated and is no longer used. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,12 +43,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md b/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md index 839bc5fb83..0da96065e8 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md +++ b/exchange/exchange-ps/exchange/Get-IPAllowListConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ipallowlistconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-IPAllowListConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPAllowListConfig cmdlet to view the configuration information for the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -64,12 +64,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md index c105d837de..7221b9e90b 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md +++ b/exchange/exchange-ps/exchange/Get-IPAllowListEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ipallowlistentry +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-IPAllowListEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPAllowListEntry cmdlet to view the IP address entries in the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -57,35 +57,35 @@ This example returns an IP Allow list entry in which the specified IP address is ## PARAMETERS -### -IPAddress -The IPAddress parameter specifies an IP address to view in the IP Allow list entry or entries. For example, if you have an IP Allow list entry that specifies a range of IP addresses from 192.168.0.1 through 192.168.0.20, enter any IP address in the IP Allow list IP address range to return the IP Allow list entry. +### -Identity +The Identity parameter specifies the identity integer value of the IP Allow list entry that you want to view. When you add an entry to the IP Allow list, the Identity value is automatically assigned. ```yaml -Type: IPAddress -Parameter Sets: IPAddress +Type: IPListEntryIdentity +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True -Position: Named +Required: False +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identity integer value of the IP Allow list entry that you want to view. When you add an entry to the IP Allow list, the Identity value is automatically assigned. +### -IPAddress +The IPAddress parameter specifies an IP address to view in the IP Allow list entry or entries. For example, if you have an IP Allow list entry that specifies a range of IP addresses from 192.168.0.1 through 192.168.0.20, enter any IP address in the IP Allow list IP address range to return the IP Allow list entry. ```yaml -Type: IPListEntryIdentity -Parameter Sets: Identity +Type: IPAddress +Parameter Sets: IPAddress Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False -Position: 1 +Required: True +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -135,12 +135,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md index 7b764ed45f..1d17905936 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Get-IPAllowListProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ipallowlistprovider +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-IPAllowListProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPAllowListProvider cmdlet to view IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,41 +47,41 @@ This example returns detailed information for the IP Allow list provider named C ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the IP Allow list provider that you want to view. You can use any value that uniquely identifies the IP Allow list provider. For example: -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: Fqdn +Type: IPAllowListProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the IP Allow list provider that you want to view. You can use any value that uniquely identifies the IP Allow list provider. For example: +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -- Name -- Distinguished name (DN) -- GUID +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: IPAllowListProviderIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -90,12 +90,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md b/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md index 81c075076a..b56f559df4 100644 --- a/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md +++ b/exchange/exchange-ps/exchange/Get-IPAllowListProvidersConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ipallowlistprovidersconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipallowlistprovidersconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-IPAllowListProvidersConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPAllowListProvidersConfig cmdlet to view the settings that affect all IP Allow list providers that are configured on an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -64,12 +64,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md b/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md index f23243cb3a..517988a7ae 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md +++ b/exchange/exchange-ps/exchange/Get-IPBlockListConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ipblocklistconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-IPBlockListConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPBlockListConfig cmdlet to view the IP Block list configuration information that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -64,12 +64,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md b/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md index 75af86c45d..d6a1d41ce8 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md +++ b/exchange/exchange-ps/exchange/Get-IPBlockListEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ipblocklistentry +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-IPBlockListEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPBlockListEntry cmdlet to view the IP Block list entries that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -135,12 +135,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md index 7334a4aebb..f8849f592d 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Get-IPBlockListProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ipblocklistprovider +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-IPBlockListProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPBlockListProvider cmdlet to view IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,41 +47,41 @@ This example returns detailed information for the existing IP Block list provide ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the IP Block list provider that you want to view. You can use any value that uniquely identifies the IP Block list provider. For example: -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: Fqdn +Type: IPBlockListProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the IP Block list provider that you want to view. You can use any value that uniquely identifies the IP Block list provider. For example: +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -- Name -- Distinguished name (DN) -- GUID +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: IPBlockListProviderIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -90,12 +90,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md b/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md index c0f211743e..f7bcc606fa 100644 --- a/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md +++ b/exchange/exchange-ps/exchange/Get-IPBlockListProvidersConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ipblocklistprovidersconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipblocklistprovidersconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-IPBlockListProvidersConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Get-IPBlockListProvidersConfig cmdlet to view the settings that affect all IP Block list providers that are configured on an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -64,12 +64,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md b/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md new file mode 100644 index 0000000000..e8d7109c9a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-IPv6StatusForAcceptedDomain.md @@ -0,0 +1,117 @@ +--- +external help file: +online version: https://learn.microsoft.com/powershell/module/exchange/get-ipv6statusforaccepteddomain +applicable: Exchange Online +title: Get-IPv6StatusForAcceptedDomain +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-IPv6StatusForAcceptedDomain + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-IPv6StatusForAcceptedDomain cmdlet to view the status of support for mail delivery to accepted domains in Exchange Online using IPv6. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-IPv6StatusForAcceptedDomain [[-Domain] ] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Get-AcceptedDomain cmdlet to return accepted domains in the Exchange Online organization to use with this cmdlet + +If IPv6 is enabled for an accepted domain in Exchange Online, IPv4 and IPv6 addresses are returned in DNS queries for mail flow records of the domain. If IPv6 is disabled, only IPv4 addresses are returned in DNS queries for mail flow records of the domain. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +> [!NOTE] +> +> - When you use the Enable-IPv6ForAcceptedDomain or Disable-IPv6ForAcceptedDomain cmdlets to update the IPv6 setting for an accepted domain, the updated status can take up to an hour to be visible using Get-IPv6StatusForAcceptedDomain due to caching. +> +> For example, Get-IPv6StatusForAcceptedDomain shows the status value Enabled for a domain. You run Disable-IPv6ForAcceptedDomain to disable IPv6 for the domain, you immediately run Get-IPv6StatusForAcceptedDomain to check the status of the domain, and the command erroneously returns the value Enabled. It might take up to an hour before Get-IPv6StatusForAcceptedDomain shows the correct value Disabled for the domain. +> +> - If you receive the following error when running Get-Ipv6StatusForAcceptedDomain: +> +> WARNING: DNS record has unexpected value... +> +> Explicitly enable or disable IPv6 using the Enable-Ipv6ForAcceptedDomain or Disable-Ipv6ForAcceptedDomain cmdlets. + +## EXAMPLES + +### Example 1 +```powershell +Get-IPv6StatusForAcceptedDomain -Domain contoso.com +``` + +This example returns the status of IPv6 support for mail sent to contoso.com. + +## PARAMETERS + +### -Domain +The Domain parameter specifies the accepted domain that you want to view IPv6 status for. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-IRMConfiguration.md b/exchange/exchange-ps/exchange/Get-IRMConfiguration.md index c086f73327..377c44454f 100644 --- a/exchange/exchange-ps/exchange/Get-IRMConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-IRMConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-irmconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-irmconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-IRMConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-IRMConfiguration cmdlet to view the Information Rights Management (IRM) configuration in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-IRMConfiguration [-DomainController ] ## DESCRIPTION The Get-IRMConfiguration cmdlet provides details about the current IRM configuration, including whether individual IRM features are enabled or disabled and provides the URLs used for ServiceLocation, PublishingLocation and LicensingLocation. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,12 +64,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ImapSettings.md b/exchange/exchange-ps/exchange/Get-ImapSettings.md index 5e78cb2ce1..78a0faa6d4 100644 --- a/exchange/exchange-ps/exchange/Get-ImapSettings.md +++ b/exchange/exchange-ps/exchange/Get-ImapSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-imapsettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-imapsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ImapSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ImapSettings cmdlet to view the settings of the Microsoft Exchange IMAP4 service on Exchange servers. This is the client access (frontend) IMAP4 service that clients connect to. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-ImapSettings [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -84,12 +84,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-InboundConnector.md b/exchange/exchange-ps/exchange/Get-InboundConnector.md index 7e43f84434..2447b733ef 100644 --- a/exchange/exchange-ps/exchange/Get-InboundConnector.md +++ b/exchange/exchange-ps/exchange/Get-InboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-inboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/get-inboundconnector applicable: Exchange Online, Exchange Online Protection title: Get-InboundConnector schema: 2.0.0 @@ -16,21 +16,20 @@ This cmdlet is available only in the cloud-based service. Use the Get-InboundConnector cmdlet to view the settings for an Inbound connector in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-InboundConnector [[-Identity] ] + [-ResultSize ] [] ``` ## DESCRIPTION Inbound connectors accept email messages from remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,17 +65,33 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-InboxRule.md b/exchange/exchange-ps/exchange/Get-InboxRule.md index 2b288a3a57..5ed6b13784 100644 --- a/exchange/exchange-ps/exchange/Get-InboxRule.md +++ b/exchange/exchange-ps/exchange/Get-InboxRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-inboxrule -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-inboxrule +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-InboxRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-InboxRule cmdlet to view Inbox rule properties. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,14 +28,17 @@ Get-InboxRule [[-Identity] ] [-DomainController ] [-IncludeHidden] [-Mailbox ] + [-ResultSize ] + [-SkipCount ] [-SweepRules] + [-UseCustomRouting] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -**Note**: This cmdlet doesn't work for members of View-Only Organization Management role group in Exchange Online or the Global Reader role in Azure Active Directory. +**Note**: This cmdlet doesn't work for members of View-Only Organization Management role group in Exchange Online or the Global Reader role in Microsoft Entra ID. ## EXAMPLES @@ -48,13 +51,34 @@ This example retrieves all Inbox rules for the mailbox Joe@Contoso.com. ### Example 2 ```powershell -Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "mm/dd/yyyy" -DescriptionTimeZone "Pacific Standard Time" +Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "MM/dd/yyyy" -DescriptionTimeZone "Pacific Standard Time" ``` This example retrieves the Inbox rule ReceivedLastYear from the mailbox joe@contoso.com on which the ReceivedBeforeDate parameter was set when the rule was created. The DescriptionTimeFormat and DescriptionTimeZone parameters are used in this example to specify formatting of the time and the time zone used in the rule's Description property. ## PARAMETERS +### -Identity +The Identity parameter specifies the Inbox rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- RuleIdentity property (for example, 16752869479666417665). +- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). +- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). + +```yaml +Type: InboxRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -BypassScopeCheck The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. @@ -62,7 +86,7 @@ The BypassScopeCheck switch specifies whether to bypass the scope check for the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -74,7 +98,7 @@ Accept wildcard characters: False ### -DescriptionTimeFormat The DescriptionTimeFormat parameter specifies the format for time values in the rule description. For example: -mm/dd/yyyy, where mm is the 2-digit month, dd is the 2-digit day and yyyy is the 4-digit year. +MM/dd/yyyy, where MM is the 2-digit month, dd is the 2-digit day and yyyy is the 4-digit year. ```yaml Type: String @@ -129,27 +153,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Inbox rule that you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name -- RuleIdentity property (for example, 16752869479666417665). -- Exchange Online: `MailboxAlias\RuleIdentity` (for example, `rzaher\16752869479666417665`). -- On-premises Exchange: `MailboxCanonicalName\RuleIdentity` (for example, `contoso.com/Users/Rick Zaher\16752869479666417665`). - -```yaml -Type: InboxRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IncludeHidden The IncludeHidden switch specifies whether to include hidden Inbox rules in the results. You don't need to specify a value with this switch. @@ -193,6 +196,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SweepRules This parameter is available only in on-premises Exchange. @@ -213,17 +252,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md b/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md index 461437ab13..4ba383b667 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierPoliciesApplicationStatus.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierpoliciesapplicationstatus +applicable: Security & Compliance title: Get-InformationBarrierPoliciesApplicationStatus schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-InformationBarrierPoliciesApplicationStatus ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-InformationBarrierPoliciesApplicationStatus cmdlet to view the application status of information barrier policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,9 +34,9 @@ Get-InformationBarrierPoliciesApplicationStatus [[-Identity] ``` ## DESCRIPTION - For more information, see [View status of information barrier policy application](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#view-status-of-user-accounts-segments-policies-or-policy-application). + For more information, see [View status of information barrier policy application](https://learn.microsoft.com/purview/information-barriers-policies#view-status-of-user-accounts-segments-policies-or-policy-application). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -63,7 +63,7 @@ The Identity parameter specifies the information barrier policy application that Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -81,7 +81,7 @@ If you don't use this switch, the command only returns the most recent policy ap Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,14 +95,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md index 8044e8e038..32c2276297 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierpolicy +applicable: Security & Compliance title: Get-InformationBarrierPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-InformationBarrierPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-InformationBarrierPolicy cmdlet to view information barrier policies in the Microsoft 365 compliance center. +Use the Get-InformationBarrierPolicy cmdlet to view information barrier policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,9 +34,9 @@ Get-InformationBarrierPolicy [[-Identity] ] ``` ## DESCRIPTION -For more information, see [Information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies). +For more information, see [Information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -69,7 +69,7 @@ You can't use this parameter with the ExOPolicyId parameter. Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -87,7 +87,7 @@ You can't use this parameter with the Identity parameter. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,16 +101,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md b/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md index cc3d3e385c..862519808e 100644 --- a/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md +++ b/exchange/exchange-ps/exchange/Get-InformationBarrierRecipientStatus.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-informationbarrierrecipientstatus -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-informationbarrierrecipientstatus +applicable: Security & Compliance title: Get-InformationBarrierRecipientStatus schema: 2.0.0 author: chrisda @@ -12,11 +12,13 @@ ms.reviewer: # Get-InformationBarrierRecipientStatus ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-InformationBarrierRecipientStatus cmdlet to return information about recipients and their relationship to information barrier policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: This cmdlet doesn't work with information barriers in non-legacy mode. To determine your current mode, see [Check the IB mode for your organization](https://learn.microsoft.com/purview/information-barriers-multi-segment#check-the-ib-mode-for-your-organization). If you're in non-legacy mode, run the following command to get information about a single recipient: `Get-Recipient -Identity | Format-List Name,*segment*`. Similarly, to get the relationship information between two recipients, use the **Get-ExoInformationBarrierRelationship** cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +35,7 @@ The following information is returned in the output of this cmdlet: - Basic information about the recipient (display name, alias, and last name). - Recipient properties that can be used in organization segments (Department, CustomAttributeN, etc.) and the current property values for the recipient. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -67,7 +69,7 @@ The Identity parameter specifies the recipient that you want to view the segment Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -94,7 +96,7 @@ You can only use this parameter with the Identity parameter; you can't use it by Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -108,18 +110,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Attributes for information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes) +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md b/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md index 143b062fae..3178fd949a 100644 --- a/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-IntraOrganizationConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-intraorganizationconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-intraorganizationconfiguration applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-IntraOrganizationConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-IntraOrganizationConfiguration cmdlet to view the component settings of a hybrid Exchange deployment. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ A hybrid Exchange deployment results in one logical organization made up of a nu Hybrid environments are enabled by Intra-Organization connectors. The connectors can be created and managed by cmdlets like New-IntraOrganizationConnector, but we strongly recommend that you use the Hybrid Configuration wizard when configuring a hybrid deployment with an Exchange Online organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,12 +66,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md index aae0734b6a..d07a069726 100644 --- a/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/exchange/Get-IntraOrganizationConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-intraorganizationconnector +online version: https://learn.microsoft.com/powershell/module/exchange/get-intraorganizationconnector applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-IntraOrganizationConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-IntraOrganizationConnector cmdlet to view the settings of Intra-Organization connectors. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-IntraOrganizationConnector [[-Identity] ] ## DESCRIPTION The Get-JournalRule cmdlet displays journal rules configured in your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,37 +49,37 @@ This example retrieves the specific journal rule Brokerage Communications and pi ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the rule you want to view. Enter either the name or the GUID of the journal rule. You can omit the parameter label. ```yaml -Type: Fqdn +Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the rule you want to view. Enter either the name or the GUID of the journal rule. You can omit the parameter label. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: RuleIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -88,12 +88,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-Label.md b/exchange/exchange-ps/exchange/Get-Label.md index d85e281023..b2cf3b4226 100644 --- a/exchange/exchange-ps/exchange/Get-Label.md +++ b/exchange/exchange-ps/exchange/Get-Label.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-label -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-label +applicable: Security & Compliance title: Get-Label schema: 2.0.0 author: chrisda @@ -12,22 +12,24 @@ ms.reviewer: # Get-Label ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-Label cmdlet to view sensitivity labels in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-Label [[-Identity] ] - [-IncludeDetailedLabelActions ] + [-IncludeDetailedLabelActions] + [-SkipValidations] + [-ValidateContentTypeRemoval] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -58,7 +60,7 @@ The Identity parameter specifies the sensitivity label that you want to view. Yo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -68,13 +70,45 @@ Accept wildcard characters: False ``` ### -IncludeDetailedLabelActions -{{ Fill IncludeDetailedLabelActions Description }} +The IncludeDetailedLabelActions parameter specifies whether to expand label actions into properties for better readability. You don't need to specify a value with this switch. ```yaml -Type: System.Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipValidations +{{ Fill SkipValidations Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateContentTypeRemoval +{{ Fill ValidateContentTypeRemoval Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -88,12 +122,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-LabelPolicy.md b/exchange/exchange-ps/exchange/Get-LabelPolicy.md index dbf4957be6..7a90fbaa71 100644 --- a/exchange/exchange-ps/exchange/Get-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Get-LabelPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-labelpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-labelpolicy +applicable: Security & Compliance title: Get-LabelPolicy schema: 2.0.0 author: chrisda @@ -12,21 +12,22 @@ ms.reviewer: # Get-LabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-LabelPolicy cmdlet to view sensitivity label policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-LabelPolicy [[-Identity] ] + [-ForceValidate ] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +58,7 @@ The Identity parameter specifies the sensitivity label policy that you want to v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -66,17 +67,29 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -ForceValidate +{{ Fill ForceValidate Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md b/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md deleted file mode 100644 index ac0e3ff55a..0000000000 --- a/exchange/exchange-ps/exchange/Get-LicenseVsUsageSummaryReport.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-licensevsusagesummaryreport -applicable: Exchange Online -title: Get-LicenseVsUsageSummaryReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-LicenseVsUsageSummaryReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-LicenseVsUsageSummaryReport cmdlet to retrieve a report that identifies the number of active users for installed software licenses (workloads). - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-LicenseVsUsageSummaryReport [] -``` - -## DESCRIPTION -This cmdlet produces a report that is intended to enable clients to track and manage the use of contracted software licenses. The output contains the following properties. - -- Date: The period being measured. -- TenantGuid: The unique identifier for the Exchange Online tenant. -- Workload: The workload whose users are being counted. The current workloads include: Exchange Online, SharePoint Online, Skype for Business Online, and Microsoft Yammer. -- NonTrialEntitlements: The number of entitled users for the workload. -- TrialEntitlements: The number of provisionally entitled (trial) users for the workload. -- ActiveUsers: The count of active users for the workload. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-LicenseVsUsageSummaryReport -``` - -This example gets a report of the active workload users. - -## 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-LinkedUser.md b/exchange/exchange-ps/exchange/Get-LinkedUser.md index 272b63c35e..7407a5f12b 100644 --- a/exchange/exchange-ps/exchange/Get-LinkedUser.md +++ b/exchange/exchange-ps/exchange/Get-LinkedUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-linkeduser +online version: https://learn.microsoft.com/powershell/module/exchange/get-linkeduser applicable: Exchange Online title: Get-LinkedUser schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-LinkedUser cmdlet to view existing linked user accounts. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +41,7 @@ Get-LinkedUser [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,6 +61,27 @@ This example returns a detailed information for the linked for the user laura@co ## PARAMETERS +### -Identity +The Identity parameter specifies the linked user that you want to view. You can use any value that uniquely identifies the linked user. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -86,16 +105,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -110,27 +129,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the linked user that you want to view. You can use any value that uniquely identifies the linked user. For example: - -- Name -- Distinguished name (DN) -- Canonical DN -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -OrganizationalUnit This parameter is reserved for internal Microsoft use. @@ -195,12 +193,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-LogonStatistics.md b/exchange/exchange-ps/exchange/Get-LogonStatistics.md index 086af3b554..bfdee00794 100644 --- a/exchange/exchange-ps/exchange/Get-LogonStatistics.md +++ b/exchange/exchange-ps/exchange/Get-LogonStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-logonstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-logonstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-LogonStatistics schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Get-LogonStatistics ## SYNOPSIS -This cmdlet is available or functional only in Exchange Server 2010. +This cmdlet is functional only in Exchange Server 2010. The Get-LogonStatistics cmdlet has been deprecated and is no longer used. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -59,30 +59,6 @@ This example returns logon statistics for all users connected to the server Serv ## PARAMETERS -### -Database -The Database parameter specifies the mailbox database to get logon statistics from (all mailboxes in the specified database). You can use any value that uniquely identifies the mailbox database. For example: - -- Name -- Distinguished name (DN) -- GUID - -This parameter accepts pipeline input from the Get-MailboxDatabase command. - -You can't use this parameter with the Identity or Server parameters. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Identity The Identity parameter specifies the mailbox to get logon statistics from. You can use one of the following values to identify the mailbox: @@ -111,6 +87,30 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Database +The Database parameter specifies the mailbox database to get logon statistics from (all mailboxes in the specified database). You can use any value that uniquely identifies the mailbox database. For example: + +- Name +- Distinguished name (DN) +- GUID + +This parameter accepts pipeline input from the Get-MailboxDatabase command. + +You can't use this parameter with the Identity or Server parameters. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Server The Server parameter specifies the Mailbox server to get logon statistics from (all mailboxes on all databases, including recovery databases, on the specified server). You can use one of the following values to identify the server: @@ -155,12 +155,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md index 10bc658888..c7992e4955 100644 --- a/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-M365DataAtRestEncryptionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection title: Get-M365DataAtRestEncryptionPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-M365DataAtRestEncryptionPolicy cmdlet to view existing Microsoft 365 data-at-rest encryption policies. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,11 +29,11 @@ Get-M365DataAtRestEncryptionPolicy [[-Identity] ] ## DESCRIPTION This cmdlet lists the Microsoft 365 data-at-rest encryption policy that's currently assigned to the tenant. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,12 +50,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailContact.md b/exchange/exchange-ps/exchange/Get-MailContact.md index dd9007f6c9..aa00b27a06 100644 --- a/exchange/exchange-ps/exchange/Get-MailContact.md +++ b/exchange/exchange-ps/exchange/Get-MailContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailcontact +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-MailContact schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailContact cmdlet to view existing mail contacts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,7 +53,7 @@ Get-MailContact [[-Identity] ] ## DESCRIPTION The Get-MailContact cmdlet retrieves all attributes of the specified contact. No parameters are required. If the cmdlet is run without a parameter, a complete list of contacts for the Exchange organization is returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +73,29 @@ This example retrieves detailed information for the mail contact named Arlene. ## PARAMETERS +### -Identity +The Identity parameter specifies the mail contact that you want to view. You can use any value that uniquely identifies the mail contact. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailContactIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -ANR The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -100,7 +123,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -134,16 +157,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -158,35 +181,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the mail contact that you want to view. You can use any value that uniquely identifies the mail contact. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: MailContactIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -228,7 +228,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -311,12 +313,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md index b6dca034da..910389aec2 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailATPReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-maildetailatpreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailatpreport applicable: Exchange Online, Exchange Online Protection title: Get-MailDetailATPReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MailDetailATPReport cmdlet to list details about Exchange Online Protection and Microsoft Defender for Office 365 detections in your cloud-based organization for the last 10 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -54,17 +52,19 @@ For the reporting period you specify, the cmdlet returns the following informati - Domain - Subject - Message Size -- Direction +- Direction: Values are Inbound, Outbound, IntraOrg Or Unknown. Unknown means the messages weren't processed by the filtering stack. In other words, the messages were dropped at the edge before they made it into our filtering stack, so we can't tell the direction for them. - Sender Address - Recipient Address - Event Type +- Bulk complaint level +- Verdict Type - Action - File Name - Malware Name This cmdlet is limited to 10,000 results. If you reach this limit, you can use the available parameters to filter the output. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -94,7 +94,13 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound +- IntraOrg + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -128,7 +134,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018". ```yaml Type: DateTime @@ -167,7 +173,7 @@ The EventType parameter filters the report by the event type. Valid values are: - URL detonation reputation - URL malicious reputation -**Note**: Some values values correspond to features that are only available in Defender for Office 365 (plan 1 and plan 2 or plan 2 only). +**Note**: Some values correspond to features that are available only in Defender for Office 365 (plan 1 and plan 2 or plan 2 only). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -227,7 +233,17 @@ Accept wildcard characters: False ``` ### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +You can specify multiple values separated by commas. + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 ```yaml Type: MultiValuedProperty @@ -325,7 +341,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018". ```yaml Type: DateTime @@ -345,12 +361,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md index 29bec275d9..213354eae3 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailDlpPolicyReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-maildetaildlppolicyreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetaildlppolicyreport applicable: Exchange Online title: Get-MailDetailDlpPolicyReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MailDetailDlpPolicyReport cmdlet to view the details of messages that matched the conditions defined by any data loss prevention (DLP) policies. This cmdlet works on messages that were sent within the last seven days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +40,7 @@ Get-MailDetailDlpPolicyReport [-Action ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,7 +72,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -124,7 +127,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -182,7 +185,17 @@ Accept wildcard characters: False ``` ### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +You can specify multiple values separated by commas. + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 ```yaml Type: MultiValuedProperty @@ -280,7 +293,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -316,12 +329,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md new file mode 100644 index 0000000000..62ff5f0f00 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailDetailEncryptionReport.md @@ -0,0 +1,298 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailencryptionreport +applicable: Exchange Online, Security & Compliance, Exchange Online Protection +title: Get-MailDetailEncryptionReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailDetailEncryptionReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailDetailEncryptionReport cmdlet to view the details of encryption in your cloud-based organization for the last 10 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailDetailEncryptionReport [[-Organization] ] + [-AggregateBy ] + [-Direction ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-MessageId ] + [-MessageTraceId ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following default information: + +- DateTime +- Message ID +- Message Trace ID + +If you append the command with ` | Format-List`, the following additional information is returned: + +- Domain +- Direction +- Recipient Address +- Sender IP +- Sender Address +- Message Size +- Subject + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailDetailEncryptionReport -StartDate 12/13/2021 -EndDate 12/15/2021 +``` + +This example retrieves encryption details for messages between December 13, 2021 and December 15, 2021. + +## PARAMETERS + +### -Organization +{{ Fill Organization Description }} + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregateBy +The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- EncryptionManual +- EncryptionPolicy + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type must correspond to the report. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +You can specify multiple values separated by commas. + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailDetailMalwareReport.md b/exchange/exchange-ps/exchange/Get-MailDetailMalwareReport.md deleted file mode 100644 index 0c9de9dc9e..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailDetailMalwareReport.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-maildetailmalwarereport -applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailMalwareReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailDetailMalwareReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet will be deprecated. Use the **Get-MailDetailATPReport** cmdlet instead. - -Use the Get-MailDetailMalwareReport cmdlet to view the details of messages that contained malware for the last 10 days. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-MailDetailMalwareReport [-Action ] - [-Direction ] - [-Domain ] - [-EndDate ] - [-EventType ] - [-MalwareName ] - [-MessageId ] - [-MessageTraceId ] - [-Page ] - [-PageSize ] - [-ProbeTag ] - [-RecipientAddress ] - [-SenderAddress ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-MailDetailMalwareReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@contoso.com -``` - -This example retrieves the details of messages sent by john@contoso.com that contained malware between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- AdvancedProtectionMalware -- AtpGoodMail -- Malware - -To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify malware events types for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MalwareName -The MalwareName parameter filters the report by the name of the malware. You can specify multiple values separated by commas. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageId -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailDetailSpamReport.md b/exchange/exchange-ps/exchange/Get-MailDetailSpamReport.md deleted file mode 100644 index 0fe0c7a129..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailDetailSpamReport.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-maildetailspamreport -applicable: Exchange Online, Exchange Online Protection -title: Get-MailDetailSpamReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailDetailSpamReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet will be deprecated. Use the **Get-MailDetailATPReport** cmdlet instead. - -Use the Get-MailDetailSpamReport cmdlet to view the details of spam messages for the last 10 days. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-MailDetailSpamReport [-Action ] - [-Direction ] - [-Domain ] - [-EndDate ] - [-EventType ] - [-MessageId ] - [-MessageTraceId ] - [-Page ] - [-PageSize ] - [-ProbeTag ] - [-RecipientAddress ] - [-SenderAddress ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-MailDetailSpamReport -StartDate 06/13/2015 -EndDate 06/15/2015 -SenderAddress john@contoso.com -``` - -This example retrieves the details of spam messages sent by john@contoso.com between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- BCL0 to BCL9 -- NonSpam_AdditionalSpamFilterPassed -- NonSpam_BulkPassed -- NonSpam_ContentScanPassed -- NonSpam_ETRPassed -- NonSpam_IntraOrg -- NonSpam_IPAllowed -- NonSpam_SafeSender -- Spam_AdditionalSpamFiltered -- Spam_BulkFiltered -- Spam_ContentScanFiltered -- Spam_ETRFiltered -- Spam_SenderBlocked -- SpamContentFiltered -- SpamDBEBFilter -- SpamEnvelopeBlock -- SpamIPBlock - -To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type you specify must correspond to the report. For example, you can only specify spam event types for spam reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageId -The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderAddress -The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md index e829764fde..ca463e1112 100644 --- a/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md +++ b/exchange/exchange-ps/exchange/Get-MailDetailTransportRuleReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-maildetailtransportrulereport +online version: https://learn.microsoft.com/powershell/module/exchange/get-maildetailtransportrulereport applicable: Exchange Online, Exchange Online Protection title: Get-MailDetailTransportRuleReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MailDetailTransportRuleReport cmdlet to view the details of messages that matched the conditions defined by any transport rules for the last 10 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +39,7 @@ Get-MailDetailTransportRuleReport [-Action ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,7 +71,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -107,7 +110,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -164,7 +167,17 @@ Accept wildcard characters: False ``` ### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +You can specify multiple values separated by commas. + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MessageTraceV2 +- Get-MessageTraceDetailV2 ```yaml Type: MultiValuedProperty @@ -262,9 +275,9 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". -This parameter can´t be older than 30 days from the current day. +Although you can enter a date up to 30 days old, only data from the last 10 days is returned. ```yaml Type: DateTime @@ -300,12 +313,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md b/exchange/exchange-ps/exchange/Get-MailFilterListReport.md index 69eae3e9d7..4fe3fbe363 100644 --- a/exchange/exchange-ps/exchange/Get-MailFilterListReport.md +++ b/exchange/exchange-ps/exchange/Get-MailFilterListReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailfilterlistreport -applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailfilterlistreport +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-MailFilterListReport schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MailFilterListReport cmdlet to obtain values for various parameters that can be supplied to other reporting cmdlets. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Get-MailFilterListReport ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,7 +50,7 @@ The Domain parameter filters the results by an accepted domain in the cloud-base Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -62,7 +60,7 @@ Accept wildcard characters: False ``` ### -Expression -This parameter is available only in Security & Compliance Center PowerShell. +This parameter is available only in Security & Compliance PowerShell. This parameter is reserved for internal Microsoft use. @@ -70,7 +68,7 @@ This parameter is reserved for internal Microsoft use. Type: Expression Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -86,7 +84,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -110,7 +108,7 @@ The SelectionTarget parameter filters the report information by object type. Val Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -124,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md index 22cfff8125..eea8f2f7e7 100644 --- a/exchange/exchange-ps/exchange/Get-MailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Get-MailPublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailpublicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailpublicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailPublicFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailPublicFolder cmdlet to retrieve mail-related information about mail-enabled public folders. If you want information about the basic (not mail-related) settings of mail-enabled public folders, use the Get-PublicFolder cmdlet instead. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,6 +27,7 @@ Get-MailPublicFolder [-Anr ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-ReadFromDomainController] [-ResultSize ] [-Server ] @@ -40,6 +41,7 @@ Get-MailPublicFolder [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-ReadFromDomainController] [-ResultSize ] [-Server ] @@ -47,7 +49,7 @@ Get-MailPublicFolder [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,6 +76,24 @@ This example returns all mail-enabled public folders that begin with the word Ma ## PARAMETERS +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. + +You can omit the parameter label so that only the public folder name or GUID is supplied. + +```yaml +Type: MailPublicFolderIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -99,7 +119,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -133,16 +153,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -157,37 +177,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. +### -IgnoreDefaultScope +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -You can omit the parameter label so that only the public folder name or GUID is supplied. +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. ```yaml -Type: MailPublicFolderIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +### -IncludeGrantSendOnBehalfToWithDisplayNames +This parameter is available only in the cloud-based service. -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. +{{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online Required: False Position: Named @@ -199,7 +219,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -285,12 +307,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md index 730e1aae20..b18dc3f97a 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficatpreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficatpreport applicable: Exchange Online, Exchange Online Protection title: Get-MailTrafficATPReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MailTrafficATPReport cmdlet to view the results of Exchange Online Protection and Microsoft Defender for Office 365 detections in your cloud-based organization for the last 90 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,6 +35,7 @@ Get-MailTrafficATPReport [-ProbeTag ] [-StartDate ] [-SummarizeBy ] + [-ThreatClassification ] [] ``` @@ -47,43 +46,29 @@ Safe Links is a feature in Microsoft Defender for Office 365 that checks links i For the reporting period you specify, the cmdlet returns the following information: -- Domain - Date - Event Type - Direction -- Action -- SubType -- Policy Source - Verdict Source -- Delivery Status - Message Count -To see all of these columns (width issues), write the output to a file. For example, `Get-MailTrafficATPReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\Mail Traffic ATP Report.txt"`. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-MailTrafficATPReport -Direction Inbound -StartDate 06/13/2018 -EndDate 06/15/2018 +Get-MailTrafficATPReport ``` -This example retrieves details for incoming messages between June 13, 2018 and June 15, 2018. +This example retrieves details for messages for the last 92 days. ### Example 2 ```powershell -Get-MailTrafficATPReport -StartDate 7/20/2018 -EndDate 7/20/2018 -Direction Outbound | Format-Table Domain,Date,EventType,Action,MessageCount -``` - -This example retrieves the statistics for outgoing messages on July 20, 2018 and displays the results in a table. Every unique combination of EventType and Action is displayed on a separate row in the table. - -### Example 3 -```powershell -Get-MailTrafficATPReport -StartDate 7/20/2018 -EndDate 7/20/2018 -Direction Outbound -SummarizeBy Domain,EventType | Format-Table Domain,Date,EventType,Action,MessageCount +Get-MailTrafficATPReport -StartDate (Get-Date "12/25/2021 12:01 AM").ToUniversalTime() -EndDate (Get-Date "12/25/2021 11:59 PM").ToUniversalTime() -Direction Outbound ``` -This example is similar to the previous example, but now the results are summarized. Because EventType is one of the summarized values, the rows in the table now contain the unique values of Action. The total number of rows in the report is reduced and values of MessageCount are correspondingly larger on each row. +This example retrieves the statistics for outgoing messages on December 25, 2021 and displays the results in a table. ## PARAMETERS @@ -122,7 +107,13 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound +- IntraOrg + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -138,7 +129,7 @@ Accept wildcard characters: False ``` ### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas. ```yaml Type: MultiValuedProperty @@ -154,9 +145,14 @@ Accept wildcard characters: False ``` ### -EndDate -The EndDate parameter specifies the end date of the date range. +The EndDate parameter specifies the end of the date range in Coordinated Universal Time (UTC). -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +If you use this parameter, you also need to use the StartDate parameter. ```yaml Type: DateTime @@ -195,7 +191,7 @@ The EventType parameter filters the report by the event type. Valid values are: - URL detonation reputation - URL malicious reputation -**Note**: Some values values correspond to features that are only available in Defender for Office 365 (plan 1 and plan 2 or plan 2 only). +**Note**: Some values correspond to features that are available only in Defender for Office 365 (plan 1 and plan 2 or plan 2 only). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -293,9 +289,14 @@ Accept wildcard characters: False ``` ### -StartDate -The StartDate parameter specifies the start date of the date range. +The StartDate parameter specifies the start of the date range in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +If you use this parameter, you also need to use the EndDate parameter. ```yaml Type: DateTime @@ -313,7 +314,7 @@ Accept wildcard characters: False ### -SummarizeBy The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. -Valid values are: +For this cmdlet, valid values are: - Action - Direction @@ -335,17 +336,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThreatClassification +{{ Fill ThreatClassification Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md new file mode 100644 index 0000000000..8fe274f754 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailTrafficEncryptionReport.md @@ -0,0 +1,273 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficencryptionreport +applicable: Exchange Online, Security & Compliance, Exchange Online Protection +title: Get-MailTrafficEncryptionReport +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailTrafficEncryptionReport + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailTrafficEncryptionReport cmdlet to view the results of encryption in your cloud-based organization for the last 92 days. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailTrafficEncryptionReport + [-Action ] + [-AggregateBy ] + [-Direction ] + [-Domain ] + [-EndDate ] + [-EventType ] + [-Page ] + [-PageSize ] + [-ProbeTag ] + [-StartDate ] + [-SummarizeBy ] + [] +``` + +## DESCRIPTION +For the reporting period you specify, the cmdlet returns the following information: + +- DateTime +- Event Type +- Direction +- Action +- Message Count +- Recipient Count + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailTrafficEncryptionReport -Direction Inbound -StartDate 12/13/2021 -EndDate 12/15/2021 +``` + +This example retrieves encryption information for incoming messages between December 13, 2021 and December 15, 2021. + +## PARAMETERS + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AggregateBy +The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain +The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EventType +The EventType parameter filters the report by the event type. Valid values are: + +- EncryptionManual +- EncryptionPolicy + +To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type must correspond to the report. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Page +The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProbeTag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SummarizeBy +The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. + +For this cmdlet, valid values are: + +- Action +- Domain +- EventType + +You can specify multiple values separated by commas. When you specify the values Action or Domain, the value is not displayed in the results (the values in the corresponding columns are blank). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md index 5baf7e936a..f1ab603a7f 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficpolicyreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficpolicyreport applicable: Exchange Online, Exchange Online Protection title: Get-MailTrafficPolicyReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MailTrafficPolicyReport cmdlet to view statistics about messages that were affected by data loss prevention (DLP) policies and transport rules for the last 90 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -50,7 +48,7 @@ For the reporting period you specify, the cmdlet returns the following informati - Direction - Message Count -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -112,7 +110,12 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -162,7 +165,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -256,7 +259,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -274,7 +277,7 @@ Accept wildcard characters: False ### -SummarizeBy The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. -Valid values are: +For this cmdlet, valid values are: - Action - Direction @@ -319,12 +322,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficReport.md deleted file mode 100644 index c499290986..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailTrafficReport.md +++ /dev/null @@ -1,381 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficreport -applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailTrafficReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet will be deprecated. Use the **Get-MailFlowStatusReport** and **Get-MailTrafficATPReport** cmdlets instead. - -Use the Get-MailTrafficReport cmdlet to view details about message traffic in your organization for the last 90 days. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-MailTrafficReport - [-Action ] - [-AggregateBy ] - [-Direction ] - [-Domain ] - [-EndDate ] - [-EventType ] - [-Page ] - [-PageSize ] - [-ProbeTag ] - [-StartDate ] - [-SummarizeBy ] - [] -``` - -## DESCRIPTION -For the reporting period you specify, the cmdlet returns the following information: - -- Domain (note that this value is populated only when you use the Domain parameter) -- Date -- Event Type -- Direction -- Action -- Message Count -- Recipient Count - -You can use the EventType values from the Get-MailTrafficReport cmdlet to analyze what happened to messages when they were filtered by the service. The following list describes the event types for messages. - -Mail traffic summary - -- AdvancedProtectionMalware: Messages that were marked as malware by Microsoft Defender for Office 365. For details about Defender for Office 365, see [Microsoft Defender for Office 365 service description](https://docs.microsoft.com/office365/servicedescriptions/office-365-advanced-threat-protection-service-description). -- AtpGoodMail: Messages that were delivered after passing through Defender for Office 365. This count shows the number of unique messages. If a message was delivered to multiple recipients, it would still count as a single message. -- DLPMessages: Messages that matched a data loss prevention (DLP) policy. For details about data loss prevention, see [Overview of data loss prevention](https://docs.microsoft.com/microsoft-365/compliance/data-loss-prevention-policies). -- Expire: Messages that cannot be delivered, stuck in a queue, and after some time expired. -- GoodMail: Messages that were delivered after passing through the malware and spam filters. This count shows the number of unique messages. If a message was delivered to multiple recipients, it would still count as a single message. -- Malware: Messages that were marked as malware. -- Receive: Messages successfully received by the service. -- SpoofMail: Messages that were marked as spoofed by anti-spoofing protection. -- TransportRuleHits: Messages that matched a transport rule. If a message matched multiple rules, this event type would show each of the rule matches. -- TransportRuleMessages: Messages that matched a transport rule. If a message matched multiple rules, this event type would show each of the rule matches. - -Spam detections - -- SpamIPBlock: Messages that were blocked based on the sender IP. -- SpamDBEBFilter: Messages that were blocked based on checking the recipient against the directory. This happens when a message is addressed to an unknown recipient. -- SpamEnvelopeBlock: Messages that were blocked based on SMTP. -- SpamContentFiltered: Messages that passed the initial IP and SMTP filters and were filtered based on content, rules or other spam configurations. - -Spam analysis - content-filtered spam - -- Spam\_AdditionalSpamFiltered: Messages filtered based on advanced spam filters that have been enabled. For details about the advanced spam filter, see [Advanced spam filtering options](https://docs.microsoft.com/microsoft-365/security/office-365-security/advanced-spam-filtering-asf-options). -- Spam\_BlockList: Messages that were filtered because the sender was on a spam filter block list. For more details on how to configure these lists, see [Configure your spam filter policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-your-spam-filter-policies). -- Spam\_BulkFiltered: Messages that were filtered as bulk mail. See message volume breakdown by Bulk Complaint Level (BCL) for further analysis of bulk mail. For more information about bulk mail processing, see [What's the difference between junk email and bulk email?](https://docs.microsoft.com/microsoft-365/security/office-365-security/what-s-the-difference-between-junk-email-and-bulk-email). -- Spam\_ContentScanFiltered: Messages that were filtered based on the message content. -- Spam\_ETRFiltered: Messages that were filtered due to a transport rule. -- Spam\_SenderBlocked: Messages that were filtered because the sender was on a block list. - -Spam analysis - non-spam messages - -- NonSpam\_AdditionalSpamFilterPassed: Messages that were passed based on advanced spam filters that have been enabled. For details about the advanced spam filters, see [Advanced spam filtering options](https://docs.microsoft.com/microsoft-365/security/office-365-security/advanced-spam-filtering-asf-options). -- NonSpam\_AllowList: Messages that were passed because the sender was on a spam filter allow list. For more details on how to configure these lists, see [Configure your spam filter policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-your-spam-filter-policies). -- NonSpam\_BulkPassed: Messages that were determined not to be bulk mail. -- NonSpam\_ContentScanPassed: Messages that were passed by the content scan. -- NonSpam\_ETRPassed: Messages that passed based on a transport rule. -- NonSpam\_IntraOrg: Messages that were deemed as low risk of spam based on factors such as intra-organizational mail. -- NonSpam\_IPAllowed: Messages that were passed because the sending IP was on the IP allow list. -- NonSpam\_SafeSender: Messages that were passed because the sender was marked as safe. - -Bulk mail - -- BCL0: Messages that are not bulk mail are marked with Bulk Complaint Level (BCL) value of 0. For details on how to use BCL to mark messages as spam, see [Use mail flow rules to configure bulk email filtering in Exchange Online Protection](https://docs.microsoft.com/microsoft-365/security/office-365-security/use-transport-rules-to-configure-bulk-email-filtering). -- BCL1 through BCL9: Messages with BCL rating of 1 through 9. - -Encryption - -- EncryptionManual: Messages manually encrypted by users. -- EncryptionPolicy: Messages that matched a rule for encrypting email messages using the latest Office 365 Message Encryption (OME) capabilities. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-MailTrafficReport -Direction Inbound -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves details for incoming messages between June 13, 2015 and June 15, 2015. - -### Example 2 -```powershell -Get-MailTrafficReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound | Format-Table Domain,Date,EventType,Action,MessageCount -``` - -This example retrieves the statistics for outgoing messages on December 12, 2015, and displays the results in a table. Every unique combination of EventType and Action is displayed on a separate row in the table. - -### Example 3 -```powershell -Get-MailTrafficReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound -SummarizeBy EventType | Format-Table Domain,Date,Action,MessageCount -``` - -This example is similar to the previous example, but now the results are summarized. Because the EventType is one of the summarized values, the rows in the table now contain the unique values of Action. The total number of rows in the report is reduced, and values of MessageCount are correspondingly larger on each row. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day, or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas, or the value All. - -If you don't use the Domain parameter, the message count for your entire organization is returned. This includes messages that were sent from or to unregistered domains that are attributed to your organization. Unregistered domains can be attributed to your organization in hybrid or EOP standalone configurations. - -**Notes**: - -- Messages that are sent to recipients in multiple domains are counted differently at the domain level versus the organizational level. At the domain level, the message is counted for each different domain. At the organizational level, the message is counted only once. Therefore, if you add up the total number of received messages for each domain, the value might not match the total number of received messages for the organization. -- The Domain value is Others for messages that were sent from or to unregistered domains that are attributed to your organization (messages in domains that aren't configured as accepted domains in your organization). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- AdvancedProtectionMalware -- AtpGoodMail -- BCL0 to BCL9 -- DLPMessages -- EncryptionManual -- EncryptionPolicy -- Expire -- GoodMail -- Malware -- NonSpam_AdditionalSpamFilterPassed -- NonSpam_AllowList -- NonSpam_BulkPassed -- NonSpam_ContentScanPassed -- NonSpam_ETRPassed -- NonSpam_IntraOrg -- NonSpam_IPAllowed -- NonSpam_SafeSender -- Receive -- SpamContentFiltered -- SpamDBEBFilter -- SpamEnvelopeBlock -- SpamIPBlock -- Spam_AdditionalSpamFiltered -- Spam_BlockList -- Spam_BulkFiltered -- Spam_ContentScanFiltered -- Spam_ETRFiltered -- Spam_SenderBlocked -- SpoofMail -- SpoofMailCompAuthResult -- TransportRuleMessages - -To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type must correspond to the report. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. - -Valid values are: - -- Action -- Domain -- EventType - -You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md index 3629381ac0..5ef4d9692a 100644 --- a/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md +++ b/exchange/exchange-ps/exchange/Get-MailTrafficSummaryReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailtrafficsummaryreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailtrafficsummaryreport applicable: Exchange Online, Exchange Online Protection title: Get-MailTrafficSummaryReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MailTrafficSummaryReport cmdlet to view summary information about message traffic in your organization for the last 90 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +40,7 @@ This cmdlet has C1, C2 and C3 as header names and the meaning of them depends on - TopSpamRecipient, TopMailSender, TopMailRecipient and TopMalwareRecipient: C1 is the recipient or sender and C2 the quantity of email messages. - TopMalware: C1 is the malware name and C2 the quantity of appearances. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,7 +54,31 @@ This example shows the top spam recipient statistics between June 13, 2015 and J ## PARAMETERS ### -Category -The Category parameter filters the report by category. Valid values for this parameter are: InboundDLPHits, OutboundDLPHits, InboundTransportRuleHits, OutboundTransportRuleHits, InboundDLPPolicyRuleHits, OutboundDLPPolicyRuleHits, TopSpamRecipient, TopMailSender, TopMailRecipient, TopMalwareRecipient or TopMalware. +The Category parameter filters the report by category. Valid values are: + +- InboundDLPHits +- OutboundDLPHits +- InboundTransportRuleHits +- OutboundTransportRuleHits +- InboundDLPPolicyRuleHits +- OutboundDLPPolicyRuleHits +- TopSpamRecipient +- TopMailSender +- TopMailRecipient +- TopMalwareRecipient +- TopMalwareAtpRecipient +- TopMalware +- TopPhishRecipient +- TopPhishAtpRecipient +- TopIntraOrgRecipient +- TopIntraOrgSender +- TopIntraOrgSpamRecipient +- TopIntraOrgMalwareRecipient +- TopIntraOrgPhishRecipient +- TopIntraOrgPhishAtpRecipient +- TopIntraOrgMalwareAtpRecipient +- TopComplianceTagActivityCount +- TopComplianceTagActivityCountByDay ```yaml Type: String @@ -106,7 +128,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -172,7 +194,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -208,12 +230,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md b/exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md deleted file mode 100644 index 9962b83a19..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailtraffictopreport -applicable: Exchange Online, Exchange Online Protection -title: Get-MailTrafficTopReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailTrafficTopReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-MailTrafficTopReport cmdlet to view a report of the highest volume senders, recipients, malware recipients and spam recipients in your organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-MailTrafficTopReport [-Action ] - [-AggregateBy ] - [-Direction ] - [-Domain ] - [-EndDate ] - [-EventType ] - [-Page ] - [-PageSize ] - [-ProbeTag ] - [-StartDate ] - [-SummarizeBy ] - [] -``` - -## DESCRIPTION -For the reporting period you specify, the cmdlet returns the following information: - -- Domain -- Date -- Name -- Event Type -- Direction -- Count - -To see all of these columns (width issues), write the output to a file. For example, `Get-MailTrafficTopReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\Mail Traffic Top Report.txt"`. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-MailTrafficTopReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example shows the highest volume senders, recipients, malware recipients and spam recipients between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Action -The Action parameter filters the report by the action taken by DLP policies, transport rules, malware filtering or spam filtering. To view the complete list of valid values for this parameter, run the command Get-MailFilterListReport -SelectionTarget Actions. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AggregateBy -The AggregateBy parameter specifies the reporting period. Valid values are Hour, Day or Summary. The default value is Day. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid values are Inbound and Outbound. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -The Domain parameter filters the results by an accepted domain in the cloud-based organization. You can specify multiple domain values separated by commas or the value All. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -The EventType parameter filters the report by the event type. Valid values are: - -- TopEncryptionRecipient -- TopMailUser -- TopMalware -- TopMalwareUser -- TopSpamUser - -To view the potential list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget EventTypes`. The event type must correspond to the report. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProbeTag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report. - -Valid values are: - -- Domain -- EventType - -You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailUser.md b/exchange/exchange-ps/exchange/Get-MailUser.md index 9cd81bc7b7..acaf5fe057 100644 --- a/exchange/exchange-ps/exchange/Get-MailUser.md +++ b/exchange/exchange-ps/exchange/Get-MailUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailuser +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-MailUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailUser cmdlet to view mail users and also guest users for Microsoft 365 Groups in cloud environments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,6 +30,7 @@ Get-MailUser [-Anr ] [-OrganizationalUnit ] [-ReadFromDomainController] [-ResultSize ] + [-SharedWithMailUser] [-SoftDeletedMailUser] [-SortBy ] [] @@ -45,13 +46,39 @@ Get-MailUser [[-Identity] ] [-OrganizationalUnit ] [-ReadFromDomainController] [-ResultSize ] + [-SharedWithMailUser] [-SoftDeletedMailUser] [-SortBy ] [] ``` +### LOBAppAccount +``` +Get-MailUser [-LOBAppAccount] + [-Filter ] + [-OrganizationalUnit ] + [-ProgressAction ] + [-ResultSize ] + [-SharedWithMailUser] + [-SoftDeletedMailUser] + [-SortBy ] + [] +``` + +### HVEAccount +``` +Get-MailUser [-HVEAccount] + [-Filter ] + [-OrganizationalUnit ] + [-ResultSize ] + [-SharedWithMailUser] + [-SortBy ] + [-SoftDeletedMailUser] + [] +``` + ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +98,29 @@ This example returns detailed information for the mail user named Ed. ## PARAMETERS +### -Identity +The Identity parameter specifies the mail user that you want to view. You can use any value that uniquely identifies the mail user. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailUserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: false +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -98,11 +148,11 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential -Parameter Sets: (All) +Parameter Sets: AnrSet, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -120,7 +170,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: AnrSet, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -132,16 +182,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -156,42 +206,37 @@ Accept pipeline input: false Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the mail user that you want to view. You can use any value that uniquely identifies the mail user. For example: +### -HVEAccount +This parameter is available only in the cloud-based service. -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID +The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. ```yaml -Type: MailUserIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: LOBAppAccount Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Exchange Online Protection -Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: false +Required: False +Accept pipeline input: False Accept wildcard characters: False ``` ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: AnrSet, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -202,6 +247,24 @@ Accept pipeline input: false Accept wildcard characters: False ``` +### -LOBAppAccount +This parameter is available only in the cloud-based service. + +{{ Fill LOBAppAccount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: LOBAppAccount +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OrganizationalUnit The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: @@ -226,13 +289,15 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: AnrSet, Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -259,6 +324,24 @@ Accept pipeline input: false Accept wildcard characters: False ``` +### -SharedWithMailUser +This parameter is available only in the cloud-based service. + +{{ Fill SharedWithMailUser Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AnrSet, Identity +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SortBy The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order. @@ -309,12 +392,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-Mailbox.md b/exchange/exchange-ps/exchange/Get-Mailbox.md index 306eda9c6d..cae3773fe1 100644 --- a/exchange/exchange-ps/exchange/Get-Mailbox.md +++ b/exchange/exchange-ps/exchange/Get-Mailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-Mailbox schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-Mailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks. -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailbox cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailbox cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,6 +35,12 @@ Get-Mailbox [-Anr ] [-GroupMailbox] [-IgnoreDefaultScope] [-InactiveMailboxOnly] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-Monitoring] @@ -88,6 +94,12 @@ Get-Mailbox [[-Identity] ] [-GroupMailbox] [-IgnoreDefaultScope] [-InactiveMailboxOnly] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-Monitoring] @@ -135,6 +147,12 @@ Get-Mailbox [-MailboxPlan ] [-Filter ] [-GroupMailbox] [-InactiveMailboxOnly] + [-IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] + [-IncludeAcceptMessagesOnlyFromWithDisplayNames] + [-IncludeEmailAddressDisplayNames] + [-IncludeForwardingAddressWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] [-IncludeInactiveMailbox] [-Migration] [-OrganizationalUnit ] @@ -149,7 +167,7 @@ Get-Mailbox [-MailboxPlan ] ## DESCRIPTION When you use the Get-Mailbox cmdlet in on-premises Exchange environments to view the quota settings for a mailbox, you first need to check the value of the UseDatabaseQuotaDefaults property. The value True means per-mailbox quota settings are ignored, and you need to use the Get-MailboxDatabase cmdlet to see the actual values. If the UseDatabaseQuotaDefaults property is False, the per-mailbox quota settings are used, so what you see with the Get-Mailbox cmdlet are the actual quota values for the mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -176,10 +194,10 @@ This example returns all the mailboxes that resolve from the ambiguous name reso ### Example 4 ```powershell -Get-Mailbox -Archive -Server Mailbox01 +Get-Mailbox -Archive -Database MBXDB01 ``` -This example returns a summary list of all archive mailboxes on the Mailbox server named Mailbox01. +This example returns a summary list of all archive mailboxes in the database named MBXDB01. ### Example 5 ```powershell @@ -190,6 +208,35 @@ This example returns information about the remote archive mailbox for the user e ## PARAMETERS +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +You can't use this parameter with the Anr, Database, MailboxPlan or Server parameters. + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -215,7 +262,7 @@ Accept wildcard characters: False ### -Arbitration This parameter is available only in on-premises Exchange. -The Arbitration switch is required to return arbitration mailboxes in the results. You don't need to specify a value with this switch. +The Arbitration switch specifies whether to return only arbitration mailboxes in the results. You don't need to specify a value with this switch. Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow. @@ -235,7 +282,7 @@ Accept wildcard characters: False ``` ### -Archive -The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch. +The Archive switch specifies whether to return only mailboxes that have an archive enabled in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -253,7 +300,7 @@ Accept wildcard characters: False ### -AuditLog This parameter is available only in on-premises Exchange. -The AuditLog switch is required to return audit log mailboxes in the results. You don't need to specify a value with this switch. +The AuditLog switch specifies whether to return only audit log mailboxes in the results. You don't need to specify a value with this switch. Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. @@ -275,7 +322,7 @@ Accept wildcard characters: False ### -AuxAuditLog This parameter is available only in on-premises Exchange. -The AuxAuditLog switch is required to return auxiliary audit log mailboxes in the results. You don't need to specify a value with this switch. +The AuxAuditLog switch specifies whether to return only auxiliary audit log mailboxes in the results. You don't need to specify a value with this switch. Audit log mailboxes are arbitration mailboxes that are used to store audit log settings. @@ -299,7 +346,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -357,16 +404,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -382,7 +429,7 @@ Accept wildcard characters: False ``` ### -GroupMailbox -The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. +The GroupMailbox switch specifies whether to return only Microsoft 365 Groups in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -397,41 +444,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -You can't use this parameter with the Anr, Database, MailboxPlan or Server parameters. - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -471,6 +489,114 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAcceptMessagesOnlyFromDLMembersWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAcceptMessagesOnlyFromWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAcceptMessagesOnlyFromWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeEmailAddressDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeEmailAddressDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeForwardingAddressWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeForwardingAddressWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill IncludeGrantSendOnBehalfToWithDisplayNames Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, MailboxPlanSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeInactiveMailbox This parameter is available only in the cloud-based service. @@ -522,7 +648,7 @@ Accept wildcard characters: False ``` ### -Migration -The Migration switch is required to return migration mailboxes in the results. You don't need to specify a value with this switch. +The Migration switch specifies whether to return only migration mailboxes in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -540,7 +666,7 @@ Accept wildcard characters: False ### -Monitoring This parameter is available only in on-premises Exchange. -The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch. +The Monitoring switch specifies whether to return only monitoring mailboxes in the results. You don't need to specify a value with this switch. Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox. @@ -579,7 +705,7 @@ Accept wildcard characters: False ``` ### -PublicFolder -The PublicFolder switch is required to return public folder mailboxes in the results. You don't need to specify a value with this switch. +The PublicFolder switch specifies whether to return only public folder mailboxes in the results. You don't need to specify a value with this switch. Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. @@ -599,7 +725,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -621,14 +749,14 @@ The RecipientTypeDetails parameter filters the results by the specified mailbox - DiscoveryMailbox - EquipmentMailbox -- GroupMailbox +- GroupMailbox (Exchange 2013 or later and cloud) - LegacyMailbox - LinkedMailbox -- LinkedRoomMailbox +- LinkedRoomMailbox (Exchange 2013 or later and cloud) - RoomMailbox -- SchedulingMailbox +- SchedulingMailbox (Exchange 2016 or later and cloud) - SharedMailbox -- TeamMailbox +- TeamMailbox (Exchange 2013 or later and cloud) - UserMailbox You can specify multiple values separated by commas. @@ -649,7 +777,7 @@ Accept wildcard characters: False ### -RemoteArchive This parameter is available only in on-premises Exchange. -The RemoteArchive switch is required to return remote archive mailboxes in the results. You don't need to specify a value with this switch. +The RemoteArchive switch specifies whether to return only remote archive mailboxes in the results. You don't need to specify a value with this switch. Remote archive mailboxes are archive mailboxes in the cloud-based service that are associated with mailbox users in on-premises Exchange organizations. @@ -698,6 +826,8 @@ You can't use this parameter with the Anr, Database, or Identity parameters. The ServerName and ServerLegacyDN properties for a mailbox may not be updated immediately after a mailbox move within a database availability group (DAG). To get the most up-to-date values for these mailbox properties, run the command `Get-Mailbox | Get-MailboxStatistics | Format-List Name,ServerName,ServerLegacyDN`. +**Note**: The result from this parameter could be a legacy value before migration. For better results, use the Database parameter instead. + ```yaml Type: ServerIdParameter Parameter Sets: ServerSet @@ -714,7 +844,7 @@ Accept wildcard characters: False ### -SoftDeletedMailbox This parameter is available only in the cloud-based service. -The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. +The SoftDeletedMailbox switch specifies whether to return only soft-deleted mailboxes in the results. You don't need to specify a value with this switch. Soft-deleted mailboxes are deleted mailboxes that are still recoverable. @@ -758,7 +888,7 @@ Accept wildcard characters: False ``` ### -SupervisoryReviewPolicy -This parameter is available on in on-premises Exchange. +This parameter is available only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -780,12 +910,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxActivityReport.md b/exchange/exchange-ps/exchange/Get-MailboxActivityReport.md deleted file mode 100644 index e0dabd030a..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailboxActivityReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxactivityreport -applicable: Exchange Online -title: Get-MailboxActivityReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailboxActivityReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-MailboxActivityReport cmdlet to view the number of mailboxes created and deleted in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-MailboxActivityReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-MailboxActivityReport -ReportType Monthly -StartDate 05/01/2015 -EndDate 05/31/2015 -``` - -This example shows the number of mailboxes created and deleted for the month of May, 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md index 9388395b67..52e699b66f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/exchange/Get-MailboxAuditBypassAssociation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxauditbypassassociation +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxauditbypassassociation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxAuditBypassAssociation schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the [Set-MailboxAuditBypassAssociation](https://docs.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation) cmdlet to enable this property to bypass mailbox audit logging. +Use the Get-MailboxAuditBypassAssociation cmdlet to retrieve information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only). You use the [Set-MailboxAuditBypassAssociation](https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation) cmdlet to enable this property to bypass mailbox audit logging. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-MailboxAuditBypassAssociation [[-Identity] [-DomainController ] [-ReadFromDomainController] [-ResultSize ] + [-UseCustomRouting] [] ``` @@ -38,7 +39,7 @@ You can use the Get-MailboxAutoReplyConfiguration cmdlet to retrieve all the mai - Whether external senders receive Automatic Replies (none, known senders, or all) - Automatic Replies message to be sent to internal and external senders -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,7 +89,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -122,9 +123,11 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you set the recipient scope to include all recipients in the forest and if you don't use this parameter, it's possible that the user information is read from a global catalog with outdated information. If you use this parameter, multiple reads might be necessary to get the information. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. -By default, the recipient scope is set to the domain that hosts your servers that run Microsoft Exchange. +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. + +By default, the recipient scope is set to the domain that hosts your Exchange servers. ```yaml Type: SwitchParameter @@ -155,17 +158,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md index c1421fbab7..d8966ce18e 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxCalendarConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxcalendarconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxcalendarconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxCalendarConfiguration schema: 2.0.0 @@ -16,16 +16,26 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxCalendarConfiguration cmdlet to show the calendar settings for a specified mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Default ``` -Get-MailboxCalendarConfiguration [-Identity] - [-DomainController ] +Get-MailboxCalendarConfiguration [-Identity] [-DomainController ] [] ``` +### Identity +``` +Get-MailboxCalendarConfiguration [[-Identity] ] [] +``` + +### MailboxLocation +``` +Get-MailboxCalendarConfiguration [-MailboxLocation ] [] +``` + ## DESCRIPTION The Get-MailboxCalendarConfiguration cmdlet returns settings for the calendar of the specified mailbox, including the following: @@ -42,7 +52,7 @@ The Get-MailboxCalendarConfiguration cmdlet returns settings for the calendar of To see all of the settings returned, pipeline the command to the Format-List command. To view a code sample, see "Example 1." -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -85,14 +95,27 @@ The Identity parameter specifies the mailbox that you want to view. You can use ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 Default value: None -Accept pipeline input: True +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -103,7 +126,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -114,17 +137,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md index b250c36a8d..075437cc2c 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/exchange/Get-MailboxCalendarFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxcalendarfolder +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxcalendarfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxCalendarFolder schema: 2.0.0 @@ -16,12 +16,13 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxCalendarFolder cmdlet to retrieve the publishing or sharing settings for a specified mailbox calendar folder. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-MailboxCalendarFolder [-Identity] + [-UseCustomRouting] [-DomainController ] [] ``` @@ -29,7 +30,7 @@ Get-MailboxCalendarFolder [-Identity] ## DESCRIPTION The Get-MailboxCalendarFolder cmdlet retrieves information for the specified calendar folder. This information includes the calendar folder name, whether the folder is currently published or shared, the start and end range of calendar days published, the level of details published for the calendar, whether the published URL of the calendar can be searched on the web and the published URL for the calendar. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -105,17 +106,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabase.md b/exchange/exchange-ps/exchange/Get-MailboxDatabase.md index f1384de06c..82286a48e4 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Get-MailboxDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MailboxDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxDatabase cmdlet to retrieve one or more mailbox database objects from a server or organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -54,7 +54,7 @@ The following list describes the properties that are returned in the results. - Recovery: Specifies whether the new database is designated as a recovery database. - ReplicationType: Replication type of the database. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +72,28 @@ This example returns detailed information about the mailbox database named Mailb ## PARAMETERS +### -Identity +The Identity parameter specifies the mailbox database that you want to view. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID + +If you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Server The Server parameter filters the results by the specified Mailbox server. You can use any value that uniquely identifies the server. For example: @@ -127,28 +149,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the mailbox database that you want to view. You can use any value that uniquely identifies the database. For example: - -- Name -- Distinguished name (DN) -- GUID - -If you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IncludeCorrupted This parameter is reserved for internal Microsoft use. @@ -228,12 +228,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md b/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md index f75b44ec3c..d58b4dc67d 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md +++ b/exchange/exchange-ps/exchange/Get-MailboxDatabaseCopyStatus.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxdatabasecopystatus +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxdatabasecopystatus applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MailboxDatabaseCopyStatus schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxDatabaseCopyStatus cmdlet to view health and status information about one or more mailbox database copies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,7 +46,7 @@ Get-MailboxDatabaseCopyStatus [[-Identity] ] ## DESCRIPTION If a database is specified by using the Identity parameter with the command, the status of all copies of the database is returned. If a server is specified by using the Server parameter with the command, information about all database copies on the server is returned. If neither parameter is specified with the command, information about all database copies in the organization is returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +73,22 @@ This example returns the status for the copy of database DB1 on the Mailbox serv ## PARAMETERS +### -Identity +The Identity parameter specifies the name of the database copy for which the command should gather information. The Identity parameter can be specified in the form of `\`. Specifying just `` returns information for all copies of the database. This parameter can't be combined with the Server parameter. + +```yaml +Type: DatabaseCopyIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Server The Server parameter specifies that a Mailbox server returns status information for all of its mailbox database copies. This parameter can't be combined with the Identity parameter. @@ -90,7 +106,7 @@ Accept wildcard characters: False ``` ### -Active -The Active switch specifies whether to return mailbox database copy status for the active mailbox database copy only. +The Active switch specifies whether to return mailbox database copy status for the active mailbox database copy only. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -137,24 +153,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the database copy for which the command should gather information. The Identity parameter can be specified in the form of `\`. Specifying just `` returns information for all copies of the database. This parameter can't be combined with the Server parameter. - -```yaml -Type: DatabaseCopyIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Local -The Local switch specifies whether to return mailbox database copy status information from only the local Mailbox server. +The Local switch specifies whether to return mailbox database copy status information from only the local Mailbox server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -170,7 +170,7 @@ Accept wildcard characters: False ``` ### -ExtendedErrorInfo -The ExtendedErrorInfo switch specifies whether to return an output object containing any exception details. +The ExtendedErrorInfo switch specifies whether to return an output object containing any exception details. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -186,7 +186,7 @@ Accept wildcard characters: False ``` ### -UseServerCache -The UseServerCache switch specifies whether to enable a server-side remote procedure call (RPC) caching of status information for 5 seconds. +The UseServerCache switch specifies whether to enable a server-side remote procedure call (RPC) caching of status information for 5 seconds. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -206,12 +206,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md index 15874dee78..106407e8e1 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxExportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxexportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MailboxExportRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxExportRequest cmdlet to view the detailed status of an ongoing export request that was initiated by using the New-MailboxExportRequest cmdlet. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -63,7 +63,7 @@ Get-MailboxExportRequest [-Mailbox ] ## DESCRIPTION The search criteria for the Get-MailboxExportRequest cmdlet is a Boolean And statement. If you use multiple parameters, you narrow your search and reduce your search results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -361,12 +361,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md index 5b5803428f..27ef9ad06f 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxExportRequestStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxexportrequeststatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxexportrequeststatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MailboxExportRequestStatistics schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxExportRequestStatistics cmdlet to view detailed information about export requests. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -57,7 +57,7 @@ Get-MailboxExportRequestStatistics -RequestQueue ## DESCRIPTION You can pipeline the Get-MailboxExportRequestStatistics cmdlet from the Get-MailboxExportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -168,7 +168,9 @@ Accept wildcard characters: False ``` ### -Diagnostic -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -234,7 +236,7 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -286,12 +288,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolder.md b/exchange/exchange-ps/exchange/Get-MailboxFolder.md index 4597e0440a..3e9a4e5383 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolder.md +++ b/exchange/exchange-ps/exchange/Get-MailboxFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolder +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxFolder cmdlet to view folders in your own mailbox. Administrators can't use this cmdlet to view folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ Get-MailboxFolder [[-Identity] ] ## DESCRIPTION This command checks that the mailbox specified in the Identity parameter is a valid Exchange mailbox before retrieving the requested folders. The cmdlet returns all folders if the MailFolderOnly switch isn't specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -210,12 +210,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md index 411ed427bb..1873b6abc7 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Get-MailboxFolderPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxFolderPermission schema: 2.0.0 @@ -16,22 +16,25 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxFolderPermission cmdlet to view folder-level permissions in mailboxes. -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-MailboxFolderPermission [-Identity] [-DomainController ] - [-User ] [-GroupMailbox] + [-ResultSize ] + [-SkipCount ] + [-UseCustomRouting] + [-User ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -107,21 +110,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -User -The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example: +### -GroupMailbox +The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml -Type: MailboxFolderUserIdParameter +Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -130,14 +144,64 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GroupMailbox -The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch. +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: MailboxFolderUserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -151,22 +215,22 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS -[Add-MailboxFolderPermission](Add-MailboxFolderPermission.md) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) -[Set-MailboxFolderPermission](Set-MailboxFolderPermission.md) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) -[Remove-MailboxFolderPermission](Remove-MailboxFolderPermission.md) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](Get-EXOMailboxFolderPermission.md) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md index ad99a7b81f..8b201910e4 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxFolderStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolderstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxFolderStatistics schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information. -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxFolderStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,6 +32,9 @@ Get-MailboxFolderStatistics [-Identity] [-IncludeAnalysis] [-IncludeOldestAndNewestItems] [-IncludeSoftDeletedRecipients] + [-ResultSize ] + [-SkipCount ] + [-UseCustomRouting] [] ``` @@ -45,6 +48,8 @@ Get-MailboxFolderStatistics [[-Identity] ] [-IncludeAnalysis] [-IncludeOldestAndNewestItems] [-IncludeSoftDeletedRecipients] + [-ResultSize ] + [-SkipCount ] [] ``` @@ -56,11 +61,13 @@ Get-MailboxFolderStatistics -Database -StoreMailboxIdentit [-IncludeAnalysis] [-IncludeOldestAndNewestItems] [-IncludeSoftDeletedRecipients] + [-ResultSize ] + [-SkipCount ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). A mailbox can have hidden items that are never visible to the user and are only used by applications. The Get-MailboxFolderStatistics cmdlet can return hidden items for the following values: FolderSize, FolderAndSubfolderSize, ItemsInFolder and ItemsInFolderAndSubfolders. @@ -99,6 +106,7 @@ This example uses the IncludeAnalysis switch to view the statistics of Tony's Re ### Example 5 ```powershell $All = Get-Mailbox -ResultSize Unlimited + $All | foreach {Get-MailboxFolderStatistics -Identity $_.Identity -FolderScope Inbox | Format-Table Identity,ItemsInFolderAndSubfolders,FolderAndSubfolderSize -AutoSize} ``` @@ -344,17 +352,71 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md b/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md new file mode 100644 index 0000000000..ca07bcdfd7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MailboxIRMAccess.md @@ -0,0 +1,121 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxirmaccess +applicable: Exchange Online +title: Get-MailboxIRMAccess +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MailboxIRMAccess + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MailboxIRMAccess cmdlet to view delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MailboxIRMAccess [[-Identity] ] + [-User ] + [] +``` + +## DESCRIPTION +> [!NOTE] +> This cmdlet works only for delegates who already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). +> +> Delegates with Full Access permission to the mailbox who don't appear in the results of this cmdlet have access to IRM-protected messages. Only Full Access delegates who are blocked from reading IRM-protected messages in the mailbox appear in the results. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com +``` + +This example returns information about delegate access to IRM-protected messages in Lynette's mailbox: + +- Full Access delegates who appear in the results are blocked from reading IRM-protected messages in the mailbox. +- Full Access delegates who don't appear in the results can read IRM-protected messages in the mailbox. + +### Example 2 +```powershell +Get-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com -User chris@contoso.onmicrosoft.com +``` + +This example returns information about delegate Chris' access to IRM-protected messages in Lynette's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox where you want to view delegate access to IRM-protected messages. You can use any value that uniquely identifies the mailbox. For example + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -User +The User parameter filters the results in the mailbox by the specified delegate. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md index eed51769c8..63f31df6ff 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxImportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboximportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxImportRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxImportRequest cmdlet to view the detailed status of an ongoing import request that was initiated using the New-MailboxImportRequest cmdlet. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -65,7 +65,7 @@ Get-MailboxImportRequest ## DESCRIPTION The search criteria for the Get-MailboxImportRequest cmdlet is a Boolean And statement. If you use multiple parameters, you narrow your search and reduce your search results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -208,7 +208,7 @@ Accept wildcard characters: False ``` ### -Mailbox -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The Mailbox parameter filters the results by the destination mailbox where the content is being imported to. @@ -369,12 +369,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md index 02921acc4e..5803c36890 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxImportRequestStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboximportrequeststatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboximportrequeststatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxImportRequestStatistics schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxImportRequestStatistics cmdlet to view detailed information about import requests. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,6 +38,7 @@ Get-MailboxImportRequestStatistics [-Identity] Get-MailboxImportRequestStatistics [-Identity] [-DiagnosticInfo ] [-IncludeReport] + [-IncludeSkippedItems] [-ReportOnly] [] ``` @@ -65,7 +66,7 @@ Get-MailboxImportRequestStatistics -RequestQueue ## DESCRIPTION You can pipeline the Get-MailboxImportRequestStatistics cmdlet from the Get-MailboxImportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,6 +110,8 @@ This example returns additional information for all the import requests that hav ### -Identity The Identity parameter specifies the identity of the import request. By default, import requests are named `\MailboxImportX` (where X = 0-9). If you specified a name when you created the import request, use the following syntax: `Alias\Name`. +**Note**: In Exchange Online, the alias of a soft-deleted mailbox might match the alias of an active mailbox. To ensure uniqueness, use the RequestGuid value from the output of the Get-MailboxImportRequest cmdlet for the value of this parameter. + ```yaml Type: MailboxImportRequestIdParameter Parameter Sets: IdentityOnPremises, IdentityCloud @@ -171,7 +174,9 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -241,7 +246,7 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -256,6 +261,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeSkippedItems +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSkippedItems Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RequestGuid This parameter is available only in on-premises Exchange. @@ -297,12 +320,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md index 1176becf8c..bc4b367757 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxJunkEmailConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxjunkemailconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxjunkemailconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxJunkEmailConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxJunkEmailConfiguration cmdlet to view the junk email settings on mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,12 +32,17 @@ Get-MailboxJunkEmailConfiguration [-Identity] ## DESCRIPTION The junk email settings on the mailbox are: -- Enable or disable the junk email rule: The junk email rule (a hidden Inbox rule named Junk E-mail Rule) controls the delivery of messages to the Junk Email folder or the Inbox based on the SCL Junk Email Folder threshold (for the organization or the mailbox) and the safelist collection on the mailbox. Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. +- Enable or disable the junk email rule: In on-premises Exchange, the junk email rule (a hidden Inbox rule named Junk E-mail Rule) controls the delivery of messages to the Junk Email folder or the Inbox based on the SCL Junk Email Folder threshold (for the organization or the mailbox) and the safelist collection on the mailbox. + + In the cloud-based service, the junk email rule has no effect on mail flow. Exchange Online Protection delivers messages to the Junk Email folder based on the actions set in anti-spam policies. The junk email rule on the mailbox still controls what happens to messages after delivery based on the safelist collection of the mailbox. + + Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. + - Configure the safelist collection: The safelist collection is the Safe Senders list, the Safe Recipients list, and the Blocked Senders list. Users can configure the safelist collection on their own mailbox by using Microsoft Outlook or Outlook on the web. -Administrators can enable or disable the junk email rule, and configure the safelist collection on a mailbox by using the Set-MailboxJunkEmailConfiguration cmdlet. For more information, see [Configure Exchange antispam settings on mailboxes](https://docs.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-antispam-settings). +Administrators can enable or disable the junk email rule, and configure the safelist collection on a mailbox by using the Set-MailboxJunkEmailConfiguration cmdlet. For more information, see [Configure Exchange antispam settings on mailboxes](https://learn.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-antispam-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +56,7 @@ This example returns the junk email configuration for the user named David Pelto ### Example 2 ```powershell $AllUsers = Get-Mailbox -ResultSize unlimited -RecipientTypeDetails UserMailbox + $AllUsers | foreach {Get-MailboxJunkEmailConfiguration -Identity $_.UserPrincipalName} | Where {$_.Enabled -eq $false} | Format-Table -Auto Identity,Enabled ``` @@ -92,7 +98,7 @@ Accept wildcard characters: True ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -126,7 +132,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -164,12 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxLocation.md b/exchange/exchange-ps/exchange/Get-MailboxLocation.md index f98573d4ea..ea42b8a024 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxLocation.md +++ b/exchange/exchange-ps/exchange/Get-MailboxLocation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxlocation +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxlocation applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxLocation schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxLocation cmdlet to view mailbox location information in Exchange Online. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -54,7 +52,7 @@ Get-MailboxLocation -User ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -248,12 +246,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md index 15a53d1480..fff93d6e2a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxMessageConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxmessageconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxmessageconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxMessageConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxMessageConfiguration cmdlet to view the Outlook on the web settings that are applied to specific mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,13 +26,18 @@ Get-MailboxMessageConfiguration [-Identity] [-DomainController ] [-ReadFromDomainController] [-ResultSize ] + [-SignatureName ] + [-UseCustomRouting] [] ``` ## DESCRIPTION The Get-MailboxMessageConfiguration cmdlet shows Outlook on the web settings for the specified mailbox. These settings are not used in Microsoft Outlook, Microsoft Exchange ActiveSync, or other email clients. These settings are applied in Outlook on the web only. Settings that contain the word Mobile are applied in Microsoft Outlook on the web for devices only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!NOTE] +> The SignatureHtml and SignatureText parameters don't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Currently, the only way to make these parameters work again is to open a support ticket and ask to have Outlook roaming signatures disabled in your organization. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,7 +87,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password to use to access the mailbox. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -116,7 +121,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -149,17 +156,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SignatureName +This parameter is available only in the cloud-based service. + +{{ Fill SignatureName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxPermission.md b/exchange/exchange-ps/exchange/Get-MailboxPermission.md index 29d4207a05..80fc4e6f73 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Get-MailboxPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxPermission schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxPermission cmdlet to retrieve permissions on a mailbox. -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,8 +28,10 @@ Get-MailboxPermission [-Identity] [-Owner] [-Credential ] [-DomainController ] [-GroupMailbox] + [-IncludeUserWithDisplayName] [-ReadFromDomainController] [-ResultSize ] + [-UseCustomRouting] [] ``` @@ -39,8 +41,12 @@ Get-MailboxPermission [-Identity] [-User ] [-DomainController ] [-GroupMailbox] + [-IncludeSoftDeletedUserPermissions] + [-IncludeUnresolvedPermissions] + [-IncludeUserWithDisplayName] [-ReadFromDomainController] [-ResultSize ] + [-UseCustomRouting] [] ``` @@ -63,7 +69,7 @@ By default, the following permissions are assigned to user mailboxes: By default, other security groups and role groups inherit permissions to mailboxes based on their location (on-premises Exchange or Microsoft 365). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,7 +126,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -171,6 +177,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeSoftDeletedUserPermissions +This parameter is available only in the cloud-based service. + +The IncludeSoftDeletedUserPermissions switch returns permissions from soft-deleted mailbox users in the results. You don't need to specify a value with this switch. + +Soft-deleted mailboxes are mailboxes that have been deleted, but are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUnresolvedPermissions +This parameter is available only in the cloud-based service. + +The IncludeUnresolvedPermissions switch returns unresolved permissions in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: AccessRights +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeUserWithDisplayName +This parameter is available only in the cloud-based service. + +{{ Fill IncludeUserWithDisplayName Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Owner The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch. @@ -190,13 +252,11 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. -If you set the recipient scope to include all recipients in the forest, and if you don't use this parameter, it's possible that the user information is read from a global catalog with outdated information. +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. -If you use this parameter, multiple reads might be necessary to get the information. - -By default, the recipient scope is set to the domain that hosts your servers that run Exchange. +By default, the recipient scope is set to the domain that hosts your Exchange servers. ```yaml Type: SwitchParameter @@ -247,6 +307,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -User The User parameter filters the results by who has permissions to the mailbox that's specified by the Identity parameter. You can specify the following types of users or groups (security principals) for this parameter: @@ -254,7 +332,12 @@ The User parameter filters the results by who has permissions to the mailbox tha - Mail users - Security groups -You can use any value that uniquely identifies the user or group. For example: +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: - Name - Alias @@ -287,12 +370,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxPlan.md b/exchange/exchange-ps/exchange/Get-MailboxPlan.md index 8be87a1f3d..c1a6bb560a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxPlan.md +++ b/exchange/exchange-ps/exchange/Get-MailboxPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxplan +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxplan applicable: Exchange Online title: Get-MailboxPlan schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MailboxPlan cmdlet to view information about mailbox plans in the cloud-based service. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +34,7 @@ Get-MailboxPlan [[-Identity] ] ## DESCRIPTION A mailbox plan is a template that automatically configures mailbox properties. Mailbox plans correspond to license types, and are applied when you license the user. The availability of a mailbox plan is determined by your selections when you enroll in the service and the age of your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,7 +97,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -115,16 +113,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -200,12 +198,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md index d24f09ff10..0915467f52 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRegionalConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxregionalconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxregionalconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxRegionalConfiguration schema: 2.0.0 @@ -16,22 +16,35 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxRegionalConfiguration cmdlet to view the regional settings of a mailbox. You can view the date format, time format, time zone, and language of the mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Default ``` -Get-MailboxRegionalConfiguration [-Identity] - [-Archive] - [-DomainController ] +Get-MailboxRegionalConfiguration [-Identity] [-DomainController ] + [-VerifyDefaultFolderNameLanguage] + [] +``` + +### Identity +``` +Get-MailboxRegionalConfiguration [[-Identity] ] [-Archive] [-UseCustomRouting] + [-VerifyDefaultFolderNameLanguage] + [] +``` + +### MailboxLocation +``` +Get-MailboxRegionalConfiguration [-MailboxLocation ] [-UseCustomRouting] [-VerifyDefaultFolderNameLanguage] [] ``` ## DESCRIPTION -To modify the regional settings of a mailbox, use the [Set-MailboxRegionalConfiguration](https://docs.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration) cmdlet. +To modify the regional settings of a mailbox, use the [Set-MailboxRegionalConfiguration](https://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration) cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,12 +89,25 @@ The Identity parameter specifies the mailbox that you want to view. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 Default value: None -Accept pipeline input: True +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -110,7 +136,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -121,6 +147,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VerifyDefaultFolderNameLanguage The VerifyDefaultFolderNameLanguage switch verifies that the default folder names are localized in the language that's specified for the mailbox (the Language property value). You don't need to specify a value with this switch. @@ -152,12 +214,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md index 9a982ca18d..d247baf12a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRepairRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxrepairrequest +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrepairrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MailboxRepairRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxRepairRequest cmdlet to display information about current mailbox repair requests. Mailbox repair requests are created using the New-MailboxRepairRequest cmdlet to detect and fix mailbox corruptions. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -51,13 +51,14 @@ The Get-MailboxRepairRequest cmdlet displays information about mailbox repair re - The status of the repair request; values are Queued, Running, Succeeded and Failed. - The date and time when the mailbox repair request was created and when it finished. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell Get-MailboxDatabase | Get-MailboxRepairRequest | Format-Table Identity + Get-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5\374289de-b899-42dc-8391-4f8579935f1f | Format-List ``` @@ -73,6 +74,7 @@ This example displays repair request information for the mailbox of Ann Beebe us ### Example 3 ```powershell $MailboxGuid = Get-MailboxStatistics annb + Get-MailboxRepairRequest -Database $MailboxGuid.Database -StoreMailbox $MailboxGuid.MailboxGuid | Format-List Identity ``` @@ -83,6 +85,8 @@ This example uses the Database and StoreMailbox parameters to display the Identi ### -Identity The Identity parameter specifies the mailbox repair request to display information about. Mailbox repair requests are identified by a complex GUID that is created when a new mailbox repair request is created. This GUID consists of a database ID, a Request ID and a job ID. The format is `DatabaseGuid\RequestGuid\JobGuid`. +You can't use this parameter with the Database or Mailbox parameters. + ```yaml Type: StoreIntegrityCheckJobIdParameter Parameter Sets: Identity @@ -103,7 +107,7 @@ The Database parameter returns mailbox repair requests for all mailboxes on the - Distinguished name (DN) - GUID -You can't use this parameter with the Mailbox parameter. +You can't use this parameter with the Identity or Mailbox parameters. ```yaml Type: DatabaseIdParameter @@ -132,7 +136,7 @@ The Mailbox parameter specifies the mailbox that you want to get mailbox repair - SamAccountName - User ID or user principal name (UPN) -You can't use this parameter with the Database parameter. +You can't use this parameter with the Database or Identity parameters. ```yaml Type: MailboxIdParameter @@ -147,10 +151,30 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -StoreMailbox +The StoreMailbox parameter specifies the mailbox GUID of the mailbox that you want to get mailbox repair request information about. Use this parameter with the Database parameter. + +Use the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. + +```yaml +Type: StoreMailboxIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Archive -If the associated archive mailbox was included when the mailbox repair request was created, use the Archive parameter to display information about the archive mailbox. If you don't specify this parameter, only information about the primary mailbox is returned. +The Archive switch displays information about the associated archive mailbox if the archive mailbox was included when the mailbox repair request was created. You don't need to specify a value with this switch. + +If you don't use this switch, only information about the primary mailbox is returned. -You can't use this parameter with the Database parameter. +You can't use this switch with the Database parameter. ```yaml Type: SwitchParameter @@ -166,7 +190,7 @@ Accept wildcard characters: False ``` ### -Detailed -Use the Detailed parameter to display mailbox-level repair tasks associated with the repair request. +Use the Detailed parameter to display mailbox-level repair tasks associated with the repair request. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -197,35 +221,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StoreMailbox -The StoreMailbox parameter specifies the mailbox GUID of the mailbox that you want to get mailbox repair request information about. Use this parameter with the Database parameter. - -Use the Get-MailboxStatistics cmdlet to find the mailbox GUID for a mailbox. - -```yaml -Type: StoreMailboxIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True -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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md index a052c5dd83..307c4af120 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxrestorerequest +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxRestoreRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxRestoreRequest cmdlet to view detailed status of an ongoing restore request that was initiated by using the New-MailboxRestoreRequest cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ Get-MailboxRestoreRequest [-BatchName ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -344,12 +344,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md index 392906e119..08a0693b85 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxRestoreRequestStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxrestorerequeststatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxrestorerequeststatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxRestoreRequestStatistics schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxRestoreRequestStatistics cmdlet to view detailed information about restore requests. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,6 +35,7 @@ Get-MailboxRestoreRequestStatistics [-Identity] [-IncludeReport] + [-IncludeSkippedItems] [-DiagnosticInfo ] [-ReportOnly] [] @@ -61,7 +62,7 @@ Get-MailboxRestoreRequestStatistics -RequestQueue ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -169,7 +170,7 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -205,7 +206,9 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -274,6 +277,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeSkippedItems +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSkippedItems Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReportOnly The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. @@ -295,12 +316,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxSearch.md b/exchange/exchange-ps/exchange/Get-MailboxSearch.md index 41a58b6407..3051b480ef 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Get-MailboxSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxsearch +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxSearch schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxSearch cmdlet to view mailbox searches that are in progress, complete or stopped. -**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -51,7 +51,7 @@ Get-MailboxSearch -InPlaceHoldIdentity ## DESCRIPTION In on-premises Exchange, a mailbox search is used to perform an In-Place eDiscovery or to place users on an In-Place Hold. Use the Get-MailboxSearch cmdlet to retrieve details of either type of mailbox search. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,11 +69,12 @@ Get-MailboxSearch "Project Hamilton" | Format-List This example retrieves all properties for the mailbox search Project Hamilton. -The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). +The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). ### Example 3 ```powershell (Get-Mailbox Mark).InPlaceHolds + Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb ``` @@ -81,40 +82,6 @@ This example retrieves the In-Place Holds that a user is placed on. The first co ## PARAMETERS -### -InPlaceHoldIdentity -The InPlaceHoldIdentity parameter specifies the GUID of an In-Place Hold. Use this parameter to search for an In-Place Hold that a user is placed on. GUIDs of all In-Place Holds that a user is placed on are added to the user's InPlaceHolds property. You can retrieve the property by using the Get-Mailbox cmdlet. - -```yaml -Type: String -Parameter Sets: InPlaceHoldIdentity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The Identity parameter specifies the name of the search query. If a name isn't provided, all mailbox search queries are returned. @@ -155,6 +122,40 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -InPlaceHoldIdentity +The InPlaceHoldIdentity parameter specifies the GUID of an In-Place Hold. Use this parameter to search for an In-Place Hold that a user is placed on. GUIDs of all In-Place Holds that a user is placed on are added to the user's InPlaceHolds property. You can retrieve the property by using the Get-Mailbox cmdlet. + +```yaml +Type: String +Parameter Sets: InPlaceHoldIdentity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResultSize The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -192,12 +193,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md index 4329155181..0db5f4e4f3 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxSentItemsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxsentitemsconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxsentitemsconfiguration applicable: Exchange Server 2010 title: Get-MailboxSentItemsConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Get-MailboxSentItemsConfiguration cmdlet to view the Sent Items settings on mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-MailboxSentItemsConfiguration [-DomainController ] ## DESCRIPTION By default, when you use Send As or Send On Behalf Of to send a message from another mailbox, the message is saved in your Sent Items folder (not in the Sent Items folder of the source mailbox). In Microsoft Exchange Server 2010 Service Pack 3 (SP3), you can save copies messages in the Sent Items folder of the sender and the source mailbox. For example, consider a shared mailbox that receives customer feedback and is monitored by multiple users. When someone responds to a message in the shared mailbox, you can save the message in the Sent Items folder of the shared mailbox and the sender's mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,12 +90,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxServer.md b/exchange/exchange-ps/exchange/Get-MailboxServer.md index 100d9f69b0..7b2886ee8a 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxServer.md +++ b/exchange/exchange-ps/exchange/Get-MailboxServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxserver +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MailboxServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxServer cmdlet to view information about Mailbox servers in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-MailboxServer [[-Identity] ] ## DESCRIPTION The ExchangeVersion attribute returned is the minimum version of Microsoft Exchange that you can use to manage the returned object. This attribute isn't the same as the version of Microsoft Exchange that's displayed in the Exchange admin center when you select Server Configuration. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,39 +50,39 @@ This example returns detailed information about the Mailbox server named Server1 ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the Mailbox server that you want to view. You can use any value that uniquely identifies the Mailbox server. For example: + +- Name +- GUID +- Distinguished name (DN) ```yaml -Type: Fqdn +Type: MailboxServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Mailbox server that you want to view. You can use any value that uniquely identifies the Mailbox server. For example: - -- Name -- GUID -- Distinguished name (DN) +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MailboxServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -109,12 +109,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md index de26af2465..711e199b87 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxSpellingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxspellingconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxspellingconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxSpellingConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxSpellingConfiguration cmdlet to retrieve the Outlook on the web spelling checker settings of a specified user. For example, users can set their dictionary language and configure the spelling checker to ignore mixed digits and words in all uppercase. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ The Get-MailboxSpellingConfiguration cmdlet is primarily used to populate the sp - DictionaryLanguage: This setting specifies the dictionary language used when the spelling checker checks the spelling in messages. - IgnoreMixedDigits: This setting specifies whether the spelling checker ignores words that contain numbers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -111,12 +111,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md index cbae43c89e..364729d637 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MailboxStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxStatistics schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed. In addition, you can get the move history or a move report of a completed move request. -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMailboxStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,6 +46,7 @@ Get-MailboxStatistics [-Identity] [-IncludeQuarantineDetails] [-IncludeSoftDeletedRecipients] [-NoADLookup] + [-UseCustomRouting] [] ``` @@ -71,7 +72,9 @@ You can use the Get-MailboxStatistics cmdlet to return detailed move history and You can only see move reports and move history for completed move requests. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +**Note**: We're deprecating the LastUserActionTime property in Exchange Online PowerShell. Don't use the value of that property as the last active time for a mailbox. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -127,6 +130,7 @@ This example returns the summary move history for the completed move request for ### Example 8 ```powershell $temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveHistory + $temp.MoveHistory[0] ``` @@ -135,6 +139,7 @@ This example returns the detailed move history for the completed move request fo ### Example 9 ```powershell $temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveReport + $temp.MoveHistory[0] | Export-CSV C:\MoveReport_AylaKol.csv ``` @@ -193,7 +198,7 @@ Accept wildcard characters: False ``` ### -Archive -The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch. +The Archive switch specifies whether to return mailbox statistics for the archive mailbox that's associated with the mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -280,16 +285,16 @@ Accept wildcard characters: False ### -Filter This parameter is available only in on-premises Exchange. -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). For example, to display all disconnected mailboxes on a specific mailbox database, use the following syntax: `'DisconnectDate -ne $null'`. @@ -343,7 +348,9 @@ Accept wildcard characters: False ### -IncludePassive This parameter is available only in on-premises Exchange. -Without the IncludePassive parameter, the cmdlet retrieves statistics from active database copies only. Using the IncludePassive parameter, you can have the cmdlet return statistics from all active and passive database copies. +The IncludePassive switch specifies whether to return statistics from all active and passive database copies. You don't need to specify a value with this switch. + +If you don't use this switch, the command retrieves statistics from active database copies only. ```yaml Type: SwitchParameter @@ -381,7 +388,7 @@ Accept wildcard characters: False ### -IncludeQuarantineDetails This parameter is available only in on-premises Exchange. -The IncludeQuarantineDetails switch specifies whether to return additional quarantine details about the mailbox that aren't otherwise included in the results. You can use these details to determine when and why the mailbox was quarantined. +The IncludeQuarantineDetails switch specifies whether to return additional quarantine details about the mailbox that aren't otherwise included in the results. You can use these details to determine when and why the mailbox was quarantined. You don't need to specify a value with this switch. Specifically, this switch returns the values of the QuarantineDescription, QuarantineLastCrash and QuarantineEnd properties on the mailbox. To see these values, you need use a formatting cmdlet. For example, `Get-MailboxStatistics -IncludeQuarantineDetails | Format-List Quarantine*`. @@ -401,7 +408,9 @@ Accept wildcard characters: False ### -NoADLookup This parameter is available only in on-premises Exchange. -The NoADLookup switch specifies that information is retrieved from the mailbox database, and not from Active Directory. This helps improve cmdlet performance when querying a mailbox database that contains a large number of mailboxes. +The NoADLookup switch specifies that information is retrieved from the mailbox database, and not from Active Directory. You don't need to specify a value with this switch. + +This switch helps improve cmdlet performance when querying a mailbox database that contains a large number of mailboxes. ```yaml Type: SwitchParameter @@ -439,17 +448,35 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxTransportService.md b/exchange/exchange-ps/exchange/Get-MailboxTransportService.md index 6bf339be82..4e4beb49a3 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxTransportService.md +++ b/exchange/exchange-ps/exchange/Get-MailboxTransportService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxtransportservice +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxtransportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MailboxTransportService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MailboxTransportService cmdlet to view the configuration of the Mailbox Transport service on Exchange 2013 or later Mailbox servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-MailboxTransportService [[-Identity] ] ## DESCRIPTION The Mailbox Transport service runs on all Mailbox servers and is responsible for delivering messages to and accepting messages from local mailbox databases using remote procedure calls (RPC). The Mailbox Transport service also uses SMTP to send messages to and from the Transport service that runs on all Mailbox servers for routing their ultimate destinations. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,35 +49,35 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the server that you want to view. ```yaml -Type: Fqdn +Type: MailboxTransportServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the server that you want to view. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MailboxTransportServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -86,12 +86,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MailboxUsageDetailReport.md b/exchange/exchange-ps/exchange/Get-MailboxUsageDetailReport.md deleted file mode 100644 index 1ea3b86fb5..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailboxUsageDetailReport.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxusagedetailreport -applicable: Exchange Online -title: Get-MailboxUsageDetailReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailboxUsageDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-MailboxUsageDetailReport cmdlet to view usage details about mailboxes in your organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-MailboxUsageDetailReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-MailboxUsageDetailReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves details for mailboxes that were near or over the maximum mailbox size between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxUsageReport.md b/exchange/exchange-ps/exchange/Get-MailboxUsageReport.md deleted file mode 100644 index e5fc981e82..0000000000 --- a/exchange/exchange-ps/exchange/Get-MailboxUsageReport.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxusagereport -applicable: Exchange Online -title: Get-MailboxUsageReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-MailboxUsageReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-MailboxUsageReport cmdlet to view the number of mailboxes in your organization that are within 25% of the maximum mailbox size, and the number of mailboxes that are over the maximum size for your organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-MailboxUsageReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-MailboxUsageReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves the number of mailboxes that were near or over the maximum mailbox size between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md index cb9149119f..6487e6dc0e 100644 --- a/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-MailboxUserConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailboxuserconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailboxuserconfiguration applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MailboxUserConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MailboxUserConfiguration cmdlet to view user configuration items in mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-MailboxUserConfiguration [-Identity] - ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -150,12 +150,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md index 7f6855a1f3..fef6949dce 100644 --- a/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md +++ b/exchange/exchange-ps/exchange/Get-MailflowStatusReport.md @@ -1,29 +1,27 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mailflowstatusreport -applicable: Exchange Online -title: Get-MailflowStatusReport +online version: https://learn.microsoft.com/powershell/module/exchange/get-mailflowstatusreport +applicable: Exchange Online, Exchange Online Protection +title: Get-MailFlowStatusReport schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: --- -# Get-MailflowStatusReport +# Get-MailFlowStatusReport ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-MailflowStatusReport cmdlet to return the message counts for a specific date range organized by the final disposition of the message for the last 90 days. +Use the Get-MailFlowStatusReport cmdlet to return the message counts for a specific date range organized by the final disposition of the message for the last 90 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-MailflowStatusReport +Get-MailFlowStatusReport [-Direction ] [-Domain ] [-EndDate ] @@ -43,7 +41,7 @@ This cmdlet returns the following information: - Event Type - Count -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,7 +67,7 @@ You can specify multiple value separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -85,7 +83,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -97,13 +95,13 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -128,7 +126,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -144,7 +142,7 @@ This parameter is reserved for internal Microsoft use. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -160,7 +158,7 @@ This parameter is reserved for internal Microsoft use. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -176,7 +174,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -188,13 +186,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -208,12 +206,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md index 89a5ee2b4e..077860de6f 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Get-MalwareFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-malwarefilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilterpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-MalwareFilterPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MalwareFilterPolicy cmdlet to view the malware filter policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-MalwareFilterPolicy [[-Identity] ] ## DESCRIPTION Malware filter policies contain the malware settings and a list of domains to which those settings apply. A domain can't belong to more than one malware filter policy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,37 +49,37 @@ This example retrieves detailed configuration information for the malware filter ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the malware filter policy that you want to view. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. ```yaml -Type: Fqdn +Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the malware filter policy that you want to view. You can use any value that uniquely identifies the policy. For example, you can use the name, GUID or distinguished name (DN) of the malware filter policy. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MalwareFilterPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -88,12 +88,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md index f65d2f3e7d..d8b421d6ef 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Get-MalwareFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-malwarefilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-MalwareFilterRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Enable-MalwareFilterRule cmdlet to view malware filter rules in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-MalwareFilterRule [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,37 +48,37 @@ This example retrieves detailed configuration information for the malware filter ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. ```yaml -Type: Fqdn +Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the malware filter rule that you want to view. You can use any value that uniquely identifies the rule. For example, you can use the name, GUID or distinguished name (DN) of the malware filter rule. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: RuleIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -103,12 +103,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md b/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md index 70097cdd0b..11a67a8298 100644 --- a/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md +++ b/exchange/exchange-ps/exchange/Get-MalwareFilteringServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-malwarefilteringserver +online version: https://learn.microsoft.com/powershell/module/exchange/get-malwarefilteringserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MalwareFilteringServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MalwareFilteringServer cmdlet to view the Malware agent settings in the Transport service on a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-MalwareFilteringServer [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,42 +47,42 @@ This example returns the detailed Exchange Malware agent settings on a Mailbox s ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the server where you want to view the anti-malware settings. You can use any value that uniquely identifies the server. For example: -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN ```yaml -Type: Fqdn +Type: MalwareFilteringServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the server where you want to view the anti-malware settings. You can use any value that uniquely identifies the server. For example: +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -- Name -- FQDN -- Distinguished name (DN) -- Exchange Legacy DN +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: MalwareFilteringServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -91,12 +91,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md index 50e4fda846..543f807e2a 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md +++ b/exchange/exchange-ps/exchange/Get-ManagedContentSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-managedcontentsettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-managedcontentsettings applicable: Exchange Server 2010 title: Get-ManagedContentSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Get-ManagedContentSettings cmdlet to retrieve managed content settings associated with managed folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ The Get-ManagedContentSettings cmdlet retrieves from one to all of the managed c If only the Identity parameter is present, the folder content settings and all associated attributes are returned. If the Identity parameter isn't present, the command returns all content settings. If the FolderName parameter is present, the command returns all content settings contained in the specified managed folder and all the attributes of each setting. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +66,24 @@ This example retrieves the managed content settings for the managed folder Inbox ## PARAMETERS +### -Identity +The Identity parameter specifies the name, distinguished name (DN), or GUID of the set of managed content settings. When used, this command retrieves the folder content settings and all associated attributes. + +This parameter can't be used with the FolderName parameter. + +```yaml +Type: ELCContentSettingsIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -DomainController The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -100,35 +118,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name, distinguished name (DN), or GUID of the set of managed content settings. When used, this command retrieves the folder content settings and all associated attributes. - -This parameter can't be used with the FolderName parameter. - -```yaml -Type: ELCContentSettingsIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolder.md b/exchange/exchange-ps/exchange/Get-ManagedFolder.md index 2270205d30..f7a6302c2b 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedFolder.md +++ b/exchange/exchange-ps/exchange/Get-ManagedFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-managedfolder +online version: https://learn.microsoft.com/powershell/module/exchange/get-managedfolder applicable: Exchange Server 2010 title: Get-ManagedFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Get-ManagedFolder cmdlet to retrieve the attributes of one or more managed folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ The Get-ManagedFolder cmdlet retrieves the specified managed folder attributes: The Get-ManagedFolder cmdlet accepts a ManagedFolder object or an identity string as pipelined input. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,35 +56,35 @@ This example retrieves information about the managed folder MyManagedFolder. The ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: ELCFolderIdParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: ELCFolderIdParameter -Parameter Sets: Identity +Type: Fqdn +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md index f62e70774a..773b53f264 100644 --- a/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Get-ManagedFolderMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-managedfoldermailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-managedfoldermailboxpolicy applicable: Exchange Server 2010 title: Get-ManagedFolderMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Get-ManagedFolderMailboxPolicy cmdlet to return all attributes of one or more managed folder mailbox policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-ManagedFolderMailboxPolicy [[-Identity] ] ## DESCRIPTION A managed folder mailbox policy is a logical grouping of one or more managed folders. Policies are applied to mailboxes. The Get-ManagedFolderMailboxPolicy cmdlet lists one or more managed folder mailbox policies created in the Microsoft Exchange Server 2010 organization. All policies can be listed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,39 +40,39 @@ Get-ManagedFolderMailboxPolicy "PM Storage Template" This example returns all the attributes of the managed folder mailbox policy PM Storage Template. -The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). +The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder mailbox policy. ```yaml -Type: Fqdn +Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name, distinguished name (DN), or GUID of the managed folder mailbox policy. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MailboxPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -81,12 +81,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ManagementRole.md b/exchange/exchange-ps/exchange/Get-ManagementRole.md index ad87582df0..72a4c467e8 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRole.md +++ b/exchange/exchange-ps/exchange/Get-ManagementRole.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-managementrole -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-managementrole +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-ManagementRole schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ManagementRole cmdlet to view management roles that have been created in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -61,9 +61,9 @@ Get-ManagementRole [[-Identity] ] ## DESCRIPTION You can view management roles in several ways, from listing all the roles in your organization to listing only the child roles of a specified parent role. You can also view the details of a specific role by piping the output of the Get-ManagementRole cmdlet to the Format-List cmdlet. -For more information about management roles, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about management roles, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -100,7 +100,7 @@ This example lists all the roles that have a type of UnScopedTopLevel. These rol Get-ManagementRole "Transport Rules" | Format-List Name, RoleType ``` -This example retrieves only the Transport Rules role and passes the output of the Get-ManagementRole cmdlet to the Format-List cmdlet. The Format-List cmdlet then shows only the Name and RoleType properties of the Transport Rules role. For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +This example retrieves only the Transport Rules role and passes the output of the Get-ManagementRole cmdlet to the Format-List cmdlet. The Format-List cmdlet then shows only the Name and RoleType properties of the Transport Rules role. For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ### Example 6 ```powershell @@ -118,7 +118,7 @@ The Identity parameter specifies the role you want to view. If the role you want Type: RoleIdParameter Parameter Sets: GetChildren, Recurse Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -131,7 +131,7 @@ Accept wildcard characters: False Type: RoleIdParameter Parameter Sets: Identity, Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -141,13 +141,17 @@ Accept wildcard characters: False ``` ### -GetChildren -The GetChildren parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. Only the immediate child roles of the parent role are included. The GetChildren parameter can only be used with the Identity and RoleType parameters. +The GetChildren parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. You don't need to specify a value with this switch. + +Only the immediate child roles of the parent role are included in the results. + +You can use this switch only with the Identity and RoleType parameters. ```yaml Type: SwitchParameter Parameter Sets: GetChildren Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -157,13 +161,17 @@ Accept wildcard characters: False ``` ### -Recurse -The Recurse parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. The role specified in the Identity parameter, its child roles, and their children are returned. The Recurse parameter can only be used with the Identity and RoleType parameters. +The Recurse parameter retrieves a list of all the roles that were created based on the parent role specified in the Identity parameter. You don't need to specify a value with this switch. + +The role specified in the Identity parameter, its child roles, and their children are returned. + +You can use this switch only with the Identity and RoleType parameters. ```yaml Type: SwitchParameter Parameter Sets: Recurse Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -179,7 +187,7 @@ The Cmdlet parameter returns a list of all roles that include the specified cmdl Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -195,7 +203,7 @@ The CmdletParameters parameter returns a list of all roles that include the spec Type: String[] Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -223,13 +231,13 @@ Accept wildcard characters: False ``` ### -RoleType -The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +The RoleType parameter returns a list of roles that match the specified role type. For a list of valid role types, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). ```yaml Type: RoleType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -245,7 +253,7 @@ The Script parameter returns a list of all roles that include the specified scri Type: String Parameter Sets: Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -261,7 +269,7 @@ The ScriptParameters parameter returns a list of all roles that include the spec Type: String[] Parameter Sets: Script Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -275,12 +283,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md index cc8bad03d5..574baae033 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Get-ManagementRoleAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-managementroleassignment +online version: https://learn.microsoft.com/powershell/module/exchange/get-managementroleassignment applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-ManagementRoleAssignment schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ManagementRoleAssignment cmdlet to retrieve management role assignments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,6 +34,7 @@ Get-ManagementRoleAssignment [[-Identity] ] [-ExclusiveRecipientWriteScope ] [-GetEffectiveUsers] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientWriteScope ] [-RoleAssigneeType ] @@ -58,6 +59,7 @@ Get-ManagementRoleAssignment [-AssignmentMethod ] [-ExclusiveRecipientWriteScope ] [-GetEffectiveUsers] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientWriteScope ] [-RoleAssignee ] @@ -71,9 +73,9 @@ Get-ManagementRoleAssignment [-AssignmentMethod ] ## DESCRIPTION You can retrieve role assignments in a variety of ways including by assignment type, scope type, or name, and whether the assignment is enabled or disabled. You can also view a list of role assignments that provide access to a specified recipient, server, or database. -For more information about management role assignments, see [Understanding management role assignments](https://docs.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). +For more information about management role assignments, see [Understanding management role assignments](https://learn.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,7 +84,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-ManagementRoleAssignment "Denver Help Desk" | Format-List ``` -This example retrieves the Denver Help Desk role assignment using the Get-ManagementRoleAssignment cmdlet and pipes the output to the Format-List cmdlet. For more information about the Format-List cmdlet, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +This example retrieves the Denver Help Desk role assignment using the Get-ManagementRoleAssignment cmdlet and pipes the output to the Format-List cmdlet. For more information about the Format-List cmdlet, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ### Example 2 ```powershell @@ -340,7 +342,9 @@ Accept wildcard characters: False ``` ### -GetEffectiveUsers -The GetEffectiveUsers switch specifies that the command should show the list of users in the role groups, assignment policies, or USGs associated with a role assignment. The users are effectively assigned the role assignment through their role group, assignment policy, or USG. +The GetEffectiveUsers switch specifies that the command should show the list of users in the role groups, role assignment policies, or USGs that are associated with the role assignment. You don't need to specify a value with this switch. + +Effectively, users are associated with the role assignment through their role group, role assignment policy, or USG memberships. ```yaml Type: SwitchParameter @@ -356,11 +360,11 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The RecipientAdministrativeUnitScope parameter returns only the role assignments that include the specified administrative unit. -Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. +Administrative units are Microsoft Entra containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. ```yaml Type: AdministrativeUnitIdParameter @@ -375,6 +379,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RecipientGroupScope +This parameter is available only in the cloud-based service. + +The RecipientGroupScope parameter returns only the role assignments that are scoped to groups. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, DisplayName. + +```yaml +Type: GroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientOrganizationalUnitScope The RecipientOrganizationalUnitScope parameter returns only the role assignments that include the specified organizational unit (OU). If the OU tree contains spaces, enclose it in quotation marks ("). @@ -533,12 +555,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md index 2f142838c7..8ba8cccb05 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Get-ManagementRoleEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-managementroleentry +online version: https://learn.microsoft.com/powershell/module/exchange/get-managementroleentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-ManagementRoleEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ManagementRoleEntry cmdlet to retrieve management role entries that have been configured on management roles. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,6 +25,7 @@ Get-ManagementRoleEntry [-Identity] [-DomainController ] [-Parameters ] [-PSSnapinName ] + [-ResultSize ] [-Type ] [] ``` @@ -32,9 +33,9 @@ Get-ManagementRoleEntry [-Identity] ## DESCRIPTION The Get-ManagementRoleEntry cmdlet retrieves role entries that have been configured on roles. You can retrieve specific role entries that match specific criteria such as role name, cmdlet name, parameter name, or a combination of each, or role entry type or the associated Windows PowerShell snap-in. -For more information about management role entries, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about management role entries, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,7 +65,7 @@ This example retrieves the Tier 2 Help Desk\\Set-Mailbox role entry and pipes th ### -Identity The Identity parameter specifies the role entry that you want to view. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). -For more information about how management role entries work, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). You can use the wildcard character (\*) instead of the role, cmdlet name or both. @@ -135,6 +136,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Type The Type parameter specifies the type of role entry to return. The valid values for the Type parameter are any combination of the following parameters, separated by commas: Cmdlet, Script and ApplicationPermission. @@ -156,12 +175,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ManagementScope.md b/exchange/exchange-ps/exchange/Get-ManagementScope.md index 2ce7a8cd1b..38673e7eda 100644 --- a/exchange/exchange-ps/exchange/Get-ManagementScope.md +++ b/exchange/exchange-ps/exchange/Get-ManagementScope.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-managementscope +online version: https://learn.microsoft.com/powershell/module/exchange/get-managementscope applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-ManagementScope schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ManagementScope cmdlet to return a list of management scopes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +31,9 @@ Get-ManagementScope [[-Identity] ] ## DESCRIPTION You can retrieve one scope or many, retrieve only scopes that aren't associated with management role assignments, or retrieve scopes that are exclusive or regular scopes. -For more information about regular and exclusive scopes, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +For more information about regular and exclusive scopes, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,7 +49,7 @@ This example retrieves all the management scopes that start with the string Redm Get-ManagementScope "Redmond Servers Scope" | Format-List ``` -This example retrieves the Redmond Servers Scope using the Get-ManagementScope cmdlet and pipes the output to the Format-List cmdlet. For more information about the Format-List cmdlet, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +This example retrieves the Redmond Servers Scope using the Get-ManagementScope cmdlet and pipes the output to the Format-List cmdlet. For more information about the Format-List cmdlet, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ### Example 3 ```powershell @@ -67,6 +67,22 @@ This example retrieves a list of exclusive scopes. ## PARAMETERS +### -Identity +The Identity parameter specifies the name of the management scope to return. If the management scope name contains spaces, enclose it in quotation marks ("). + +```yaml +Type: ManagementScopeIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -DomainController This parameter is available only in on-premises Exchange. @@ -101,24 +117,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the management scope to return. If the management scope name contains spaces, enclose it in quotation marks ("). - -```yaml -Type: ManagementScopeIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Orphan -The Orphan parameter returns only the management scopes that aren't associated with role assignments. +The Orphan switch specifies whether to return only management scopes that aren't associated with role assignments. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -138,12 +138,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md index c11a9eda05..77a025f2c7 100644 --- a/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-MapiVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mapivirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/get-mapivirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MapiVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MapiVirtualDirectory cmdlet to view Message Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Get-MapiVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,7 +53,9 @@ This example returns a summary list of the MAPI virtual directories on the serve ### Example 2 ```powershell Get-MapiVirtualDirectory -Identity "ContosoMail\mapi (Default Web Site)" | Format-List + Get-MapiVirtualDirectory "ContosoMail\mapi (Default Web Site)" | Format-List + Get-MapiVirtualDirectory ContosoMai\mapi* | Format-List ``` @@ -116,7 +118,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -174,12 +178,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-Message.md b/exchange/exchange-ps/exchange/Get-Message.md index 71e20dcd5b..634425d077 100644 --- a/exchange/exchange-ps/exchange/Get-Message.md +++ b/exchange/exchange-ps/exchange/Get-Message.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-message +online version: https://learn.microsoft.com/powershell/module/exchange/get-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-Message schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-Message cmdlet to view the details of one or more messages in queues on Mailbox servers or Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -69,7 +69,7 @@ Get-Message [-Queue ] ## DESCRIPTION You can display messages by including the server name as part of the Identity parameter or the Queue parameter or by including the Server parameter with a filter query. The Identity parameter, Queue parameter, and Filter parameter settings are mutually exclusive. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,7 +97,7 @@ This example displays all messages queued on the server named Server01. The resu ## PARAMETERS ### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity @@ -145,7 +145,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more messages by using OPath filter syntax. The OPath filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://docs.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -179,7 +179,9 @@ Accept wildcard characters: False ``` ### -IncludeComponentLatencyInfo -The IncludeComponentLatencyInfo switch specifies whether the information about component latency is included in the message properties. If you include this switch, the message objects returned will include latency measurements for each Transport component that has contributed to the local server latency for each queued message. +The IncludeComponentLatencyInfo switch specifies whether the information about component latency is included in the message properties. You don't need to specify a value with this switch. + +If you include this switch, the message objects returned will include latency measurements for each Transport component that has contributed to the local server latency for each queued message. ```yaml Type: SwitchParameter @@ -195,9 +197,11 @@ Accept wildcard characters: False ``` ### -IncludeRecipientInfo -The IncludeRecipientInfo switch specifies whether to display the message recipients in the Recipients field. If you don't include the IncludeRecipientInfo switch, the Recipients field is blank. +The IncludeRecipientInfo switch specifies whether to display the message recipients in the Recipients field. You don't need to specify a value with this switch. + +If you don't include the IncludeRecipientInfo switch, the Recipients field is blank. -Storing the results of a Get-Message -IncludeRecipientInfo command in a variable allows you to display additional properties for the message recipients. The following list describes the available recipient properties: +Storing the results of a `Get-Message -IncludeRecipientInfo` command in a variable allows you to display additional properties for the message recipients. The following list describes the available recipient properties: - Address: The email address of the recipient. - Type: The recipient type, which may be External, Mailbox or Distribution Group. Distribution Group is used when the destination is an expansion server. @@ -205,9 +209,9 @@ Storing the results of a Get-Message -IncludeRecipientInfo command in a variable - Status: The recipient status may be Complete, Ready or Retry. - LastError: The SMTP response after the last delivery attempt or a localized error message if the message is placed in the unreachable queue. -For example, to store the recipient information of a message in the contoso.com remote delivery queue that has the MessageIdentity value of 1234 to a variable named $x, use the following command: $x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo. +For example, to store the recipient information of a message in the contoso.com remote delivery queue that has the MessageIdentity value of 1234 to a variable named $x, use the following command: `$x=Get-Message -Identity "contoso.com\\1234" -IncludeRecipientInfo`. -To display the extended recipient properties that are now stored in the $x variable, use the following command : $x.Recipients. +To display the extended recipient properties that are now stored in the $x variable, use the following command: `$x.Recipients`. ```yaml Type: SwitchParameter @@ -223,7 +227,7 @@ Accept wildcard characters: False ``` ### -Queue -The Queue parameter specifies the identity of the queue that contains the messages that you want to display. Valid input for this parameter uses the syntax `\` or ``, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). +The Queue parameter specifies the identity of the queue that contains the messages that you want to display. Valid input for this parameter uses the syntax `\` or ``, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see the "Queue identity" section in [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). If you use the Queue parameter, you can't use the Identity, Filter or Server parameters. @@ -336,12 +340,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MessageCategory.md b/exchange/exchange-ps/exchange/Get-MessageCategory.md index 2422448161..6cebfc35f4 100644 --- a/exchange/exchange-ps/exchange/Get-MessageCategory.md +++ b/exchange/exchange-ps/exchange/Get-MessageCategory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-messagecategory +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagecategory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MessageCategory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MessageCategory cmdlet to retrieve a message category from the specified mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-MessageCategory [[-Identity] ] ## DESCRIPTION The Get-MessageCategory cmdlet is used by the web management interface in Microsoft Exchange to populate fields that display message category information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,12 +109,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MessageClassification.md b/exchange/exchange-ps/exchange/Get-MessageClassification.md index ccf4abbdfe..bfb6750a16 100644 --- a/exchange/exchange-ps/exchange/Get-MessageClassification.md +++ b/exchange/exchange-ps/exchange/Get-MessageClassification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-messageclassification +online version: https://learn.microsoft.com/powershell/module/exchange/get-messageclassification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MessageClassification schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MessageClassification cmdlet to view existing message classifications in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-MessageClassification [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,12 +102,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MessageTrace.md b/exchange/exchange-ps/exchange/Get-MessageTrace.md index ee195ac2e9..fa030fd3a1 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrace.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrace.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-messagetrace +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrace applicable: Exchange Online, Exchange Online Protection title: Get-MessageTrace schema: 2.0.0 @@ -14,11 +14,12 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-MessageTrace cmdlet to trace messages as they pass through the cloud-based organization. +> [!NOTE] +> This cmdlet is replaced by the [Get-MessageTraceV2](https://learn.microsoft.com/powershell/module/exchange/get-messagetracev2) cmdlet and will eventually be deprecated. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Get-MessageTrace cmdlet to trace messages as they pass through the cloud-based organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,7 +49,9 @@ To search for message data that is greater than 10 days old, use the Start-Histo By default, this cmdlet returns a maximum of 1000 results, and will timeout on very large queries. If your query returns too many results, consider splitting it up using smaller StartDate and EndDate intervals. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +The time stamps on the output are in UTC time format. That might be different from the time format that you used for the -StartDate and the -EndDate parameters. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,7 +67,7 @@ This example retrieves message trace information for messages sent by john@conto ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -80,7 +83,7 @@ Accept wildcard characters: False ``` ### -FromIP -The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. For outgoing messages from Exchange Online, the value is blank. +The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. ```yaml Type: String @@ -112,7 +115,15 @@ Accept wildcard characters: False ``` ### -MessageTraceId -The MessageTraceId parameter can be used with the recipient address to uniquely identify a message trace and obtain more details. A message trace ID is generated for every message that's processed by the system. +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceDetail ```yaml Type: Guid @@ -210,7 +221,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -271,12 +282,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md index 583c32b5fe..2053d79a67 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md +++ b/exchange/exchange-ps/exchange/Get-MessageTraceDetail.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-messagetracedetail -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetail +applicable: Exchange Online, Exchange Online Protection title: Get-MessageTraceDetail schema: 2.0.0 author: chrisda @@ -14,11 +14,12 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-MessageTraceDetail cmdlet to view the message trace event details for a specific message. Note that these detailed results are returned less quickly than the Get-MessageTrace results. +> [!NOTE] +> This cmdlet is replaced by the [Get-MessageTraceDetailV2](https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2) cmdlet and will eventually be deprecated. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Get-MessageTraceDetail cmdlet to view the message trace event details for a specific message. Note that these detailed results are returned less quickly than the Get-MessageTrace results. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +42,7 @@ You can use this cmdlet to search message data for the last 10 days. If you ente To search for message data that is greater than 10 days old, use the Start-HistoricalSearch and Get-HistoricalSearch cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,7 +51,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Get-MessageTraceDetail -MessageTraceId ae5c1219-4c90-41bf-fef5-08d837917e7c -RecipientAddress robert@contoso.com ``` -This example uses the Get-MessageTraceDetail cmdlet to retrieve detailed message trace information for messages with the Exchange Network Message ID value ae5c1219-4c90-41bf-fef5-08d837917e7c received by robert@contoso.com. +This example retrieves detailed message trace information for messages with the message trace ID value ae5c1219-4c90-41bf-fef5-08d837917e7c that were received by robert@contoso.com. ### Example 2 ```powershell @@ -62,22 +63,21 @@ This example uses the Get-MessageTrace cmdlet to retrieve message trace informat ## PARAMETERS ### -MessageTraceId -The MessageTraceId parameter is used with the recipient address to uniquely identify a message trace and obtain more details. A MessageTraceId is generated for every message that's processed by the system. +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). -The MessageTraceId value is available in the output of the following cmdlets: +The MessageTraceId value is also available in the output of the following cmdlets: -- Get-MessageTrace - Get-MailDetailATPReport - Get-MailDetailDlpPolicyReport -- Get-MailDetailMalwareReport -- Get-MailDetailSpamReport +- Get-MailDetailEncryptionReport - Get-MailDetailTransportRuleReport +- Get-MessageTrace ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -87,13 +87,13 @@ Accept wildcard characters: False ``` ### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. +The RecipientAddress parameter filters the results by the recipient's email address. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -111,7 +111,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -123,13 +123,15 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -155,7 +157,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -171,7 +173,7 @@ The MessageId parameter filters the results by the Message-ID header field of th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,7 +189,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,7 +205,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,7 +221,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -235,7 +237,7 @@ The SenderAddress parameter filters the results by the sender's email address. Y Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -247,13 +249,15 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -267,12 +271,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md b/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md new file mode 100644 index 0000000000..78e1a37969 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageTraceDetailV2.md @@ -0,0 +1,211 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2 +applicable: Exchange Online +title: Get-MessageTraceDetailV2 +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MessageTraceDetailV2 + +## SYNOPSIS + +## SYNTAX + +``` +Get-MessageTraceDetailV2 [-MessageTraceId] [-RecipientAddress] + [[-Action] ] + [[-EndDate] ] + [[-Event] ] + [[-MessageId] ] + [[-SenderAddress] ] + [[-StartDate] ] + [] +``` + +## DESCRIPTION +You can use this cmdlet to search message data for the last 90 days. You can only query 10 days worth of data per query. If you enter a timeframe that's older than 90 days, you receive an error and the command will return no results. + +Throttling limit: A maximum of 100 query requests will be accepted within 5 minutes running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the past 5 minutes + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceDetailV2 -MessageTraceId ae5c1219-4c90-41bf-fef5-08d837917e7c -RecipientAddress robert@contoso.com +``` + +This example retrieves detailed message trace information for messages with the message trace ID value ae5c1219-4c90-41bf-fef5-08d837917e7c that were received by `robert@contoso.com`. + +### Example 2 +```powershell +Get-MessageTraceV2 -MessageTraceId 2bbad36aa4674c7ba82f4b307fff549f -SenderAddress john@contoso.com -StartDate 06/13/2025 -EndDate 06/15/2025 | Get-MessageTraceDetailV2 +``` + +This example uses the Get-MessageTraceV2 cmdlet to retrieve message trace information for messages with the Exchange Network Message ID value 2bbad36aa4674c7ba82f4b307fff549f sent by `john@contoso.com` between June 13, 2025 and June 15, 2025, and pipelines the results to the Get-MessageTraceDetailV2 cmdlet. + +## PARAMETERS + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Action +The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Event +The Event parameter filters the report by the message event. The following are examples of common events: + +- RECEIVE: The message was received by the service. +- SEND: The message was sent by the service. +- FAIL: The message failed to be delivered. +- DELIVER: The message was delivered to a mailbox. +- EXPAND: The message was sent to a distribution group that was expanded. +- TRANSFER: Recipients were moved to a bifurcated message because of content conversion, message recipient limits, or agents. +- DEFER: The message delivery was postponed and may be re-attempted later. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTraceV2.md b/exchange/exchange-ps/exchange/Get-MessageTraceV2.md new file mode 100644 index 0000000000..f356876da6 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-MessageTraceV2.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracev2 +applicable: Exchange Online +title: Get-MessageTraceV2 +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-MessageTraceV2 + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-MessageTraceV2 cmdlet to trace messages as they pass through the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-MessageTraceV2 + [[-EndDate] ] + [[-FromIP] ] + [[-MessageId] ] + [[-MessageTraceId] ] + [[-RecipientAddress] ] + [[-ResultSize] ] + [[-SenderAddress] ] + [[-StartDate] ] + [[-StartingRecipientAddress] ] + [[-Status] ] + [[-SubjectFilterType] ] + [[-Subject] ] + [[-ToIP] ] + [] +``` + +## DESCRIPTION +You can use this cmdlet to search message data for the last 90 days. If you run this cmdlet without any parameters, only data from the last 48 hours is returned. You can only return 10 days worth of data per query. + +By default, this cmdlet returns up to 1000 results, with a maximum of 5000 results. If your data exceeds the result size, query in multiple rounds or use smaller StartDate and EndDate intervals. + +The time stamps on the output are in UTC time format. That might be different from the time format that you used for the -StartDate and the -EndDate parameters. + +Throttling limit: A maximum of 100 query requests will be accepted within 5 minutes running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the past 5 minutes + +Pagination isn't supported in this cmdlet. To query subsequent data, use the StartingRecipientAddress and EndDate parameters with the values from the **Recipient address** and **Received Time** properties respectively of the previous result in the next query. + +Best Practices: + +- Use the ResultSize parameter to adjust the size of your results. +- Be as precise as possible. Narrow the gap between StartDate and EndDate and use additional parameters (for example, SenderAddress) where possible. +- Use MessageTraceId where possible (required for messages sent to more than 1000 recipients). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-MessageTraceV2 -SenderAddress john@contoso.com -StartDate 06/13/2025 -EndDate 06/15/2025 +``` + +This example retrieves message trace information for messages sent by `john@contoso.com` between June 13, 2025 and June 15, 2025. + +## PARAMETERS + +### -EndDate +The EndDate parameter specifies the end date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -FromIP +The FromIP parameter filters the results by the source IP address. For incoming messages, the value of FromIP is the public IP address of the SMTP email server that sent the message. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageId +The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -MessageTraceId +The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1). + +The MessageTraceId value is also available in the output of the following cmdlets: + +- Get-MailDetailATPReport +- Get-MailDetailDlpPolicyReport +- Get-MailDetailEncryptionReport +- Get-MailDetailTransportRuleReport +- Get-MessageTraceDetailV2 + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 5 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. A valid value is from 1 to 5000. The default value is 1000. + +**Note**: This parameter replaces the PageSize parameter that was available on the Get-MessageTrace cmdlet. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 6 +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SenderAddress +The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartDate +The StartDate parameter specifies the start date of the date range. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM". + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 8 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -StartingRecipientAddress +The StartingRecipientAddress parameter is used with the EndDate parameter to query subsequent data for partial results while avoiding duplication. Query subsequent data by taking the **Recipient address** and **Received Time** values of the last record of the partial results and using them as the values for the StartingRecipientAddress and EndDate parameters respectively in the next query. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 9 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Status +The Status parameter filters the results by the delivery status of the message. Valid values are: + +- Delivered: The message was delivered to its destination. +- Expanded: There was no message delivery because the message was addressed to a distribution group and the membership of the distribution was expanded. +- Failed: Message delivery was attempted and it failed. +- FilteredAsSpam: The message was marked as spam. +- GettingStatus: The message is waiting for status update. +- None: The message has no delivery status because it was rejected or redirected to a different recipient. +- Pending: Message delivery is underway or was deferred and is being retried. +- Quarantined: The message was quarantined. + +You can separate multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 10 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subject +The Subject parameter filters the results by the subject of the message. If the value contains spaces, enclose the value in quotation marks ("). + +You specify how the value is evaluated in the message subject by using the SubjectFilterType parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 11 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SubjectFilterType +The SubjectFilterType parameter specifies how the value of the Subject parameter is evaluated. Valid values are: + +- Contains +- EndsWith +- StartsWith + +We recommend using StartsWith or EndsWith instead of Contains whenever possible. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 12 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ToIP +The ToIP parameter filters the results by the destination IP address. For outgoing messages, the value of ToIP is the public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 13 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md b/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md index df0bbec744..877d2fd0a3 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingLog.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-messagetrackinglog +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrackinglog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MessageTrackingLog schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MessageTrackingLog cmdlet to search for message delivery information stored in the message tracking log. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,20 +49,27 @@ The field names displayed in the results from the Get-MessageTrackingLog cmdlet - The recipient-address field is displayed as Recipients. - The sender-address field is displayed as Sender. -For more information about the message tracking log files, see [Message tracking](https://docs.microsoft.com/Exchange/mail-flow/transport-logs/message-tracking). +For more information about the message tracking log files, see [Message tracking](https://learn.microsoft.com/Exchange/mail-flow/transport-logs/message-tracking). You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > ` to the command. For example: `Get-MessageTrackingLog -Start "03/13/2020 09:00:00" -End "03/13/2020 09:10:00" | ConvertTo-Html > "C:\My Documents\message track.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-MessageTrackingLog -Server Mailbox01 -Start "03/13/2018 09:00:00" -End "03/15/2018 17:00:00" -Sender "john@contoso.com" +Get-MessageTrackingLog -Server Mailbox01 -Start "03/13/2024 09:00:00" -End "03/15/2024 17:00:00" -Sender "john@contoso.com" ``` -This example searches the message tracking logs on the Mailbox server named Mailbox01 for information about all messages sent from March 13, 2018, 09:00 to March 15, 2018, 17:00 by the sender john@contoso.com. +This example searches the message tracking logs on the Mailbox server named Mailbox01 for information about all messages sent from March 13, 2024, 09:00 to March 15, 2024, 17:00 by the sender john@contoso.com. + +### Example 2 +```powershell +Get-MessageTrackingLog -Server Mailbox01 -Start "03/13/2024 09:00:00" -Recipients @("john@contoso.com","alice@contoso.com") +``` + +This example searches the message tracking logs on the Mailbox server named Mailbox01 for information about all messages sent from March 13, 2024, 09:00 to today for the recipients john@contoso.com and/or alice@contoso.com. ## PARAMETERS @@ -87,7 +94,7 @@ Accept wildcard characters: False ### -End The End parameter specifies the end date and time of the date range. Message delivery information is returned up to, but not including, the specified date and time. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -169,7 +176,7 @@ Accept wildcard characters: False ``` ### -Recipients -The Recipients parameter filters the message tracking log entries by the SMTP email address of the message recipients. Multiple recipients in a single message are logged in a single message tracking log entry. Unexpanded distribution group recipients are logged by using the group's SMTP email address. You can specify multiple recipient email addresses separated by commas. +The Recipients parameter filters the message tracking log entries by the SMTP email address of the message recipients. Multiple recipients in a single message are logged in a single message tracking log entry. Unexpanded distribution group recipients are logged by using the group's SMTP email address. You can specify multiple recipients using an array of email addresses. ```yaml Type: String[] @@ -258,7 +265,7 @@ Accept wildcard characters: False ### -Start The Start parameter specifies the start date and time of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -290,7 +297,7 @@ Accept wildcard characters: False ``` ### -Source -The Source parameter filters the message tracking log entries by the value of the Source field. These values indicate the transport component that's responsible for the message tracking event. For more information, see [Source values in the message tracking log](https://docs.microsoft.com/Exchange/mail-flow/transport-logs/message-tracking#source-values-in-the-message-tracking-log). +The Source parameter filters the message tracking log entries by the value of the Source field. These values indicate the transport component that's responsible for the message tracking event. For more information, see [Source values in the message tracking log](https://learn.microsoft.com/Exchange/mail-flow/transport-logs/message-tracking#source-values-in-the-message-tracking-log). ```yaml Type: String @@ -326,12 +333,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md index af92e048b9..fe0eb16c93 100644 --- a/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md +++ b/exchange/exchange-ps/exchange/Get-MessageTrackingReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-messagetrackingreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetrackingreport applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MessageTrackingReport schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Get-MessageTrackingReport ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. Use the Get-MessageTrackingReport cmdlet to return data for a specific message tracking report. This cmdlet is used by the delivery reports feature. -In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). +In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,16 +38,19 @@ Get-MessageTrackingReport [-Identity] ``` ## DESCRIPTION -This cmdlet requires the ID for the message tracking report that you want to view. Therefore, first you need to use the Search-MessageTrackingReport cmdlet to find the message tracking report ID for a specific message, and then pass the results to this cmdlet. For more information, see [Search-MessageTrackingReport](https://docs.microsoft.com/powershell/module/exchange/search-messagetrackingreport). +This cmdlet requires the ID for the message tracking report that you want to view. Therefore, first you need to use the Search-MessageTrackingReport cmdlet to find the message tracking report ID for a specific message, and then pass the results to this cmdlet. For more information, see [Search-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchange/search-messagetrackingreport). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $Temp = Search-MessageTrackingReport -Identity "David Jones" -Recipients "wendy@contoso.com" -Get-MessageTrackingReport -Identity $Temp.MessageTrackingReportID -ReportTemplate Summary + +foreach ($reportId in $Temp.MessageTrackingReportId) { + Get-MessageTrackingReport -Identity $reportId -ReportTemplate Summary -Status Delivered +} ``` This example gets the message tracking report for messages sent from one user to another. This example returns the summary of the message tracking report for a message that David Jones sent to Wendy Richardson. @@ -268,12 +271,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MigrationBatch.md b/exchange/exchange-ps/exchange/Get-MigrationBatch.md index 1da4cf033a..ecc0d0aa97 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Get-MigrationBatch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-migrationbatch +online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MigrationBatch schema: 2.0.0 @@ -16,33 +16,55 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MigrationBatch cmdlet to retrieve status information about the current migration batch. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### BatchesFromEndpoint +### Identity ``` -Get-MigrationBatch [-Endpoint ] +Get-MigrationBatch [[-Identity] ] [-Diagnostic] [-DiagnosticArgument ] [-DiagnosticInfo ] [-DomainController ] [-IncludeReport] [-Partition ] - [-Status ] + [-ResultSize ] + [-Status ] [] ``` -### Identity +### BatchesFromEndpoint ``` -Get-MigrationBatch [[-Identity] ] +Get-MigrationBatch [-Diagnostic] [-DiagnosticArgument ] - [-DiagnosticInfo ] [-DomainController ] + [-Endpoint ] + [-IncludeReport] + [-Status ] + [] +``` + +### BatchesByEndpoint +``` +Get-MigrationBatch + [-DiagnosticInfo ] + [-Endpoint ] [-IncludeReport] [-Partition ] - [-Status ] + [-ResultSize ] + [] +``` + +### BatchesByStatus +``` +Get-MigrationBatch + [-DiagnosticInfo ] + [-IncludeReport] + [-Partition ] + [-ResultSize ] + [-Status ] [] ``` @@ -55,7 +77,7 @@ The Get-MigrationBatch cmdlet displays status information about the current migr - Migration errors - Date and time when the migration was started and completed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). **Note**: In the cloud-based service, if you don't use the TimeZone parameter in the New-MigrationBatch command, the default time zone for the migration batch is UTC. The CompleteAfter and CompleteAfterUTC properties will contain the same value (as will the StartAfter and StartAfterUTC properties). When you create the migration batch in the Exchange admin center (EAC), the time zone that's used is based on your regional configuration. @@ -77,32 +99,34 @@ This example displays information about all migration batches associated with th ## PARAMETERS -### -Diagnostic -This parameter is available only in on-premises Exchange. +### -Identity +The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +If you use this parameter, you can't include the Endpoint parameter. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: MigrationBatchIdParameter +Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -DiagnosticArgument +### -Diagnostic This parameter is available only in on-premises Exchange. -The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml -Type: String -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: Identity, BatchesFromEndpoint Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -113,14 +137,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -DiagnosticArgument This parameter is available only in on-premises Exchange. -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: String +Parameter Sets: Identity, BatchesFromEndpoint Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -134,11 +158,31 @@ Accept wildcard characters: False ### -DiagnosticInfo This parameter is available only in the cloud-based service. -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. +Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: + +- attachmentid=String +- batch=String +- confirm +- duration=String +- endpoints +- endtime=DateTime +- maxsize=Int32 +- organization=String +- partition=String +- reportid=String +- reports +- showtimeline +- showtimeslots=String +- starttime=DateTime +- status=String +- storage +- type=String +- user=String +- verbose ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: Applicable: Exchange Online @@ -149,16 +193,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Endpoint -The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint. +### -DomainController +This parameter is available only in on-premises Exchange. -If you use this parameter, you can't include the Identity parameter. +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: BatchesFromEndpoint +Type: Fqdn +Parameter Sets: Identity, BatchesFromEndpoint Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,21 +211,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter identifies the name of the current migration batch. The value for this parameter is specified by the Name parameter of the New-MigrationBatch cmdlet. +### -Endpoint +The Endpoint parameter returns a list of migration batches associated with the specified migration endpoint. -If you use this parameter, you can't include the Endpoint parameter. +If you use this parameter, you can't include the Identity parameter. ```yaml -Type: MigrationBatchIdParameter -Parameter Sets: Identity +Type: MigrationEndpointIdParameter +Parameter Sets: BatchesFromEndpoint, BatchesByEndpoint Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -210,7 +254,25 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: Identity, BatchesByEndpoint, BatchesByStatus Aliases: Applicable: Exchange Online @@ -241,8 +303,8 @@ The Status parameter returns a list of migration batches that have the specified - Waiting ```yaml -Type: Microsoft.Exchange.Data.Storage.Management.MigrationBatchStatus -Parameter Sets: (All) +Type: MMigrationBatchStatus +Parameter Sets: Identity, BatchesFromEndpoint, BatchesByStatus Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -258,12 +320,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MigrationConfig.md b/exchange/exchange-ps/exchange/Get-MigrationConfig.md index 1146279bba..1d8997faf8 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationConfig.md +++ b/exchange/exchange-ps/exchange/Get-MigrationConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-migrationconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MigrationConfig schema: 2.0.0 @@ -16,18 +16,32 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MigrationConfig cmdlet to retrieve migration configuration settings on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Default ``` Get-MigrationConfig [-DomainController ] - [-Partition ] + [] +``` + +### Partition +``` +Get-MigrationConfig [-Partition ] + [-IncludeSimplifiedGmailMigrationData] + [] +``` + +### AllPartitions +``` +Get-MigrationConfig [-AllPartitions] + [-IncludeSimplifiedGmailMigrationData] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,6 +54,24 @@ This example retrieves the settings for the migration configuration. ## PARAMETERS +### -AllPartitions +This parameter is available only in the cloud-based service. + +{{ Fill AllPartitions Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AllPartitions +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController This parameter is available only in on-premises Exchange. @@ -47,7 +79,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -58,6 +90,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeSimplifiedGmailMigrationData +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSimplifiedGmailMigrationData Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Partition, AllPartitions +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Partition This parameter is available only in the cloud-based service. @@ -65,7 +115,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Partition Aliases: Applicable: Exchange Online @@ -81,12 +131,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md index 10f0bc27fe..8f8f5dd3c9 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md +++ b/exchange/exchange-ps/exchange/Get-MigrationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-migrationendpoint +online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationendpoint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MigrationEndpoint schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MigrationEndpoint cmdlet to retrieve migration endpoint settings for source or destination servers for cutover or staged Exchange migrations, IMAP migrations, and remote moves. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -63,10 +63,10 @@ The Get-MigrationEndpoint cmdlet retrieves settings for different types of migra For more information about the different move and migration scenarios, see: -- [Mailbox moves in Exchange Server](https://docs.microsoft.com/Exchange/recipients/mailbox-moves) -- [Manage on-premises mailbox moves in Exchange Server](https://docs.microsoft.com/Exchange/architecture/mailbox-servers/manage-mailbox-moves) +- [Mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/recipients/mailbox-moves) +- [Manage on-premises mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/architecture/mailbox-servers/manage-mailbox-moves) -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,6 +79,22 @@ This example retrieves the settings for the migration endpoint, OnboardingME01. ## PARAMETERS +### -Identity +The Identity parameter specifies the name of the migration endpoint you want to retrieve settings for. + +```yaml +Type: MigrationEndpointIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -ConnectionSettings This parameter is available only in on-premises Exchange. @@ -100,7 +116,9 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -136,7 +154,27 @@ Accept wildcard characters: False ### -DiagnosticInfo This parameter is available only in the cloud-based service. -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. +Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: + +- attachmentid=String +- batch=String +- confirm +- duration=String +- endpoints +- endtime=DateTime +- maxsize=Int32 +- organization=String +- partition=String +- reportid=String +- reports +- showtimeline +- showtimeslots=String +- starttime=DateTime +- status=String +- storage +- type=String +- user=String +- verbose ```yaml Type: String @@ -169,22 +207,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the migration endpoint you want to retrieve settings for. - -```yaml -Type: MigrationEndpointIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Partition This parameter is available only in the cloud-based service. @@ -229,12 +251,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MigrationStatistics.md b/exchange/exchange-ps/exchange/Get-MigrationStatistics.md index 43dc2e0e72..c397c884ee 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MigrationStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-migrationstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationstatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MigrationStatistics schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MigrationStatistics cmdlet to view detailed information about migration requests. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-MigrationStatistics [-Diagnostic] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,7 +46,9 @@ This example returns the default statistics for the migration batches. ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -82,7 +84,27 @@ Accept wildcard characters: False ### -DiagnosticInfo This parameter is available only in the cloud-based service. -Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. +Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. Valid values are: + +- attachmentid=String +- batch=String +- confirm +- duration=String +- endpoints +- endtime=DateTime +- maxsize=Int32 +- organization=String +- partition=String +- reportid=String +- reports +- showtimeline +- showtimeslots=String +- starttime=DateTime +- status=String +- storage +- type=String +- user=String +- verbose ```yaml Type: String @@ -138,12 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MigrationUser.md b/exchange/exchange-ps/exchange/Get-MigrationUser.md index 88f9510a85..e379851050 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Get-MigrationUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-migrationuser +online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationuser applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MigrationUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MigrationUser cmdlet to view information about move and migration users. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-MigrationUser -MailboxGuid [-DomainController ] + [-IncludeAssociatedUsers] [-ResultSize ] [-Partition ] [] @@ -31,10 +32,9 @@ Get-MigrationUser -MailboxGuid ### StatusAndBatchId ``` -Get-MigrationUser [-BatchId ] - [-Status ] - [-StatusSummary ] +Get-MigrationUser [-BatchId ] [-Status ] [-StatusSummary ] [-DomainController ] + [-IncludeAssociatedUsers] [-ResultSize ] [-Partition ] [] @@ -44,6 +44,7 @@ Get-MigrationUser [-BatchId ] ``` Get-MigrationUser [[-Identity] ] [-DomainController ] + [-IncludeAssociatedUsers] [-ResultSize ] [-Partition ] [] @@ -53,13 +54,14 @@ Get-MigrationUser [[-Identity] ] ``` Get-MigrationUser -EmailAddress [-DomainController ] + [-IncludeAssociatedUsers] [-ResultSize ] [-Partition ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,6 +95,22 @@ This example retrieves more detailed information about any ongoing migration for ## PARAMETERS +### -Identity +The Identity parameter specifies the particular ongoing migration that you want to retrieve information about. The Identity parameter is usually represented as an email address. + +```yaml +Type: MigrationUserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -MailboxGuid The MailboxGuid parameter specifies the GUID of a mailbox for which you want to view the migration information. @@ -143,32 +161,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the particular ongoing migration that you want to retrieve information about. The Identity parameter is usually represented as an email address. +### -EmailAddress +The EmailAddress parameter specifies the particular user that you want to retrieve information about. The EmailAddress parameter is represented as an email address. This parameter is available only in the cloud-based service. ```yaml -Type: MigrationUserIdParameter -Parameter Sets: Identity +Type: EmailAddress +Parameter Sets: EmailAddress Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online -Required: False -Position: 1 +Required: True +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -EmailAddress -The EmailAddress parameter specifies the particular user that you want to retrieve information about. The EmailAddress parameter is represented as an email address. This parameter is available only in the cloud-based service. +### -IncludeAssociatedUsers +This parameter is available only in the cloud-based service. + +{{ Fill IncludeAssociatedUsers Description }} ```yaml -Type: EmailAddress -Parameter Sets: EmailAddress +Type: SwitchParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -274,12 +294,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md b/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md index ece6d18f95..5e64b3de72 100644 --- a/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MigrationUserStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-migrationuserstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-migrationuserstatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MigrationUserStatistics schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MigrationUserStatistics cmdlet to view detailed information about the migration requested for a specific user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,16 +26,17 @@ Get-MigrationUserStatistics [-Identity] [-DiagnosticArgument ] [-DiagnosticInfo ] [-DomainController ] + [-IncludeCopilotReport] [-IncludeReport] - [-LimitSkippedItemsTo ] [-IncludeSkippedItems] + [-LimitSkippedItemsTo ] [-Partition ] [-SkipSubscription] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,7 +103,9 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -171,8 +174,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeCopilotReport +This parameter is available only in the cloud-based service. + +{{ Fill IncludeCopilotReport Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -258,12 +279,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MobileDevice.md b/exchange/exchange-ps/exchange/Get-MobileDevice.md index 34d30f0f4e..7da6e04fbb 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDevice.md +++ b/exchange/exchange-ps/exchange/Get-MobileDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mobiledevice +online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MobileDevice schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MobileDevice cmdlet to get the list of devices in your organization that have active partnerships. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -55,13 +55,13 @@ Get-MobileDevice [[-Identity] ] ## DESCRIPTION The Get-MobileDevice cmdlet returns identification, configuration, and status information for each mobile device. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-MobileDevice -Mailbox "TonySmith" +Get-MobileDevice -Mailbox "Tony Smith" ``` This example returns all the mobile devices that Tony Smith has used that are associated with his mailbox. @@ -75,13 +75,33 @@ This example returns a summary list of all mobile devices in the organization. ### Example 3 ```powershell -Get-MobileDevice -Identity lila\ExchangeActiveSyncDevices\Android§android94732903 | Format-List +Get-MobileDevice -Identity Lila\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac | Format-List ``` This example returns detailed information about the specified device on Lila's mailbox. ## PARAMETERS +### -Identity +The Identity parameter specifies the mobile device that you want to view. You can use the following values that uniquely identifies the mobile device: + +- Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) +- Distinguished name (DN) +- GUID (same as ExchangeObjectId) + +```yaml +Type: MobileDeviceIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Mailbox The Mailbox parameter filters the results by mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -96,6 +116,8 @@ The Mailbox parameter filters the results by mailbox. You can use any value that - SamAccountName - User ID or user principal name (UPN) +You can't use this parameter with the Identity parameter. + ```yaml Type: MailboxIdParameter Parameter Sets: Mailbox @@ -144,16 +166,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can filter by the following properties: @@ -189,25 +211,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example: - -- GUID -- DeviceID - -```yaml -Type: MobileDeviceIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Monitoring This parameter is available only in on-premises Exchange. @@ -354,12 +357,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md index 0d609548ba..5a1d4c078b 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Get-MobileDeviceMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mobiledevicemailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevicemailboxpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MobileDeviceMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MobileDeviceMailboxPolicy cmdlet to retrieve the Mobile Device mailbox policy settings for a specific Mobile Device mailbox policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-MobileDeviceMailboxPolicy [[-Identity] ] ## DESCRIPTION A Mobile Device mailbox policy is a group of settings that specifies how mobile devices connect Exchange. Exchange supports multiple mobile device mailbox policies. The Get-MobileDeviceMailboxPolicy cmdlet displays all the policy settings for the specified policy. These settings include password settings, file access settings and attachment settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,37 +49,37 @@ This example returns the policy settings for the Mobile Device mailbox policy De ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the policy name. ```yaml -Type: Fqdn +Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the policy name. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MailboxPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -88,12 +88,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md index f2676c2789..d493f60367 100644 --- a/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MobileDeviceStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mobiledevicestatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-mobiledevicestatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MobileDeviceStatistics schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices. -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMobileDeviceStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXOMobileDeviceStatistics cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,6 +33,7 @@ Get-MobileDeviceStatistics [-Identity] [-ShowRecoveryPassword] [-RestApi] [-UniversalOutlook] + [-UseCustomRouting] [] ``` @@ -47,47 +48,50 @@ Get-MobileDeviceStatistics -Mailbox [-ShowRecoveryPassword] [-RestApi] [-UniversalOutlook] + [-UseCustomRouting] [] ``` ## DESCRIPTION The Get-MobileDeviceStatistics cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-MobileDeviceStatistics -Identity TonySmith +Get-MobileDeviceStatistics -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac ``` -This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. +This example retrieves the statistics for the specified mobile phone. ### Example 2 ```powershell -$UserList = Get-CASMailbox -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'" | Get-Mailbox +$UserList = Get-CASMailbox -ResultSize unlimited -Filter "HasActiveSyncDevicePartnership -eq `$true -and -not DisplayName -like 'CAS_{*'" + $UserList | foreach {Get-MobileDeviceStatistics -Mailbox $_.Identity} ``` This example uses the Get-CASMailbox cmdlet to determine who in the organization has an Exchange ActiveSync mobile device. For each mobile device, the Exchange ActiveSync device statistics are retrieved. -**Note**: For more information about OPath filter syntax, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +**Note**: For more information about OPATH filter syntax, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ### Example 3 ```powershell -Get-MobileDeviceStatistics -Mailbox TonySmith -GetMailboxLog $true -NotificationEmailAddresses "admin@contoso.com" +Get-MobileDeviceStatistics -Mailbox "Tony Smith" -GetMailboxLog -NotificationEmailAddresses "admin@contoso.com" ``` -This example retrieves the statistics for the mobile phone configured to synchronize with the mailbox that belongs to the user Tony Smith. It also outputs the log file and sends it to the System Administrator at admin@contoso.com. +This example retrieves the statistics for the mobile phone that's configured to synchronize with Tony Smith's mailbox. It also outputs the log file and sends it to the System Administrator at admin@contoso.com. ## PARAMETERS ### -Identity -The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example: +The Identity parameter specifies the mobile device that you want to view. You can use the following values that uniquely identifies the mobile device: -- GUID -- DeviceID +- Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) +- Distinguished name (DN) +- GUID (same as ExchangeObjectId) You can't use this parameter with the Mailbox parameter. @@ -168,7 +172,7 @@ Accept wildcard characters: False ``` ### -GetMailboxLog -The GetMailboxLog parameter specifies whether to send the mailbox logs via email to the administrator running the task. If the parameter is set to $true, the command sends the mailbox logs via email to the administrator running the task. The default value of this parameter is $false. +The GetMailboxLog switch specifies whether to send the mobile device statistics to the email addresses that are specified by the NotificationEmailAddresses parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -184,7 +188,9 @@ Accept wildcard characters: False ``` ### -NotificationEmailAddresses -The NotificationEmailAddresses parameter specifies an optional list of comma-separated aliases or email addresses where the mailbox logs are sent. If the GetMailboxLog parameter is set to $false, this parameter is ignored. +The NotificationEmailAddresses parameter specifies a comma-separated list of email addresses to receive the mobile device statistics when you use the GetMailboxLog switch. + +This parameter is meaningful only if you also use the GetMailboxLog switch in the same command. ```yaml Type: MultiValuedProperty @@ -216,7 +222,7 @@ Accept wildcard characters: False ``` ### -ShowRecoveryPassword -The ShowRecoveryPassword parameter specifies whether to return the recovery password for the mobile phone as one of the displayed statistics. If this parameter is set to $true, the command returns the recovery password for the mobile phone as one of the displayed statistics. +The ShowRecoveryPassword switch specifies whether to return the recovery password for the mobile device as one of the displayed statistics. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -263,17 +269,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md b/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md index 294f6df5d2..b720090806 100644 --- a/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md +++ b/exchange/exchange-ps/exchange/Get-MonitoringItemHelp.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-monitoringitemhelp +online version: https://learn.microsoft.com/powershell/module/exchange/get-monitoringitemhelp applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MonitoringItemHelp schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MonitoringItemHelp cmdlet to discover the monitoring items that you can use to return health information about your Exchange servers. Monitoring items are preconfigured to help you with your server health and monitoring. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-MonitoringItemHelp [-Identity] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,12 +81,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md b/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md index dfd06f1d2a..993413da94 100644 --- a/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md +++ b/exchange/exchange-ps/exchange/Get-MonitoringItemIdentity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-monitoringitemidentity +online version: https://learn.microsoft.com/powershell/module/exchange/get-monitoringitemidentity applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-MonitoringItemIdentity schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-MonitoringItemIdentity cmdlet to discover the monitoring items that you can use to return health information about your Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-MonitoringItemIdentity [-Identity] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,12 +81,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MoveRequest.md b/exchange/exchange-ps/exchange/Get-MoveRequest.md index 68a49cf290..9bd1b19333 100644 --- a/exchange/exchange-ps/exchange/Get-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Get-MoveRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-moverequest +online version: https://learn.microsoft.com/powershell/module/exchange/get-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MoveRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-MoveRequest cmdlet to view the detailed status of an ongoing asynchronous mailbox move that was initiated by using the New-MoveRequest cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -50,6 +50,7 @@ Get-MoveRequest [-BatchName ] [-ResultSize ] [-SortBy ] [-SourceDatabase ] + [-Status ] [-Suspend ] [-SuspendWhenReadyToComplete ] [-TargetDatabase ] @@ -59,7 +60,7 @@ Get-MoveRequest [-BatchName ] ## DESCRIPTION The search criteria for the Get-MoveRequest cmdlet is a Boolean And statement. If you use multiple parameters, it narrows your search and reduces your search results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -149,7 +150,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -272,7 +273,7 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -311,7 +312,7 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -418,7 +419,7 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -451,6 +452,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Status +This parameter is available only in the cloud-based service. + +The Status parameter filters the results by status. Valid values are: + +- AutoSuspended +- Completed +- CompletedWithSkippedItems +- CompletedWithWarning +- CompletionInProgress +- Failed +- InProgress +- Queued +- Retrying +- Suspended +- Synced + +```yaml +Type: RequestStatus +Parameter Sets: Filtering +Aliases: MoveStatus +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Suspend The Suspend parameter specifies whether to return mailboxes with moves that have been suspended. This parameter accepts $true or $false. @@ -516,12 +547,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md b/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md index b8fba6b9e4..8f312cf0ae 100644 --- a/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-MoveRequestStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-moverequeststatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-moverequeststatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-MoveRequestStatistics schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Get-MoveRequestStatistics cmdlet to view detailed information about move Some of the failure messages that are returned by this cmdlet are temporary and don't indicate that a request has actually failed. If the Status value is Queued or InProgress, then the request is proceeding normally. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,6 +36,7 @@ Get-MoveRequestStatistics [-Identity] ### IdentityCloud ``` Get-MoveRequestStatistics [-Identity] + [-Analysis] [-DiagnosticInfo ] [-DiagnosticOnly] [-IncludeReport] @@ -65,7 +66,7 @@ Get-MoveRequestStatistics -MRSInstance ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -104,6 +105,13 @@ Get-MoveRequestStatistics -MRSInstance CAS01.contoso.com -MailboxGuid b6a6795c-a In Exchange Server 2010, this example returns default statistics for a mailbox that has been moved by the instance of the Microsoft Exchange Mailbox Replication service running on the server CAS01. +### Example 6 +```powershell +Get-MoveRequestStatistics tony@contoso.com -IncludeReport -DiagnosticInfo Verbose | Export-Clixml "C:\Data\MoveReport.xml" +``` + +This example exports the move request information so you can later import it into the MRS_Explorer.ps1 script for analysis. For more information, see [MRS-Explorer](https://github.com/zarkatech/MRS-Explorer). + ## PARAMETERS ### -Identity @@ -159,7 +167,7 @@ Accept wildcard characters: False ``` ### -MRSInstance -This parameter is available only in on-premises Exchange Server 2010. +This parameter is available only in Exchange Server 2010. The MRSInstance parameter specifies the fully qualified domain name (FQDN) of the Client Access server on which the Microsoft Exchange Mailbox Replication service (MRS) resides. When using this parameter, all records are returned for this instance of MRS. @@ -178,6 +186,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Analysis +This parameter is available only in the cloud-based service. + +{{ Fill Analysis Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Diagnostic This parameter is available only in on-premises Exchange. @@ -201,9 +227,7 @@ Accept wildcard characters: False ### -DiagnosticArgument This parameter is available only in on-premises Exchange. -The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. You don't need to specify a value with this switch. - -Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: String @@ -362,12 +386,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MxRecordReport.md b/exchange/exchange-ps/exchange/Get-MxRecordReport.md index b952aba6ca..1600495130 100644 --- a/exchange/exchange-ps/exchange/Get-MxRecordReport.md +++ b/exchange/exchange-ps/exchange/Get-MxRecordReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-mxrecordreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-mxrecordreport applicable: Exchange Online, Exchange Online Protection title: Get-MxRecordReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-MxRecordReport cmdlet to view information about the mail exchanger (MX) records that are configured for a specified domain. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +27,7 @@ Get-MxRecordReport [-Domain ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,12 +77,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md index 3275470573..ad5461513b 100644 --- a/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Get-MyAnalyticsFeatureConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig applicable: Exchange Online title: Get-MyAnalyticsFeatureConfig schema: 2.0.0 @@ -12,13 +12,13 @@ ms.author: chrisda # Get-MyAnalyticsFeatureConfig ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Get-MyAnalyticsFeatureConfig cmdlet to view the availability and feature status of MyAnalytics for the specified user. **Note**: This cmdlet replaces the Get-UserAnalyticsConfig cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,13 +29,18 @@ Get-MyAnalyticsFeatureConfig -Identity ``` ## DESCRIPTION -This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator - Exchange Administrator - Insights Administrator -To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. ## EXAMPLES @@ -46,7 +51,7 @@ c:\users\vikram Get-MyAnalyticsFeatureConfig -Identity vikram@contoso.com UserId : vikram@contoso.com PrivacyMode : opt-in IsDashboardEnabled : true -IsAddInEnabled : true +IsAddInEnabled : true IsDigestEmailEnabled : false ``` @@ -91,12 +96,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md b/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md index 85ec937f8d..3b753febcb 100644 --- a/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md +++ b/exchange/exchange-ps/exchange/Get-NetworkConnectionInfo.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-networkconnectioninfo +online version: https://learn.microsoft.com/powershell/module/exchange/get-networkconnectioninfo applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-NetworkConnectionInfo schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-NetworkConnectionInfo cmdlet to view the network configuration information for all network adapters configured on the local server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ This cmdlet retrieves the following configuration information for each network a - AdapterGuid: This field displays the GUID assigned to the network adapter by Windows. - MacAddress: This field displays the media access control (MAC) address of the network adapter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,44 +48,44 @@ This example retrieves network configuration information for all network adapter ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the server you want to query. You can use any value that uniquely identifies the server. For example: -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use the Identity parameter, the command is run on the local server. ```yaml -Type: Fqdn +Type: ServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the server you want to query. You can use any value that uniquely identifies the server. For example: - -- Name -- FQDN -- Distinguished name (DN) -- Exchange Legacy DN +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -If you don't use the Identity parameter, the command is run on the local server. +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: ServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -94,12 +94,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-Notification.md b/exchange/exchange-ps/exchange/Get-Notification.md index fa2a9f76ba..a354e891db 100644 --- a/exchange/exchange-ps/exchange/Get-Notification.md +++ b/exchange/exchange-ps/exchange/Get-Notification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-notification +online version: https://learn.microsoft.com/powershell/module/exchange/get-notification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-Notification schema: 2.0.0 @@ -14,9 +14,18 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Get-Notification cmdlet to view notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notification events are related to: +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. The classic Exchange admin center was deprecated in the cloud-based service in 2023. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the Get-Notification cmdlet to view notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notifications are related to the following events: + +- Mailbox moves and migrations. +- Expiring and expired certificates. +- Exporting mailbox content to .pst files. +- Importing mailbox content from .pst files. +- Restoring deleted mailboxes. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,7 +55,7 @@ Get-Notification [-ProcessType ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +82,22 @@ This example displays detailed information for the specified notification event. ## PARAMETERS +### -Identity +The Identity parameter specifies the notification event that you want to view. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command Get-Notification | Format-List DisplayName,AlternateID,StartTime,Status,Type. + +```yaml +Type: EwsStoreObjectIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Settings This parameter is available only in on-premises Exchange. @@ -113,22 +138,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the notification event that you want to view. You identify the notification event by its AlternativeID property value (a GUID). You can find this value by running the command Get-Notification | Format-List DisplayName,AlternateID,StartTime,Status,Type. - -```yaml -Type: EwsStoreObjectIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -ProcessType The ProcessType parameter filters the results by the type of notification event. Valid values are: @@ -183,7 +192,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -221,12 +230,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-O365ClientBrowserDetailReport.md b/exchange/exchange-ps/exchange/Get-O365ClientBrowserDetailReport.md deleted file mode 100644 index 822d90d2bf..0000000000 --- a/exchange/exchange-ps/exchange/Get-O365ClientBrowserDetailReport.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-o365clientbrowserdetailreport -applicable: Exchange Online -title: Get-O365ClientBrowserDetailReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-O365ClientBrowserDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-O365ClientBrowserDetailReport cmdlet to get a detailed report of client browser use. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-O365ClientBrowserDetailReport [-Browser ] - [-BrowserVersion ] - [-EndDate ] - [-ResultSize ] - [-StartDate ] - [-WindowsLiveID ] - [] -``` - -## DESCRIPTION -This report provides browser details for all active users. The data contains a maximum of four browsers per user, and are aggregated daily and retained for 5 days. The properties that are returned in the results are described in the following list. - -- TenantGuid: Unique identifier of the tenant. -- TenantName: Tenant name. -- Date: The timestamp for the connection for the browser and version combination. -- WindowsLiveID: User ID in the format user@domain. -- DisplayName: User name. -- LastAccessTime: Last date the user connected with this browser and version combination. -- ObjectId: User object ID. -- Browser: Browser name. -- BrowserVersion: Browser version. -- BrowserUsageCount: Number of days this browser and version combination was used during the period of the report - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-O365ClientBrowserDetailReport -WindowsLiveID john@contoso.com -StartDate 05/01/2016 -EndDate 05/03/2016 -``` - -This example retrieves the browser details for the user john@contoso.com between May 1, 2016 and May 3, 2016. - -### Example 2 -```powershell -Get-O365ClientBrowserDetailReport -Browser Chrome -``` - -This example retrieves the details for the Chrome browser for the current 5 day retention period (no start and end date are specified). - -## PARAMETERS - -### -Browser -The Browser parameter filters the report by browser. If you don't use this parameter, all browsers will be included. The accepted values for this parameter are: - -- IE -- Firefox -- Chrome -- Safari -- Opera - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BrowserVersion -The BrowserVersion parameter filters the report by browser version. If you don't use this parameter, all browser versions will be included in the results. This parameter accepts version numbers up to the first minor version. For example, use 11 or 11.0, not 11.0.9600.17105. Wildcards are not accepted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsLiveID -The WindowsLiveID parameter filters the report by user ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-O365ClientBrowserReport.md b/exchange/exchange-ps/exchange/Get-O365ClientBrowserReport.md deleted file mode 100644 index 14d66a779d..0000000000 --- a/exchange/exchange-ps/exchange/Get-O365ClientBrowserReport.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-o365clientbrowserreport -applicable: Exchange Online -title: Get-O365ClientBrowserReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-O365ClientBrowserReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-O365ClientBrowserReport cmdlet to get a summary report of client browser use. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-O365ClientBrowserReport [-Browser ] - [-EndDate ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -The report displays the client use statistics for the five most recent versions of the browsers named in the Browser parameter description. All previous browser versions are combined into a sixth category named Others. The following list describes the properties that are returned in the results. - -- TenantGuid: Unique identifier of the tenant. -- TenantName: Tenant name. -- Date: Last time the line item data was aggregated. -- Browser: Browser name. -- Version: Browser version. -- TotalBrowserCount: Number of times a given browser and version combination connected to the service during the reporting period. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-O365ClientBrowserReport -Browser IE -``` - -This example gets the summary report of client Internet Explorer use for the 366 day data retention period (no start and end date are specified). - -### Example 2 -```powershell -Get-O365ClientBrowserReport -StartDate 06/13/2015 -EndDate 06/15/2015 -``` - -This example retrieves the client browser information for all browsers between June 13, 2015 and June 15, 2015. - -## PARAMETERS - -### -Browser -The Browser parameter filters the report by browser. If you don't use this parameter, all browsers will be included. The accepted values for this parameter are: - -- IE -- Firefox -- Chrome -- Safari -- Opera - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-O365ClientOSDetailReport.md b/exchange/exchange-ps/exchange/Get-O365ClientOSDetailReport.md deleted file mode 100644 index d839b1669f..0000000000 --- a/exchange/exchange-ps/exchange/Get-O365ClientOSDetailReport.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-o365clientosdetailreport -applicable: Exchange Online -title: Get-O365ClientOSDetailReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-O365ClientOSDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-O365ClientOSDetailReport cmdlet to get a detailed report of client operating system use. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-O365ClientOSDetailReport [-EndDate ] - [-OperatingSystem ] - [-OperatingSystemVersion ] - [-ResultSize ] - [-StartDate ] - [-WindowsLiveID ] - [] -``` - -## DESCRIPTION -This report provides operating system details for all active users. The data contains a maximum of four operating systems per user, are aggregated daily and retained for 5 days. The properties that are returned in the results are described in the following list. - -- TenantGuid: Unique identifier of the tenant. -- TenantName: Tenant name. -- Date: The timestamp for the connection for the operating system and version combination. -- WindowsLiveID: User ID in the format user@domain. -- DisplayName: User name. -- LastAccessTime: Last date the user connected with this operating system and version combination. -- ObjectId: User object ID. -- OperatingSystem: Operating system name. -- Version: Operating system version. -- OperatingSystemUsageCount: Number of days this operating system and version combination was used during the period of the report - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-O365ClientOSDetailReport -WindowsLiveID john@contoso.com -StartDate 05/01/2016 -EndDate 05/03/2016 -``` - -This example retrieves the operating system details for user John between May 1, 2016 and May 3, 2016. - -### Example 2 -```powershell -Get-O365ClientOSDetailReport -OperatingSystem Android -``` - -This example retrieves the operating system details for the Android operating system for the current 5 day retention period (no start and end date are specified). - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystem -The OS parameter filters the report by operating system. If you don't use this parameter, all operating systems will be included. The accepted values for this parameter are: - -- Windows -- Android -- iOS -- "Mac OS" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystemVersion -The OperatingSystemVersion parameter filters the report by operating system version. If you don't use this parameter, all operating system versions will be included. The parameter accepts version numbers up to the first minor version. For example, use 6 or 6.1, not 6.1.9600. Wildcards are not accepted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsLiveID -The WindowsLiveID filters the report by user ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-O365ClientOSReport.md b/exchange/exchange-ps/exchange/Get-O365ClientOSReport.md deleted file mode 100644 index d68ce3cef4..0000000000 --- a/exchange/exchange-ps/exchange/Get-O365ClientOSReport.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-o365clientosreport -applicable: Exchange Online -title: Get-O365ClientOSReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-O365ClientOSReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-O365ClientOSReport cmdlet to get a summary report of client operating system use. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-O365ClientOSReport [-EndDate ] - [-OS ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -The report displays the client use statistics for the five most recent versions of the operating systems named in the OS parameter description. All previous operating system versions are combined into a sixth category named Others. The following list describes the properties that are returned in the results. - -- TenantGuid: Unique identifier of the tenant. -- TenantName: Tenant name. -- Date: Last time the line item data was aggregated. -- OperatingSystem: Operating system name. -- Version: Operating system version. -- OperatingSystemUsageCount: Number of times a given operating system and version combination connected to the service during the reporting period. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-O365ClientOSReport -OS Windows -``` - -This example gets the summary report of client Windows use for the 366 day data retention period (no start and end date are specified). - -### Example 2 -```powershell -Get-O365ClientOSReport -StartDate 06/13/2013 -EndDate 06/15/2013 -``` - -This example retrieves the client operating system information between June 13, 2013 and June 15, 2013. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OS -The OS parameter filters the report by operating system. If you don't use this parameter, all operating systems will be included. The accepted values for this parameter are: - -- Windows -- Android -- iOS -- "Mac OS" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OMEConfiguration.md b/exchange/exchange-ps/exchange/Get-OMEConfiguration.md index aadb47c323..801c20e7db 100644 --- a/exchange/exchange-ps/exchange/Get-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-OMEConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-omeconfiguration -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-omeconfiguration +applicable: Exchange Online, Exchange Online Protection title: Get-OMEConfiguration schema: 2.0.0 author: chrisda @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-OMEConfiguration cmdlet to view Microsoft 365 Message Encryption (OME) configurations. +Use the Get-OMEConfiguration cmdlet to view Microsoft Purview Message Encryption configurations. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +26,7 @@ Get-OMEConfiguration [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,7 +53,7 @@ The Identity parameter specifies the OME configuration that you want to get. The Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -69,12 +67,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md b/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md index 0c3f445331..1162642bbb 100644 --- a/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md +++ b/exchange/exchange-ps/exchange/Get-OMEMessageStatus.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-omemessagestatus +online version: https://learn.microsoft.com/powershell/module/exchange/get-omemessagestatus applicable: Exchange Online title: Get-OMEMessageStatus schema: 2.0.0 @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-OMEMessageStatus cmdlet to view the Microsoft 365 Message Encryption (OME) revocation status for a specific message. +Use the Get-OMEMessageStatus cmdlet to view the Microsoft Purview Message Encryption revocation status for a specific message. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Get-OMEMessageStatus -MessageId ## DESCRIPTION If encryption for the message was successfully revoked, the command will return the message: `The encrypted email with the subject "" and Message ID "" was successfully revoked`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,7 +44,7 @@ This example returns the encryption revocation status for the specified message. ### -MessageId The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). -You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft 365 compliance center. +You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal. ```yaml Type: String @@ -66,12 +64,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md index 6c4edbb2ad..274bd7b330 100644 --- a/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-OabVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-oabvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/get-oabvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-OabVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-OabVirtualDirectory cmdlet to view offline address book (OAB) virtual directories(OAB distribution points) that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Get-OabVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +66,30 @@ This example returns detailed information for the OAB virtual directory named "O ## PARAMETERS +### -Identity +The Identity parameter specifies the OAB virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: + +- Name or Server\\Name +- Distinguished name (DN) +- GUID + +The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. + +You can't use the Identity and Server parameters in the same command. + +```yaml +Type: VirtualDirectoryIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Server The Server parameter specifies the Exchange server that hosts the virtual directory. You can use any value that uniquely identifies the server. For example: @@ -90,7 +114,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -121,30 +147,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the OAB virtual directory that you want to view. You can use any value that uniquely identifies the virtual directory. For example: - -- Name or Server\\Name -- Distinguished name (DN) -- GUID - -The Name value uses the syntax `"VirtualDirectoryName (WebsiteName)"` from the properties of the virtual directory. You can specify the wildcard character (\*) instead of the default website by using the syntax `VirtualDirectoryName*`. - -You can't use the Identity and Server parameters in the same command. - -```yaml -Type: VirtualDirectoryIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -ShowMailboxVirtualDirectories The ShowMailboxVirtualDirectories switch shows information about backend virtual directories on Mailbox servers. You don't need to specify a value with this switch. @@ -170,12 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md index 2123a27195..dbf02a696b 100644 --- a/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Get-OfflineAddressBook.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-offlineaddressbook +online version: https://learn.microsoft.com/powershell/module/exchange/get-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-OfflineAddressBook schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-OfflineAddressBook cmdlet to view offline address books (OABs). -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Get-OfflineAddressBook [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +64,28 @@ This example returns specific properties for all existing OABs, including the Ge ## PARAMETERS +### -Identity +The Identity parameter specifies the OAB that you want to view. You can use any value that uniquely identifies the OAB. For example: + +- Name or \\Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Server parameter. + +```yaml +Type: OfflineAddressBookIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Server This parameter is available only in on-premises Exchange. @@ -110,39 +132,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the OAB that you want to view. You can use any value that uniquely identifies the OAB. For example: - -- Name or \\Name -- Distinguished name (DN) -- GUID - -You can't use this parameter with the Server parameter. - -```yaml -Type: OfflineAddressBookIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md index a1183805af..18d268514c 100644 --- a/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md +++ b/exchange/exchange-ps/exchange/Get-OnPremisesOrganization.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-onpremisesorganization -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-onpremisesorganization +applicable: Exchange Online, Exchange Online Protection title: Get-OnPremisesOrganization schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-OnPremisesOrganization cmdlet to retrieve settings for the OnPremisesOrganization object that has been created for a hybrid deployment. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ The OnPremisesOrganization object represents an on-premises Exchange organizatio Manual modification of this object may result in hybrid deployment misconfiguration. We strongly recommend that you use the Hybrid Configuration wizard to modify this object in the Microsoft 365 organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,7 +61,7 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -77,12 +75,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md b/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md index 4b754bb673..57d2252911 100644 --- a/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md +++ b/exchange/exchange-ps/exchange/Get-OnlineMeetingConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-onlinemeetingconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/get-onlinemeetingconfiguration applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-OnlineMeetingConfiguration schema: 2.0.0 @@ -12,13 +12,11 @@ ms.reviewer: # Get-OnlineMeetingConfiguration ## SYNOPSIS -This cmdlet is available or functional only in the cloud-based service. +This cmdlet is functional only in the cloud-based service. Use the Get-OnlineMeetingConfiguration cmdlet to view status and usage information about Skype Meetings and Skype for Business Online for mailboxes. Skype Meetings automatically includes Skype for Business Online conference join information in Exchange Online meeting invitations. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +34,7 @@ Exchange Online maintains a per-user cache of Skype for Business Online meeting - LastSyncTime: The last time Exchange Online successfully synchronized meeting coordinates from Skype for Business Online. - LastSuccessfulSyncTime: The last time Exchange Online successfully cleaned the cached of used Skype for Business Online meeting coordinates. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,12 +95,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-OrganizationConfig.md b/exchange/exchange-ps/exchange/Get-OrganizationConfig.md index 8cea975744..0d00218842 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Get-OrganizationConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-organizationconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-OrganizationConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-OrganizationConfig cmdlet to get configuration data for an Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-OrganizationConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,7 +44,7 @@ Get-OrganizationConfig | Export-CliXML C:\Data\MyFile.xml This example gets the configuration information for the cloud-based organization. -For more information, see [Troubleshoot a hybrid deployment](https://docs.microsoft.com/exchange/hybrid-deployment/troubleshoot-a-hybrid-deployment). +For more information, see [Troubleshoot a hybrid deployment](https://learn.microsoft.com/exchange/hybrid-deployment/troubleshoot-a-hybrid-deployment). ### Example 3 ```powershell @@ -84,12 +84,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md index dccb89f1b5..0c2f80f334 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/Get-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationrelationship +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-OrganizationRelationship cmdlet to retrieve settings for an organization relationship that has been created for federated sharing with other federated Exchange organizations or for hybrid deployments with Exchange Online. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-OrganizationRelationship [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,41 +47,41 @@ This example retrieves the organization relationship settings by using the FQDN ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. +### -Identity +The Identity parameter specifies the identity of the organizational relationship. You can use the following values: -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +- Canonical name +- GUID +- Name ```yaml -Type: Fqdn +Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identity of the organizational relationship. You can use the following values: +### -DomainController +This parameter is available only in on-premises Exchange. -- Canonical name -- GUID -- Name +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: OrganizationRelationshipIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -90,12 +90,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md b/exchange/exchange-ps/exchange/Get-OrganizationSegment.md index c337d194e6..12687a5a45 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/Get-OrganizationSegment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-organizationsegment -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationsegment +applicable: Security & Compliance title: Get-OrganizationSegment schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-OrganizationSegment ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-OrganizationSegment cmdlet to view organization segments in the Microsoft 365 compliance center. +Use the Get-OrganizationSegment cmdlet to view organization segments in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Get-OrganizationSegment [[-Identity] ] ``` ## DESCRIPTION -Segments are defined by using certain [attributes](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes) in Azure Active Directory. +Segments are defined by using certain [attributes](https://learn.microsoft.com/purview/information-barriers-attributes) in Microsoft Entra ID. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -65,7 +65,7 @@ The Identity parameter specifies the organization segment that you want to view. Type: PolicyIdParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -79,18 +79,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Attributes for information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes) +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md b/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md index e9cffee73d..01e951b29f 100644 --- a/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md +++ b/exchange/exchange-ps/exchange/Get-OrganizationalUnit.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-organizationalunit +online version: https://learn.microsoft.com/powershell/module/exchange/get-organizationalunit applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-OrganizationalUnit schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-OrganizationalUnit cmdlet to view a list of organizational units (OUs) that exist in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +42,7 @@ Get-OrganizationalUnit [-SearchText ] ## DESCRIPTION The Get-OrganizationalUnit cmdlet is used by the Exchange admin center to populate fields that display OU information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,7 +53,7 @@ Get-OrganizationalUnit "North America" -SingleNodeOnly | Format-Table Name, Dist This example retrieves a list of the first level child OUs beneath the North America OU and formats the output so that only the Name and DistinguishedName properties are displayed. -For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ### Example 2 ```powershell @@ -62,7 +62,7 @@ Get-OrganizationalUnit -SearchText "Executives" | Format-Table Name, Distinguish This example retrieves a list of OUs that match the text string "Executives" and formats the output so that only the Name and DistinguishedName properties are displayed. -For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining and the Format-Table cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ## PARAMETERS @@ -178,12 +178,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnector.md b/exchange/exchange-ps/exchange/Get-OutboundConnector.md index f7bd3ce229..ef832c3069 100644 --- a/exchange/exchange-ps/exchange/Get-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/Get-OutboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-outboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/get-outboundconnector applicable: Exchange Online, Exchange Online Protection title: Get-OutboundConnector schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-OutboundConnector cmdlet to view the configuration information for an Outbound connector in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,13 +24,14 @@ For information about the parameter sets in the Syntax section below, see [Excha Get-OutboundConnector [[-Identity] ] [-IncludeTestModeConnectors ] [-IsTransportRuleScoped ] + [-ResultSize ] [] ``` ## DESCRIPTION Outbound connectors send email messages to remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -107,17 +106,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md b/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md index beba84c7a6..a111c53994 100644 --- a/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md +++ b/exchange/exchange-ps/exchange/Get-OutboundConnectorReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-outboundconnectorreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-outboundconnectorreport applicable: Exchange Online, Exchange Online Protection title: Get-OutboundConnectorReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-OutboundConnectorReport cmdlet to view the Outbound connectors that are used to deliver mail to specific domains. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +27,7 @@ Get-OutboundConnectorReport [-Domain ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,12 +77,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md index 05c90e2cec..e2189d867d 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Get-OutlookAnywhere.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-outlookanywhere +online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookanywhere applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-OutlookAnywhere schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-OutlookAnywhere cmdlet to view Outlook Anywhere virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Get-OutlookAnywhere [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -107,7 +107,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -163,12 +165,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md index 535e0da846..ed2ad0aa94 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/Get-OutlookProtectionRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-outlookprotectionrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-OutlookProtectionRule schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-OutlookProtectionRule cmdlet to retrieve Microsoft Outlook protection rules configured in an organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,9 +29,9 @@ Get-OutlookProtectionRule [[-Identity] ] ``` ## DESCRIPTION -Outlook protection rules are used to automatically Information Rights Management (IRM)-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To IRM-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). +Outlook protection rules are used to automatically Information Rights Management (IRM)-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To IRM-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,37 +53,37 @@ The Identity parameter is positional. When used after the cmdlet name, the param ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter identifies an Outlook protection rule. ```yaml -Type: Fqdn +Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter identifies an Outlook protection rule. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: RuleIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -92,12 +92,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OutlookProvider.md b/exchange/exchange-ps/exchange/Get-OutlookProvider.md index 5b45455858..72b2e977b7 100644 --- a/exchange/exchange-ps/exchange/Get-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/Get-OutlookProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-outlookprovider +online version: https://learn.microsoft.com/powershell/module/exchange/get-outlookprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-OutlookProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-OutlookProvider cmdlet to obtain the global settings from the AutoDiscoverConfig object under the Global Settings object in Active Directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-OutlookProvider [[-Identity] ] ## DESCRIPTION The Get-OutlookProvider cmdlet gets the global settings from the AutoDiscoverConfig object in Active Directory and returns an OutlookProvider object to be managed in the Exchange admin center. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,39 +49,39 @@ This example returns detailed information for the Outlook provider named WEB. ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the ADIDParameter value of the MAPI protocol that you want to view. Typical values are: + +- EXCH +- EXPR +- WEB ```yaml -Type: Fqdn +Type: OutlookProviderIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the ADIDParameter value of the MAPI protocol that you want to view. Typical values are: - -- EXCH -- EXPR -- WEB +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: OutlookProviderIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -90,12 +90,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md index 28e173c8a8..d3d81a63ed 100644 --- a/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Get-OwaMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-owamailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-owamailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-OwaMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-OwaMailboxPolicy cmdlet to view Outlook on the web mailbox policies in the organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-OwaMailboxPolicy [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,41 +54,41 @@ This example retrieves the information for the mailbox policy named Corporate fo ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. +### -Identity +The Identity parameter specifies the mailbox policy that you want to view. You can use any value that uniquely identifies the policy. For example: -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: Fqdn +Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the mailbox policy that you want to view. You can use any value that uniquely identifies the policy. For example: +### -DomainController +This parameter is available only in on-premises Exchange. -- Name -- Distinguished name (DN) -- GUID +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MailboxPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -97,12 +97,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md index e306926586..6087a13fe7 100644 --- a/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-OwaVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-owavirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/get-owavirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-OwaVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-OwaVirtualDirectory cmdlet to view Outlook on the web virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ The Get-OwaVirtualDirectory cmdlet can be run on a local server or run remotely The Get-OwaVirtualDirectory cmdlet can be run on any server that has the Exchange Server administration tools installed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,7 +118,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -174,12 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PartnerApplication.md b/exchange/exchange-ps/exchange/Get-PartnerApplication.md index 376ce932d8..1e1e76f5db 100644 --- a/exchange/exchange-ps/exchange/Get-PartnerApplication.md +++ b/exchange/exchange-ps/exchange/Get-PartnerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-partnerapplication +online version: https://learn.microsoft.com/powershell/module/exchange/get-partnerapplication applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PartnerApplication schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PartnerApplication cmdlet to retrieve settings for a partner application. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,9 +28,9 @@ Get-PartnerApplication [[-Identity] ] ``` ## DESCRIPTION -You can configure partner applications such as Microsoft SharePoint to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://docs.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). +You can configure partner applications such as Microsoft SharePoint to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://learn.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -100,12 +100,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md b/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md new file mode 100644 index 0000000000..ca13e8b6fa --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-PendingDelicenseUser.md @@ -0,0 +1,134 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-pendingdelicenseuser +applicable: Exchange Online, Exchange Online Protection +title: Get-PendingDelicenseUser +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-PendingDelicenseUser + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-PendingDelicenseUser cmdlet to view information about mailboxes that have delayed mailbox license removal requests. You configure delayed mailbox license removal using the DelayedDelicensingEnabled parameter on the Set-OrganizationConfig cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Get-PendingDelicenseUser [[-Identity] ] + [] +``` + +### TenantLevelParameterSet +``` +Get-PendingDelicenseUser [-ResultSize ] [-ShowDueObjectsOnly] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-PendingDelicenseUser | Format-Table DisplayName,UserPrincipalName,WhenDueForDelicensingUTC +``` + +This example returns a summary list of all mailboxes that have pending mailbox license removal requests. + +### Example 2 +```powershell +Get-PendingDelicenseUser -Identity yajvendra@contoso.onmicrosoft.com +``` + +This example returns detailed information about the pending mailbox license removal request for the specified mailbox. + +### Example 3 +```powershell +Get-PendingDelicenseUser -ShowDueObjectsOnly | Format-Table DisplayName,UserPrincipalName,WhenDueForDelicensingUTC +``` + +This example returns a summary list of all mailboxes where the 30 day delay for mailbox license removal requests has ended, so the licenses can be removed from the mailboxes at any time. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox with a pending mailbox license removal request. + +You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Email address +- GUID +- LegacyExchangeDN +- User ID or user principal name (UPN) + +You can't use this parameter with the ShowDueObjectsOnly switch. + +```yaml +Type: RecipientIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: TenantLevelParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowDueObjectsOnly +The ShowDueObjectsOnly switch filters the results by mailboxes where the 30 day delay for removing the license has ended, and the license can be removed from the mailbox at any time. You don't need to specify a value with this switch. + +You can't use this switch with the Identity parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: TenantLevelParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md b/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md index c1207198e5..e646d32251 100644 --- a/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md +++ b/exchange/exchange-ps/exchange/Get-PendingFederatedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-pendingfederateddomain +online version: https://learn.microsoft.com/powershell/module/exchange/get-pendingfederateddomain applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-PendingFederatedDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. The Get-PendingFederatedDomain cmdlet is used by the Exchange admin center to display a list of pending federated domains for the federation trust for your Exchange organization. You shouldn't use this cmdlet to attempt to manually configure a federation trust. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ Get-PendingFederatedDomain [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,12 +43,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PerimeterConfig.md b/exchange/exchange-ps/exchange/Get-PerimeterConfig.md index 7400a087ef..0559a00b0d 100644 --- a/exchange/exchange-ps/exchange/Get-PerimeterConfig.md +++ b/exchange/exchange-ps/exchange/Get-PerimeterConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-perimeterconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-perimeterconfig applicable: Exchange Online title: Get-PerimeterConfig schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-PerimeterConfig cmdlet to view the list of gateway server and internal mail server IP addresses that have been added to the cloud-based safelists. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,12 +60,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md deleted file mode 100644 index 526d456e2b..0000000000 --- a/exchange/exchange-ps/exchange/Get-PhishFilterPolicy.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-phishfilterpolicy -applicable: Exchange Online, Exchange Online Protection -title: Get-PhishFilterPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-PhishFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-PhishFilterPolicy cmdlet to view the spoof intelligence policy and detected spoofed sending activities in your cloud-based organization over the last 30 days. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-PhishFilterPolicy [[-Identity] ] - [-AllowedToSpoof ] - [-DecisionSetBy ] - [-Detailed] - [-SpoofAllowBlockList] - [-SpoofType ] - [-WidgetData] - [] -``` - -## DESCRIPTION -The Get-PhishFilterPolicy cmdlet returns the following information: - -- Sender: The true sending domain that's found in the DNS record of the source email server. If no domain is found, the source email server's IP address is shown. -- SpoofedUser: The sending email address if the domain is one of your organization's domains, or the sending domain if the domain is external. -- NumberOfMessages: The number of messages. -- NumberOfUserComplaints: The number of user complaints. -- AuthenticationResult: Indicates whether the message has passed any type of email authentication (SPF, DKIM, or DMARC) (explicit or implicit). -- LastSeen: The date when the sending email address or domain was last seen by Microsoft 365. -- DecisionSetBy: Specifies whether Microsoft 365 set the spoofing policy as allowed or not allowed to spoof, or if it was set by an admin. -- AllowedToSpoof: The three possible values are Yes (messages that contain any spoofed sender email addresses in your organization are allowed from the source email server), No (messages that contain any spoofed sender email addresses in your organization are not allowed from the source email server), and Partial (messages that contain some spoofed sender email addresses in your organization are allowed from the source email server). -- SpoofType: Indicates whether the domain is internal to your organization or external. - -For more information about spoof intelligence, see [Configure spoof intelligence in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-PhishFilterPolicy -Detailed -SpoofType Internal -``` - -This example returns the list of senders that appear to be sending spoofed email to your organization, with the additional ConfidenceLevel and DomainPairsCountInCategory properties. - -### Example 2 -```powershell -$file = "C:\My Documents\Summary Spoofed Internal Domains and Senders.csv" -Get-PhishFilterPolicy -Detailed -SpoofType Internal | Export-CSV $file -``` - -This example exports the same list of spoofed senders to a CSV file. - -## PARAMETERS - -### -Identity -This parameter is reserved for internal Microsoft use. - -```yaml -Type: HostedConnectionFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AllowedToSpoof -The AllowedToSpoof parameter filters the results by the AllowedToSpoof property value. Valid values are: - -- Yes -- No -- Partial - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DecisionSetBy -The DecisionSetBy parameter filters the results by who allowed or blocked the spoofed sender. Valid values are: - -- Admin -- SpoofProtection - -```yaml -Type: DecisionSetBy -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Detailed -The Detailed switch specifies whether to return detailed information in the results. You don't need to specify a value with this switch. - -Specifically, this switch returns the following additional properties: - -- ConfidenceLevel: Level of signals indicated by spoof intelligence that these domains may be suspicious, based on historical sending patterns and the reputation score of the domains. -- DomainPairsCountInCategory: The spoofed domains displayed are separated into two categories: suspicious domain pairs and non-suspicious domain pairs. For more information, see [this topic](https://docs.microsoft.com/microsoft-365/security/office-365-security/walkthrough-spoof-intelligence-insight). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpoofAllowBlockList -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpoofType -The SpoofType parameter filters the results by the type of spoofing. Valid values are: - -- Internal -- External - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WidgetData -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md index e4e58f5f18..7cb3d2c953 100644 --- a/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/exchange/Get-PhishSimOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-phishsimoverridepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-phishsimoverridepolicy +applicable: Exchange Online title: Get-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-PhishSimOverridePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -Use the Get-PhishSimOverridePolicy cmdlet to view third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). +Use the Get-PhishSimOverridePolicy cmdlet to view third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ Get-PhishSimOverridePolicy [[-Identity] ] [ ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,7 +50,7 @@ The Identity parameter specifies the phishing simulation override policy that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: 0 @@ -59,17 +59,29 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Get-PhishSimOverrideRule.md deleted file mode 100644 index 68e983f790..0000000000 --- a/exchange/exchange-ps/exchange/Get-PhishSimOverrideRule.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-phishsimoverriderule -applicable: Security & Compliance Center -title: Get-PhishSimOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-PhishSimOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Get-PhishSimOverrideRule cmdlet to view third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-PhishSimOverrideRule [[-Identity] ] - [-Confirm] - [-Policy ] - [-WhatIf] - [] -``` - -## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -## EXAMPLES - -### Example 1 -```powershell -Get-PhishSimOverrideRule -``` - -This example returns detailed information about the one and only phishing simulation override rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the phishing simulation override rule that you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter filters the results by phishing simulator override policy. You can use any value that uniquely identifies the policy. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Place.md b/exchange/exchange-ps/exchange/Get-Place.md index 98cd7bf9a9..c13137555b 100644 --- a/exchange/exchange-ps/exchange/Get-Place.md +++ b/exchange/exchange-ps/exchange/Get-Place.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-place +online version: https://learn.microsoft.com/powershell/module/exchange/get-place applicable: Exchange Online title: Get-Place schema: 2.0.0 @@ -16,14 +16,22 @@ This cmdlet is available only in the cloud-based service. Use the Get-Place cmdlet to view the additional metadata that was configured on room mailboxes by using the Set-Place cmdlet. The additional metadata provides a better search and room suggestion experience. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Identity +``` +Get-Place [[-Identity] ] + [-Confirm] + [-ResultSize ] + [-WhatIf] + [] +``` + +### AllPlaces ``` -Get-Place [-Identity] +Get-Place [-Type ] [-Confirm] [-ResultSize ] [-WhatIf] @@ -31,7 +39,7 @@ Get-Place [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +57,13 @@ Get-Place -Identity "Conference Room 01" | Format-List This example returns detailed metadata for Conference Room 1. +### Example 3 +```powershell +Get-Place -Type Room +``` + +This example returns all room mailboxes. + ## PARAMETERS ### -Identity @@ -61,13 +76,15 @@ The Identity parameter specifies the room mailbox that you want to view. You can - Email address - GUID +You can't use this parameter with the Type parameter. + ```yaml Type: RecipientIdParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Applicable: Exchange Online -Required: True +Required: False Position: 0 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) @@ -106,6 +123,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Type +The Type parameter filters the results by the type of room mailbox. Valid values are: + +- Room +- RoomList +- Space + +You can't use this parameter with the Identity parameter. + +```yaml +Type: GetPlaceType +Parameter Sets: AllPlaces +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf This parameter is reserved for internal Microsoft use. @@ -127,12 +166,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PolicyConfig.md b/exchange/exchange-ps/exchange/Get-PolicyConfig.md index d0482268ca..7b985e28c4 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Get-PolicyConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-policyconfig -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-policyconfig +applicable: Security & Compliance title: Get-PolicyConfig schema: 2.0.0 author: chrisda @@ -12,20 +12,20 @@ ms.reviewer: # Get-PolicyConfig ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-PolicyConfig cmdlet to view the endpoint restrictions that are configured in the organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-PolicyConfig [] +Get-PolicyConfig [[-Identity] ] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -38,17 +38,29 @@ This example returns the endpoint restrictions that are available in the organiz ## PARAMETERS +### -Identity +You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md index 984a2d3739..0704474cc3 100644 --- a/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md +++ b/exchange/exchange-ps/exchange/Get-PolicyTipConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-policytipconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-policytipconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PolicyTipConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PolicyTipConfig cmdlet to view the data loss prevention (DLP) Policy Tips in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Get-PolicyTipConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +64,29 @@ This example returns details about the custom English Policy Tip for the action ## PARAMETERS +### -Identity +The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example: + +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- The value Url +- GUID +- Distinguished name (DN) + +You can't use the Identity parameter with the Action, Locale or Original parameters. + +```yaml +Type: PolicyTipConfigIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Action The Action parameter filters the Policy Tips by action. Valid values for this parameter are: @@ -106,33 +129,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the custom Policy Tip you want to view. You can use any value that uniquely identifies the custom Policy Tip. For example: - -- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. -- The value Url -- GUID -- Distinguished name (DN) - -You can't use the Identity parameter with the Action, Locale or Original parameters. - -```yaml -Type: PolicyTipConfigIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Locale The Locale parameter specifies a locale-specific version of the Policy Tip. -Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +Valid values for this parameter are supported locale codes. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). You can't use the Locale parameter with the Identity parameter. @@ -150,7 +150,9 @@ Accept wildcard characters: False ``` ### -Original -The Original switch includes built-in Policy Tips in the results. You don't specify a value with the Original switch. You can't use the Original switch with the Identity parameter. +The Original switch specifies whether to include built-in Policy Tips in the results. You don't need to specify a value with this switch. + +You can't use the Original switch with the Identity parameter. ```yaml Type: SwitchParameter @@ -170,12 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PopSettings.md b/exchange/exchange-ps/exchange/Get-PopSettings.md index 0aec6d41dd..4223b39960 100644 --- a/exchange/exchange-ps/exchange/Get-PopSettings.md +++ b/exchange/exchange-ps/exchange/Get-PopSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-popsettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-popsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-PopSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-POPSettings cmdlet to view the configuration of the Microsoft Exchange POP3 service. This service exists on Exchange servers that have the Client Access server role installed and is used by POP3 clients to connect to Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-PopSettings [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -91,12 +91,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md index a6c39ee580..b46a6dbd1e 100644 --- a/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-PowerShellVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-powershellvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/get-powershellvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-PowerShellVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-PowerShellVirtualDirectory cmdlet to view Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Get-PowerShellVirtualDirectory [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,7 +114,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -170,12 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md index 5790b912e1..2e99bc420c 100644 --- a/exchange/exchange-ps/exchange/Get-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Get-ProtectionAlert.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-protectionalert -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-protectionalert +applicable: Security & Compliance title: Get-ProtectionAlert schema: 2.0.0 author: chrisda @@ -12,21 +12,22 @@ ms.reviewer: # Get-ProtectionAlert ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-ProtectionAlert cmdlet to view alert policies in the Microsoft 365 compliance center. +Use the Get-ProtectionAlert cmdlet to view alert policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-ProtectionAlert [[-Identity] ] + [-IncludeRuleXml] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -39,10 +40,10 @@ This example returns a summary list of all alert policies. ### Example 2 ```powershell -Get-ProtectionAlert -Identity "Malicious Email Campaign" +Get-ProtectionAlert -Identity "Malware campaign detected after delivery" ``` -This example returns detailed information about the alert policy named Malicious Email Campaign. +This example returns detailed information about the specified alert policy. ## PARAMETERS @@ -57,7 +58,7 @@ The Identity parameter specifies the alert policy that you want to view. You can Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -66,17 +67,29 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -IncludeRuleXml +{{ Fill IncludeRuleXml Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolder.md b/exchange/exchange-ps/exchange/Get-PublicFolder.md index caf40d8a04..6236c3d432 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolder cmdlet to retrieve the attributes of a public folder or a set of public folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -69,7 +69,7 @@ Get-PublicFolder [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -117,6 +117,22 @@ This example returns the public folders that reside in the public folder content ## PARAMETERS +### -Identity +The Identity parameter specifies the name and path of the public folder you want to view. A valid value uses the syntax: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. + +```yaml +Type: PublicFolderIdParameter +Parameter Sets: GetChildren, Recurse, Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -GetChildren The GetChildren switch specifies whether to return only the children of the folder specified by the Identity parameter. You don't need to specify a value with this switch. @@ -171,22 +187,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name and path of the public folder you want to view. A valid value uses the syntax: `\Level1\Level2\...\LevenN\PublicFolder`. For example, `"\Customer Discussion"` or `"\Engineering\Customer Discussion"`. - -```yaml -Type: PublicFolderIdParameter -Parameter Sets: GetChildren, Recurse, Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -LostAndFound The LostAndFound switch specifies whether to return only orphaned folders that are located in \\NON\_IPM\_SUBTREE\\LOST\_AND\_FOUND. You don't need to specify a value with this switch. @@ -253,7 +253,9 @@ Accept wildcard characters: False ``` ### -ResidentFolders -The ResidentFolders specifies whether to return public folders that reside in a specific content public folder mailbox. If this parameter isn't specified, the command will only return public folders whose contents reside in the primary hierarchy public folder mailbox. +The ResidentFolders switch specifies whether to return public folders that reside in a specific content public folder mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, the command will return only public folders whose contents reside in the primary hierarchy public folder mailbox. ```yaml Type: SwitchParameter @@ -312,12 +314,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md index 08b279018f..8827234280 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderAdministrativePermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfolderadministrativepermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderadministrativepermission applicable: Exchange Server 2010 title: Get-PublicFolderAdministrativePermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Get-PublicFolderAdministrativePermission cmdlet to get the administrative permissions for a public folder or a public folder hierarchy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Get-PublicFolderAdministrativePermission [-Identity] [ ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -177,12 +177,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md b/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md index c29d8f9192..cbf1b56f79 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderClientPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfolderclientpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderclientpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderClientPermission schema: 2.0.0 @@ -16,13 +16,14 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolderClientPermission cmdlet to retrieve the user permissions for a public folder. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-PublicFolderClientPermission [-Identity] [-DomainController ] + [-ResultSize ] [-Server ] [-User ] [-Mailbox ] @@ -32,7 +33,7 @@ Get-PublicFolderClientPermission [-Identity] ## DESCRIPTION To view the permissions that are available on public folders, see [Public folder permissions for Exchange Server](https://support.microsoft.com/help/2573274). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,6 +89,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All)) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Server This parameter is available only in Exchange Server 2010. @@ -112,7 +131,12 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the user principal name (UPN), domain\\user, or alias of a specific user for whom you want to view the permissions on the public folder. +The User parameter specifies the user for whom you want to view the permissions on the public folder. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. ```yaml Type: PublicFolderUserIdParameter @@ -161,12 +185,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md index 17e0da3815..163d873ee4 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfolderdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-PublicFolderDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-PublicFolderDatabase cmdlet to view public folder database settings for Microsoft Exchange Server 2010 or earlier public folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ You can specify either the Server or Identity parameter, but not both. Only the When you run the Get-PublicFolderDatabase cmdlet with no parameters, it returns attributes of all of the public folder databases in the Exchange organization. To return specific database properties (including backup and mount status information) where the Get-PublicFolderDatabase cmdlet has to contact servers directly or perform a complex or slow calculation, make sure you use the Status parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -140,7 +140,7 @@ This parameter is available only in Exchange Server 2010. The IncludePreExchange2010 switch specifies whether to include information about Exchange 2003 or Exchange 2007 public folders in the results. You don't need to specify a value with this switch. -This parameter isn't useful in commands where you use the Server parameter or Identity parameter. +This switch isn't useful in commands where you use the Server or Identity parameters. ```yaml Type: SwitchParameter @@ -156,7 +156,7 @@ Accept wildcard characters: False ``` ### -Status -The Status parameter specifies whether additional backup and mount status information is included for servers running Exchange 2010. If the Status parameter is included, additional backup and mount status information is included for Exchange 2010 servers. +The Status switch specifies whether to include additional backup and mount status information for servers running Exchange 2010. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -192,12 +192,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md index d2e2f981a2..7e8d13e1d4 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderItemStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfolderitemstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderitemstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderItemStatistics schema: 2.0.0 @@ -16,20 +16,21 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolderItemStatistics cmdlet to view information about items within a specified public folder. Information returned includes subject, last modification time, creation time, attachments, message size, and the type of item. You can use this raw information to better understand the distribution of items and item characteristics across public folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-PublicFolderItemStatistics [-Identity] [-DomainController ] + [-ResultSize ] [-Server ] [-Mailbox ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,6 +124,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All)) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Server This parameter is available only in Exchange Server 2010. @@ -151,12 +170,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md index e8f1ba9cb7..d7b0c82238 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxDiagnostics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxdiagnostics +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxdiagnostics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderMailboxDiagnostics schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolderMailboxDiagnostics cmdlet to view event-level information about a public folder mailbox. This information can be used to troubleshoot public folder issues. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Get-PublicFolderMailboxDiagnostics [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,7 +118,7 @@ Accept wildcard characters: False ``` ### -IncludeDumpsterInfo -The IncludeDumpsterInfo parameter specifies that diagnostic information for the \\NON\_IPM\_TREE\\DUMPSTER\_ROOT folder, which serves as the dumpster for public folder mailboxes, is included in the returned information. +The IncludeDumpsterInfo specifies whether to include diagnostic information for the \\NON\_IPM\_TREE\\DUMPSTER\_ROOT folder (the dumpster for public folder mailboxes is included in the results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -134,7 +134,9 @@ Accept wildcard characters: False ``` ### -IncludeHierarchyInfo -The IncludeHierarchyInfo switch specifies whether to include folder hierarchy information in the results. This includes the following information: +The IncludeHierarchyInfo switch specifies whether to include folder hierarchy information in the results. You don't need to specify a value with this switch. + +Using this switch returns the following information: - TotalFolderCount: The total number of public folders in the specified public folder mailbox. - MaxFolderChildCount: The largest number of child folders in the public folder hierarchy. @@ -181,12 +183,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md index a9db4eea27..4fe2797ff4 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequest +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderMailboxMigrationRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolderMailboxMigrationRequest cmdlet to view the status of individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,7 +48,7 @@ The Get-PublicFolderMailboxMigrationRequest cmdlet displays the following proper - TargetMailbox: The mailbox being migrated. - Status: The current status of the job. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,6 +82,31 @@ This example returns duplicate public folder migration requests (requests create ## PARAMETERS +### -Identity +The Identity parameter specifies the public folder mailbox migration request that you want to view. The value uses the syntax: `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). + +You can't use this parameter with the following parameters: + +- BatchName +- HighPriority +- Name +- RequestQueue +- Suspend +- Status + +```yaml +Type: PublicFolderMailboxMigrationRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -BatchName The BatchName parameter filters the results by the friendly BatchName value that was assigned when the batch job was created. The format of this value is: `MigrationService:`. @@ -141,31 +166,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the public folder mailbox migration request that you want to view. The value uses the syntax: `\PublicFolderMailboxMigration` (for example, `\PublicFolderMailboxMigrationac6d9eb4-ee49-405f-b90d-04e9a258bd7e`). - -You can't use this parameter with the following parameters: - -- BatchName -- HighPriority -- Name -- RequestQueue -- Suspend -- Status - -```yaml -Type: PublicFolderMailboxMigrationRequestIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Name The Name parameter specifies the name of the public folder mailbox migration request. If the name was not specified at creation, the default value is `PublicFolderMailboxMigration` (for example, `PublicFolderMailboxMigration2ffdef13-01b9-4586-af2b-d5a5482010a8`). @@ -276,12 +276,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md index 2fc1e8ed44..cb164285ad 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMailboxMigrationRequestStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermailboxmigrationrequeststatistics applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderMailboxMigrationRequestStatistics schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolderMailboxMigrationRequestStatistics cmdlet to view the detailed status of individual jobs in a public folder migration batch created using New-MigrationBatch cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,6 +36,7 @@ Get-MailboxRestoreRequestStatistics [-Identity] [-DiagnosticInfo ] [-IncludeReport] + [-IncludeSkippedItems] [-ReportOnly] [] ``` @@ -60,7 +61,7 @@ The Get-PublicFolderMailboxMigrationRequestStatistics cmdlet displays the follow - TargetMailbox: The mailbox being migrated. - PercentComplete: The percentage of job completion. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,7 +121,9 @@ Accept wildcard characters: False ### -Diagnostic This parameter is available only in on-premises Exchange. -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -190,7 +193,7 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -205,6 +208,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeSkippedItems +This parameter is available only in the cloud-based service. + +{{ Fill IncludeSkippedItems Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: IdentityCloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ReportOnly The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch. @@ -246,12 +267,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md index 201bdb1e7b..c001744a6d 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMigrationRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermigrationrequest +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-PublicFolderMigrationRequest schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Get-PublicFolderMigrationRequest cmdlet to view information about serial **Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ Get-PublicFolderMigrationRequest [[-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -113,7 +113,9 @@ Accept wildcard characters: False ``` ### -Diagnostic -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -161,7 +163,7 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -215,12 +217,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md index 099dae89c4..5d234a047b 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermoverequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermoverequest +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderMoveRequest schema: 2.0.0 author: chrisda @@ -12,31 +12,30 @@ ms.reviewer: # Get-PublicFolderMoveRequest ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Get-PublicFolderMoveRequest cmdlet to view the detailed status of an ongoing public folder move that was initiated using the New-PublicFolderMoveRequest cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### Filtering +### Identity ``` -Get-PublicFolderMoveRequest [-BatchName ] +Get-PublicFolderMoveRequest [[-Identity] ] + [-AccountPartition ] [-DomainController ] - [-HighPriority ] - [-Name ] - [-RequestQueue ] + [-Organization ] [-ResultSize ] - [-Status ] - [-Suspend ] [] ``` -### Identity +### Filtering ``` -Get-PublicFolderMoveRequest [[-Identity] ] +Get-PublicFolderMoveRequest [-BatchName ] [-HighPriority ] [-Name ] [-RequestQueue ] [-Status ] [-Suspend ] + [-AccountPartition ] [-DomainController ] + [-Organization ] [-ResultSize ] [] ``` @@ -44,7 +43,7 @@ Get-PublicFolderMoveRequest [[-Identity] ] ## DESCRIPTION Public folder move requests are used to move public folders between public folder mailboxes. After the move request is complete, you need to update the hierarchy using the Update-PublicFolderMailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +63,49 @@ This example returns the status of in-progress and queued requests that are on t ## PARAMETERS +### -Identity +The Identity parameter specifies the identity of the public folder move request. The default identity assigned to public folder move requests is \\PublicFolderMove. + +You can't use this parameter with the following parameters: + +- BatchName +- HighPriority +- Name +- RequestQueue +- Suspend +- Status + +```yaml +Type: PublicFolderMoveRequestIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -AccountPartition +This parameter is available only in the cloud-based service. + +{{ Fill AccountPartition Description }} + +```yaml +Type: AccountPartitionIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BatchName The BatchName parameter specifies the name that was given to a batch public folder move request. @@ -73,7 +115,7 @@ You can't use this parameter with the Identity parameter. Type: String Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -83,13 +125,15 @@ Accept wildcard characters: False ``` ### -DomainController +This parameter is functional only in on-premises Exchange. + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -110,7 +154,7 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -119,41 +163,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identity of the public folder move request. The default identity assigned to public folder move requests is \\PublicFolderMove. - -You can't use this parameter with the following parameters: +### -Name +The Name parameter specifies the name of the public folder move request. If you didn't specify a name when creating the move request, PublicFolderMove will be the default name assigned to the request. -- BatchName -- HighPriority -- Name -- RequestQueue -- Suspend -- Status +You can't use this parameter with the Identity parameter. ```yaml -Type: PublicFolderMoveRequestIdParameter -Parameter Sets: Identity +Type: String +Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the name of the public folder move request. If you didn't specify a name when creating the move request, PublicFolderMove will be the default name assigned to the request. +### -Organization +This parameter is available only in the cloud-based service. -You can't use this parameter with the Identity parameter. +{{ Fill Organization Description }} ```yaml -Type: String -Parameter Sets: Filtering +Type: OrganizationIdParameter +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Online Required: False Position: Named @@ -175,7 +212,7 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -191,7 +228,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -220,7 +257,7 @@ You can't use this parameter with the Identity parameter. Type: RequestStatus Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -238,7 +275,7 @@ You can't use this parameter with the Identity parameter. Type: Boolean Parameter Sets: Filtering Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -252,12 +289,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md index dd8f1ef815..475fc29578 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderMoveRequestStatistics.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfoldermoverequeststatistics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfoldermoverequeststatistics +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderMoveRequestStatistics schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-PublicFolderMoveRequestStatistics ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Get-PublicFolderMoveRequestStatistics cmdlet to view detailed information about public folder move requests. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,26 +25,29 @@ For information about the parameter sets in the Syntax section below, see [Excha Get-PublicFolderMoveRequestStatistics [-Identity] [-Diagnostic] [-DiagnosticArgument ] + [-DiagnosticInfo ] [-DomainController ] [-IncludeReport] + [-IncludeSkippedItems] [-ReportOnly] [] ``` ### MigrationRequestQueue ``` -Get-PublicFolderMoveRequestStatistics -RequestQueue - [-RequestGuid ] +Get-PublicFolderMoveRequestStatistics -RequestQueue [-RequestGuid ] [-Diagnostic] [-DiagnosticArgument ] + [-DiagnosticInfo ] [-DomainController ] [-IncludeReport] + [-IncludeSkippedItems] [-ReportOnly] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,7 +76,7 @@ This parameter can't be used with the RequestQueue parameter. Type: PublicFolderMoveRequestIdParameter Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -97,7 +100,7 @@ You can't use this parameter with the Identity parameter. Type: DatabaseIdParameter Parameter Sets: MigrationRequestQueue Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -107,7 +110,9 @@ Accept wildcard characters: False ``` ### -Diagnostic -The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. +The Diagnostic switch specifies whether to return extremely detailed information in the results. You don't need to specify a value with this switch. + +Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems. ```yaml Type: SwitchParameter @@ -138,14 +143,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DiagnosticInfo +This parameter is available only in the cloud-based service. + +{{ Fill DiagnosticInfo Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController +This parameter is functional only in on-premises Exchange. + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -155,13 +180,13 @@ Accept wildcard characters: False ``` ### -IncludeReport -The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. +The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -170,20 +195,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestGuid -The RequestGuid parameter specifies the GUID of the public folder move request for which you want to view the request statistics. +### -IncludeSkippedItems +This parameter is available only in the cloud-based service. -This parameter can't be used with the Identity parameter. +{{ Fill IncludeSkippedItems Description }} ```yaml -Type: Guid -Parameter Sets: MigrationRequestQueue +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Online Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -195,7 +220,25 @@ The ReportOnly switch returns the results as an array of report entries (encoded Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestGuid +The RequestGuid parameter specifies the GUID of the public folder move request for which you want to view the request statistics. + +This parameter can't be used with the Identity parameter. + +```yaml +Type: Guid +Parameter Sets: MigrationRequestQueue +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -209,12 +252,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md b/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md index ff8c8c1150..023a6d31c0 100644 --- a/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md +++ b/exchange/exchange-ps/exchange/Get-PublicFolderStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-publicfolderstatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-publicfolderstatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-PublicFolderStatistics schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-PublicFolderStatistics cmdlet to retrieve statistical information about public folders, such as folder size and last logon time. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Get-PublicFolderStatistics [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,39 +43,39 @@ This example retrieves statistics about the public folder Marketing\\2013\\Pamph ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. +### -Identity +The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +You can omit the parameter label so that only the public folder name or GUID is supplied. ```yaml -Type: Fqdn +Type: PublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the GUID or public folder name that represents a specific public folder. You can also include the path using the format \\TopLevelPublicFolder\\PublicFolder. +### -DomainController +This parameter is available only in on-premises Exchange. -You can omit the parameter label so that only the public folder name or GUID is supplied. +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: PublicFolderIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -152,12 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md index da29f50190..7e98a8ee18 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinemessage -applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinemessage +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-QuarantineMessage schema: 2.0.0 author: chrisda @@ -16,26 +16,29 @@ This cmdlet is available only in the cloud-based service. Use the Get-QuarantineMessage cmdlet to view quarantined messages and files in your cloud-based organization. Files are quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Details ``` Get-QuarantineMessage -Identity + [-EntityType ] [-RecipientAddress ] [-SenderAddress ] + [-TeamsConversationTypes ] [] ``` ### Summary ``` -Get-QuarantineMessage [-Direction ] +Get-QuarantineMessage + [-Direction ] [-Domain ] - [-EndExpiresDate ] - [-EndReceivedDate ] + [-EndExpiresDate ] + [-EndReceivedDate ] + [-EntityType ] + [-IncludeMessagesFromBlockedSenderAddress] [-MessageId ] [-MyItems] [-Page ] @@ -44,26 +47,29 @@ Get-QuarantineMessage [-Direction ] [-PolicyTypes ] [-QuarantineTypes ] [-RecipientAddress ] + [-RecipientTag ] + [-ReleaseStatus ] [-Reported ] [-SenderAddress ] - [-StartExpiresDate ] - [-StartReceivedDate ] + [-StartExpiresDate ] + [-StartReceivedDate ] [-Subject ] - [-Type ] + [-TeamsConversationTypes ] + [-Type ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-QuarantineMessage -StartReceivedDate 06/13/2016 -EndReceivedDate 06/15/2016 +Get-QuarantineMessage -StartReceivedDate 06/13/2017 -EndReceivedDate 06/15/2017 ``` -This example returns a summary list of messages quarantined between June 13, 2016 and June 15, 2016. +This example returns a summary list of messages quarantined between June 13, 2017 and June 15, 2017. ### Example 2 ```powershell @@ -104,7 +110,7 @@ When you identify the quarantine message by using this parameter, the RecipientA Type: QuarantineMessageIdentity Parameter Sets: Details Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -114,13 +120,18 @@ Accept wildcard characters: False ``` ### -Direction -The Direction parameter filters the results by incoming or outgoing messages. Valid are Inbound and Outbound. +The Direction parameter filters the results by incoming or outgoing messages. Valid values are: + +- Inbound +- Outbound + +You can specify multiple values separated by commas. ```yaml -Type: QuarantineMessageDirectionEnum +Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageDirectionEnum Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -130,13 +141,13 @@ Accept wildcard characters: False ``` ### -Domain -The Domain parameter filters the results by sender or recipient domain. You can specify multiple domain values separated by commas. +This parameter is reserved for internal Microsoft use. ```yaml Type: String[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -148,15 +159,15 @@ Accept wildcard characters: False ### -EndExpiresDate The EndExpiresDate parameter specifies the latest messages that will automatically be deleted from the quarantine. Use this parameter with the StartExpiresDate parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -168,13 +179,50 @@ Accept wildcard characters: False ### -EndReceivedDate The EndReceivedDate parameter specifies the latest messages to return in the results. Use this parameter with the StartReceivedDate parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMessagesFromBlockedSenderAddress +The IncludeMessagesFromBlockedSenderAddress switch specifies whether to include quarantined messages from blocked senders in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -190,7 +238,7 @@ The MessageId parameter filters the results by the Message-ID header field of th Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -206,7 +254,7 @@ The MyItems switch filters the results by messages where you (the user that's ru Type: SwitchParameter Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -222,7 +270,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -238,7 +286,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -248,13 +296,17 @@ Accept wildcard characters: False ``` ### -PolicyName -{{ Fill PolicyName Description }} +The PolicyName parameter filters the results by the protection policy that quarantined the message (for example, the anti-malware policy). You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -264,13 +316,22 @@ Accept wildcard characters: False ``` ### -PolicyTypes -{{ Fill PolicyTypes Description }} +The PolicyTypes parameter filters the results by the type of protection policy that quarantined the message. Valid values are: + +- AntiMalwarePolicy +- AntiPhishPolicy +- DataLossPreventionRule +- ExchangeTransportRule (mail flow rule) +- HostedContentFilterPolicy (anti-spam policy) +- SafeAttachmentPolicy (Microsoft Defender for Office 365 only) + +You can specify multiple values separated by commas. ```yaml Type: QuarantinePolicyTypeEnum[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -283,8 +344,10 @@ Accept wildcard characters: False The QuarantineTypes parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk +- DataLossPrevention +- FileTypeBlock (common attachments filter in anti-malware policies in EOP) - HighConfPhish -- Malware +- Malware (anti-malware policies in EOP or Safe Attachments policies in Defender for Office 365) - Phish - Spam - SPOMalware (Microsoft Defender for Office 365 only) @@ -294,13 +357,13 @@ You can specify multiple values separated by commas. You don't need to use this parameter with the Type parameter. -For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. +For files quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. ```yaml Type: QuarantineMessageTypeEnum[] Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -316,7 +379,53 @@ The RecipientAddress parameter filters the results by the recipient's email addr Type: String[] Parameter Sets: All Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientTag +The RecipientTag parameter filters the results by the recipient's user tag value (for example, `Priority Account`). For more information about user tags, see [User tags in Defender for Office 365](https://learn.microsoft.com/defender-office-365/user-tags-about). + +You can specify multiple values separated by commas. + +```yaml +Type: String[] +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReleaseStatus +The ReleaseStatus parameter filters the results by the release status of the message. Valid values are: + +- Approved +- Denied +- Error +- NotReleased +- PreparingToRelease +- Released +- Requested + +You can specify multiple values separated by commas. + +**Note**: Messages that were quarantined and released by Microsoft due to a service issue have the SystemReleased property value TRUE. To filter the results by system released messages, run the following command: `Get-QuarantineMessage | where {$_.systemreleased -like "True"}`. + +```yaml +Type: ReleaseStatus[] +Parameter Sets: Summary +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -335,7 +444,7 @@ The Reported parameter filters the results by messages that have already been re Type: Boolean Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -351,7 +460,7 @@ The SenderAddress parameter filters the results by the sender's email address. Y Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -363,15 +472,15 @@ Accept wildcard characters: False ### -StartExpiresDate The StartExpiresDate parameter specifies the earliest messages that will automatically be deleted from the quarantine. Use this parameter with the EndExpiresDate parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". For example, if you specify the StartExpiresDate value of today's date and the EndExpiresDate value of the date three days from today, you will only see messages that will expire from the quarantine in the next three days. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -383,13 +492,15 @@ Accept wildcard characters: False ### -StartReceivedDate The StartReceivedDate parameter specifies the earliest messages to return in the results. Use this parameter with the EndReceivedDate parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +By default, if you don't use the StartReceivedDate and EndReceivedDate parameters, the command will return data for the last 16 days. The maximum value for this parameter is 30 days. If you use a value that's older than 30 days, the value is ignored and only data for the last 30 days is returned. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -405,7 +516,30 @@ The Subject parameter filters the results by the subject field of the message. I Type: String Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsConversationTypes +This parameter is available only in Security & Compliance PowerShell. + +The TeamsConversationTypes parameters filters the results by Microsoft Teams conversation types. Valid values are: + +- Channel +- Chat + +You can specify multiple values separated by commas. + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.TeamsConversationType[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -418,7 +552,9 @@ Accept wildcard characters: False The Type parameter filters the results by what caused the message to be quarantined. Valid values are: - Bulk +- DataLossPrevention - HighConfPhish +- Malware - Phish - Spam - SPOMalware (Microsoft Defender for Office 365 only) @@ -429,10 +565,10 @@ You don't need to use this parameter with the QuarantineTypes parameter. For files protected by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, the detection information can be found in CustomData field in the output. ```yaml -Type: QuarantineMessageTypeEnum +Type: Microsoft.Exchange.Management.FfoQuarantine.QuarantineMessageTypeEnum Parameter Sets: Summary Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -446,12 +582,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md index 34a84720d6..9dac21f945 100644 --- a/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md +++ b/exchange/exchange-ps/exchange/Get-QuarantineMessageHeader.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinemessageheader -applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinemessageheader +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-QuarantineMessageHeader schema: 2.0.0 author: chrisda @@ -16,21 +16,21 @@ This cmdlet is available only in the cloud-based service. Use the Get-QuarantineMessageHeader cmdlet to view the message header of a quarantined message. The command will fail if the specified message is not in quarantine. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-QuarantineMessageHeader -Identity + [-EntityType ] + [-RecipientAddress ] [] ``` ## DESCRIPTION Standard SMTP message header syntax is described in RFC 5322. This cmdlet displays the message header exactly as it appears in the message. Individual header fields are not unfolded. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,6 +44,7 @@ This example displays the message header of the quarantined message that has the ### Example 2 ```powershell $qMessages = Get-QuarantineMessage + Get-QuarantineMessageHeader $qMessages[0].Identity ``` @@ -60,7 +61,7 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -69,17 +70,50 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md new file mode 100644 index 0000000000..93177a8f2a --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-QuarantinePolicy.md @@ -0,0 +1,108 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-quarantinepolicy +applicable: Exchange Online, Exchange Online Protection +title: Get-QuarantinePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-QuarantinePolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-QuarantinePolicy cmdlet to view quarantine policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-QuarantinePolicy [[-Identity] ] + [-QuarantinePolicyType ] + [] +``` + +## DESCRIPTION +Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-QuarantinePolicy | Format-Table Name +``` + +This example returns as summary list of all quarantine policies. + +### Example 2 +```powershell +Get-QuarantinePolicy -Identity NoAccess +``` + +This example returns detailed information about the quarantine policy named NoAccess. + +### Example 3 +```powershell +Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy +``` + +This example returns detailed information about the default quarantine policy named DefaultGlobalTag that controls the global quarantine notification (formerly known as end-user spam notification) settings. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the quarantine policy you want to view. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: QuarantineTagIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -QuarantinePolicyType +The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are: + +- QuarantinePolicy: This is the default value, and returns built-in and custom quarantine policies. +- GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named DefaultGlobalTag. + +```yaml +Type: QuarantinePolicyType +Parameter Sets: (All) +Aliases: +Accepted values: QuarantinePolicy, GlobalQuarantinePolicy +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-Queue.md b/exchange/exchange-ps/exchange/Get-Queue.md index 9c24b62344..1b83dcd4a3 100644 --- a/exchange/exchange-ps/exchange/Get-Queue.md +++ b/exchange/exchange-ps/exchange/Get-Queue.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-queue +online version: https://learn.microsoft.com/powershell/module/exchange/get-queue applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-Queue schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-Queue cmdlet to view configuration information for queues on Mailbox servers or Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,7 +52,7 @@ Get-Queue [-Server ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,7 +87,7 @@ This example lists only the external queues. ## PARAMETERS ### -Identity -The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). +The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity @@ -155,7 +155,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -304,12 +304,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-QueueDigest.md b/exchange/exchange-ps/exchange/Get-QueueDigest.md index 8a01c90ce1..a45a074bd3 100644 --- a/exchange/exchange-ps/exchange/Get-QueueDigest.md +++ b/exchange/exchange-ps/exchange/Get-QueueDigest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-queuedigest +online version: https://learn.microsoft.com/powershell/module/exchange/get-queuedigest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-QueueDigest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Get-QueueDigest cmdlet to view information about message delivery queues across database availability groups (DAGs) Active Directory sites, or Active Directory forests in your organization. -By default, the Get-QueueDigest cmdlet displays delivery queues that contain ten or more messages, and the results are between one and two minutes old. For instructions on how to change these default values, see [Configure Get-QueueDigest](https://docs.microsoft.com/exchange/configure-get-queuedigest-exchange-2013-help). +By default, the Get-QueueDigest cmdlet displays delivery queues that contain ten or more messages, and the results are between one and two minutes old. For instructions on how to change these default values, see [Configure Get-QueueDigest](https://learn.microsoft.com/exchange/configure-get-queuedigest-exchange-2013-help). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -67,7 +67,7 @@ Get-QueueDigest -Site ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -176,7 +176,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -258,12 +258,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RMSTemplate.md b/exchange/exchange-ps/exchange/Get-RMSTemplate.md index 2d358cfd63..e495368203 100644 --- a/exchange/exchange-ps/exchange/Get-RMSTemplate.md +++ b/exchange/exchange-ps/exchange/Get-RMSTemplate.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-rmstemplate -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-rmstemplate +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-RMSTemplate schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-RMSTemplate cmdlet to retrieve the current list of active rights policy templates from the Active Directory Rights Management Services (AD RMS) deployment for the organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Get-RMSTemplate [[-Identity] ] ## DESCRIPTION The Get-RMSTemplate cmdlet doesn't return any active rights policy templates if internal licensing isn't enabled. Use the Get-IRMConfiguration cmdlet to check the InternalLicensingEnabled parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,37 +52,37 @@ This example retrieves the Company Confidential RMS template. ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the name of the RMS template. ```yaml -Type: Fqdn +Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the RMS template. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: RmsTemplateIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -93,7 +93,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -115,7 +115,7 @@ The TrustedPublishingDomain parameter specifies the trusted publishing domain yo Type: RmsTrustedPublishingDomainIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -137,7 +137,7 @@ The Type parameter specifies the type of RMS template. Use one of the following Type: RmsTemplateType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,12 +151,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/Get-RMSTrustedPublishingDomain.md deleted file mode 100644 index cba35e5c93..0000000000 --- a/exchange/exchange-ps/exchange/Get-RMSTrustedPublishingDomain.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-rmstrustedpublishingdomain -applicable: Exchange Online -title: Get-RMSTrustedPublishingDomain -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-RMSTrustedPublishingDomain - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -**Note**: This cmdlet has been deprecated and is no longer used. - -Use the Get-RMSTrustedPublishingDomain cmdlet to view the settings of an existing trusted publishing domain (TPD) in your organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-RMSTrustedPublishingDomain [[-Identity] ] - [-Default] - [] -``` - -## DESCRIPTION -A trusted publishing domain contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. - -## EXAMPLES - -### Example 1 -```powershell -Get-RMSTrustedPublishingDomain | Format-List -``` - -This example lists all the trusted publishing domains that are configured in your organization and shows detailed information for each trusted publishing domain. - -## PARAMETERS - -### -Default -The Default switch filters the results by the default trusted publishing domain. The default trusted publishing domain displays RMS templates and provides rights protection to all new content. There can be only one default trusted publishing domain in an organization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the trusted publishing domain. You can use any value that uniquely identifies the trusted publishing domain, for example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: RmsTrustedPublishingDomainIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -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 - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md b/exchange/exchange-ps/exchange/Get-ReceiveConnector.md index e70040959e..f34ec98584 100644 --- a/exchange/exchange-ps/exchange/Get-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Get-ReceiveConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-receiveconnector +online version: https://learn.microsoft.com/powershell/module/exchange/get-receiveconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ReceiveConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ReceiveConnector cmdlet to view Receive connectors on Mailbox servers and Edge Transport servers. Receive connectors listen for inbound SMTP connections on the Exchange server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Get-ReceiveConnector [-Server ] ## DESCRIPTION You can view Receive connectors on Mailbox servers and Edge Transport servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,24 +57,6 @@ This example displays detailed information for the Receive connector named Recei ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity The Identity parameter specifies the Receive connector that you want to view. You can use any value that uniquely identifies the Receive connector. For example: @@ -98,6 +80,24 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Server The Server parameter filters the results by the specified Mailbox server or Edge Transport server. You can use any value that uniquely identifies the server. For example: @@ -126,12 +126,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-Recipient.md b/exchange/exchange-ps/exchange/Get-Recipient.md index c5974564ef..4b5a71f8b1 100644 --- a/exchange/exchange-ps/exchange/Get-Recipient.md +++ b/exchange/exchange-ps/exchange/Get-Recipient.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-recipient -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-recipient +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-Recipient schema: 2.0.0 author: chrisda @@ -16,11 +16,11 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-Recipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups). -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXORecipient cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXORecipient cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). In cloud environments, to return Microsoft 365 Groups, you need to use the RecipientTypeDetails parameter with the value GroupMailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,6 +42,7 @@ Get-Recipient [-Anr ] [-Capabilities ] [-Database ] [-Properties ] + [-IncludeManagerWithDisplayName] [-IncludeSoftDeletedRecipients] [] ``` @@ -65,6 +66,7 @@ Get-Recipient [[-Identity] ] [-SortBy ] [-Capabilities ] [-Properties ] + [-IncludeManagerWithDisplayName] [-IncludeSoftDeletedRecipients] [] ``` @@ -98,6 +100,7 @@ Get-Recipient [-RecipientPreviewFilter ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeManagerWithDisplayName] [-IncludeSoftDeletedRecipients] [-OrganizationalUnit ] [-Properties ] @@ -113,7 +116,7 @@ Get-Recipient [-RecipientPreviewFilter ] ## DESCRIPTION The Get-Recipient cmdlet may not return all object-specific properties for a recipient. To view the object-specific properties for a recipient, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox, Get-MailUser, or Get-DistributionGroup). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -140,6 +143,29 @@ This example retrieves information about all the mail contacts in your organizat ## PARAMETERS +### -Identity +The Identity parameter specifies the recipient object that you want to view. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +```yaml +Type: RecipientIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -153,7 +179,7 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -174,7 +200,7 @@ The AuthenticationType parameter specifies the recipient by authentication type. Type: AuthenticationType Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -190,7 +216,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -208,7 +234,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: AnrSet, Identity, RecipientPreviewFilterSet Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -222,7 +248,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -278,22 +304,22 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -302,35 +328,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the recipient object that you want to view. You can use any value that uniquely identifies the recipient. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -355,7 +358,25 @@ This parameter is reserved for internal Microsoft use. Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeManagerWithDisplayName +This parameter is available only in the cloud-based service. + +{{ Fill IncludeManagerWithDisplayName Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AnrSet, RecipientPreviewFilterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -369,6 +390,8 @@ The IncludeSoftDeletedRecipients switch specifies whether to include soft delete Soft-deleted recipients are deleted recipients that are still recoverable. +**Note**: Use this switch with the Identity or RecipientTypeDetails parameters to get the SoftDeletedRecipients. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -410,7 +433,7 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -426,7 +449,7 @@ This parameter is reserved for internal Microsoft use. Type: PropertySet Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -438,7 +461,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -456,20 +481,13 @@ Accept wildcard characters: False ``` ### -RecipientPreviewFilter -The RecipientPreviewFilter parameter tests a recipient filter that you would use in a dynamic distribution group, address list, or email address policy. This parameter uses the Opath filter syntax `"Property -ComparisonOperator 'Value'"` (the same syntax as the RecipientFilter parameter). - -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). - -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +The RecipientPreviewFilter parameter tests a recipient filter that you would use in a dynamic distribution group, address list, or email address policy. This parameter uses the LDAP filter syntax. ```yaml Type: String Parameter Sets: RecipientPreviewFilterSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -496,7 +514,7 @@ You can specify multiple values separated by commas. Type: RecipientType[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -511,11 +529,11 @@ The RecipientTypeDetails parameter filters the results by the specified recipien - DiscoveryMailbox - DynamicDistributionGroup - EquipmentMailbox -- GroupMailbox -- GuestMailUser +- GroupMailbox (Exchange 2013 or later and cloud) +- GuestMailUser (Exchange 2016 or later and cloud) - LegacyMailbox - LinkedMailbox -- LinkedRoomMailbox +- LinkedRoomMailbox (Exchange 2013 or later and cloud) - MailContact - MailForestContact - MailNonUniversalGroup @@ -523,17 +541,18 @@ The RecipientTypeDetails parameter filters the results by the specified recipien - MailUniversalSecurityGroup - MailUser - PublicFolder -- PublicFolderMailbox +- PublicFolderMailbox (Exchange 2013 or later and cloud) - RemoteEquipmentMailbox - RemoteRoomMailbox - RemoteSharedMailbox -- RemoteTeamMailbox +- RemoteTeamMailbox (Exchange 2013 or later and cloud) - RemoteUserMailbox - RoomList - RoomMailbox -- SchedulingMailbox +- SchedulingMailbox (Exchange 2016 or later and cloud) - SharedMailbox -- TeamMailbox +- SharedWithMailUser (cloud only) +- TeamMailbox (Exchange 2013 or later and cloud) - UserMailbox You can specify multiple values separated by commas. @@ -544,7 +563,7 @@ The value of the RecipientType parameter affects the values that you can use for Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -560,7 +579,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -589,7 +608,7 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -603,12 +622,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md b/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md index 33d4b5a8c0..76a02ece24 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md +++ b/exchange/exchange-ps/exchange/Get-RecipientFilterConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-recipientfilterconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-RecipientFilterConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-RecipientFilterConfig cmdlet to view the recipient filter configuration information for the Exchange server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-RecipientFilterConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,37 +40,37 @@ This example returns detailed information about the recipient filter configurati ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +This parameter is reserved for internal Microsoft use. ```yaml -Type: Fqdn +Type: OrganizationIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -This parameter is reserved for internal Microsoft use. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: OrganizationIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -79,12 +79,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RecipientPermission.md b/exchange/exchange-ps/exchange/Get-RecipientPermission.md index 51dd85bb61..985fc7ff66 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientPermission.md +++ b/exchange/exchange-ps/exchange/Get-RecipientPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-recipientpermission +online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientpermission applicable: Exchange Online title: Get-RecipientPermission schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in the cloud-based service. Use the Get-RecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization. -**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXORecipientPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: In Exchange Online PowerShell, we recommend that you use the Get-EXORecipientPermission cmdlet instead of this cmdlet. For more information, see [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,10 @@ Get-RecipientPermission [[-Identity] ] ## DESCRIPTION When a user is given SendAs permission to another user or group, the user can send messages that appear to come from the other user or group. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!NOTE] +> This cmdlet doesn't return expected results when the recipient specified by the Trustee parameter has multiple `SecurityPrincipalIdParameter` (Sid) values. When you use the Trustee parameter, the command compares the Sid of the specified Trustee with the recipient's access control list (ACL) record. If some of the recipient's Sid values have changed, there's a mismatch. The workaround is to not to use the user principal name (UPN) value, to use all Sids including the one for history. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,7 +105,7 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. +The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -171,12 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md b/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md index 0a48c4e8df..8f2d888cba 100644 --- a/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md +++ b/exchange/exchange-ps/exchange/Get-RecipientStatisticsReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-recipientstatisticsreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-recipientstatisticsreport applicable: Exchange Online title: Get-RecipientStatisticsReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-RecipientStatisticsReport cmdlet to view the recipient statistics report. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +27,7 @@ Get-RecipientStatisticsReport [] ## DESCRIPTION The recipient statistics report provides information about the total number of mailboxes and the total number of active mailboxes in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,12 +45,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md index 0cfc1f0ae4..4f413a8bf3 100644 --- a/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/exchange/Get-RecordReviewNotificationTemplateConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-recordreviewnotificationtemplateconfig -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-recordreviewnotificationtemplateconfig +applicable: Security & Compliance title: Get-RecordReviewNotificationTemplateConfig schema: 2.0.0 author: chrisda @@ -9,8 +9,6 @@ ms.author: chrisda ms.reviewer: --- - - # Get-RecordReviewNotificationTemplateConfig ## SYNOPSIS @@ -18,18 +16,16 @@ This cmdlet is available only in the cloud-based service. Use the Get-RecordReviewNotificationTemplateConfig cmdlet to view the record review notification and reminder settings. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-RecordReviewNotificationTemplateConfig [-DomainController ] [] +Get-RecordReviewNotificationTemplateConfig [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -42,33 +38,13 @@ This example shows detailed information about the record review notification tem ## PARAMETERS -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RecoverableItems.md b/exchange/exchange-ps/exchange/Get-RecoverableItems.md index f82a2a0d5f..aebb11746e 100644 --- a/exchange/exchange-ps/exchange/Get-RecoverableItems.md +++ b/exchange/exchange-ps/exchange/Get-RecoverableItems.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Get-RecoverableItems +online version: https://learn.microsoft.com/powershell/module/exchange/get-recoverableitems applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-RecoverableItems schema: 2.0.0 @@ -15,9 +15,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-RecoverableItems items cmdlet to view deleted items in mailboxes. After you find the deleted items, you use the Restore-RecoverableItems cmdlet to restore them. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,14 +44,16 @@ Get-RecoverableItems -Identity [-FilterStartTime ] [-LastParentFolderID ] [-MaxParallelSize ] + [-PolicyTag ] [-ResultSize ] + [-SkipCount ] [-SourceFolder ] [-SubjectContains ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -134,7 +136,7 @@ Accept wildcard characters: False ### -FilterEndTime The FilterEndTime specifies the end date/time of the date range. This parameter uses the LastModifiedTime value of the item. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -174,7 +176,7 @@ Accept wildcard characters: False ### -FilterStartTime The FilterStartTime specifies the start date/time of the date range. This parameter uses the LastModifiedTime value of the item. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -225,6 +227,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyTag +This parameter is available only in the cloud-based service. + +{{ Fill PolicyTag Description }} + +```yaml +Type: String[] +Parameter Sets: Cloud +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResultSize The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -241,6 +261,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SourceFolder The SourceFolder parameter specifies where to search for deleted items in the mailbox. Valid values are: @@ -248,13 +286,14 @@ The SourceFolder parameter specifies where to search for deleted items in the ma - RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). - PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). -If you don't use this parameter, the command will search all of these folders. +If you don't use this parameter, the command searches those three folders. + +- DiscoveryHoldsItems (cloud-only): The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. To search for deleted items in this folder, use this parameter with the value DiscoveryHoldsItems. ```yaml Type: RecoverableItemsFolderType Parameter Sets: (All) Aliases: -Accepted values: DeletedItems | RecoverableItems | PurgedItems Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False @@ -285,12 +324,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md b/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md index 3d550629d9..69ceb96099 100644 --- a/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md +++ b/exchange/exchange-ps/exchange/Get-RegulatoryComplianceUI.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-regulatorycomplianceui -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-regulatorycomplianceui +applicable: Security & Compliance title: Get-RegulatoryComplianceUI schema: 2.0.0 --- @@ -9,12 +9,12 @@ schema: 2.0.0 # Get-RegulatoryComplianceUI ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell) +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell) . -Use the Get-RegulatoryComplianceUI cmdlet to view the status of the regulatory compliance UI in the Microsoft 365 compliance center (whether the preservation lock checkbox is displayed for retention policies and the immutable label checkbox is displayed for retention labels). +Use the Get-RegulatoryComplianceUI cmdlet to view the status of the regulatory compliance UI in the Microsoft Purview compliance portal (whether the preservation lock checkbox is displayed for retention policies and the immutable label checkbox is displayed for retention labels). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,7 +23,7 @@ Get-RegulatoryComplianceUI [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -41,12 +41,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RemoteDomain.md b/exchange/exchange-ps/exchange/Get-RemoteDomain.md index 6b581bece8..ea01811a75 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Get-RemoteDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-remotedomain +online version: https://learn.microsoft.com/powershell/module/exchange/get-remotedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-RemoteDomain schema: 2.0.0 @@ -16,18 +16,19 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-RemoteDomain cmdlet to view the configuration information for the remote domains configured in your organization. You can view the remote domain configuration from inside the Exchange organization or from an Edge Transport server in the perimeter network. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-RemoteDomain [[-Identity] ] [-DomainController ] + [-ResultSize ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,6 +55,26 @@ This example returns all domains where Transport Neutral Encapsulation Format (T ## PARAMETERS +### -Identity +The Identity parameter specifies the remote domain that you want to view. You can use any value that uniquely identifies the remote domain. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: RemoteDomainIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -DomainController This parameter is available only in on-premises Exchange. @@ -74,23 +95,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the remote domain that you want to view. You can use any value that uniquely identifies the remote domain. For example: +### -ResultSize +This parameter is available only in the cloud-based service. -- Name -- Distinguished name (DN) -- GUID +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. ```yaml -Type: RemoteDomainIdParameter +Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -99,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md b/exchange/exchange-ps/exchange/Get-RemoteMailbox.md index 4946b3478b..f40415ec08 100644 --- a/exchange/exchange-ps/exchange/Get-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Get-RemoteMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-remotemailbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-RemoteMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-RemoteMailbox cmdlet to retrieve the mail-related attributes of users in the on-premises organization that have associated mailboxes in the cloud-based service. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,9 +49,9 @@ Get-RemoteMailbox [[-Identity] ] ``` ## DESCRIPTION -The Get-RemoteMailbox cmdlet retrieves the mail-related attributes of a mail user in the on-premises Active Directory. It doesn't retrieve the attributes of the associated cloud-based mailbox. Most of the mail-related attributes of the on-premises mail user and the associated cloud-based mailbox should be the same. However, the cloud-based mailbox has additional attributes that you can't view by using this cmdlet. To view the attributes of the cloud-based mailbox, you need to use the Exchange admin center in the cloud-based service, or use remote PowerShell to connect to your cloud-based organization and run the Get-Mailbox cmdlet. +The Get-RemoteMailbox cmdlet retrieves the mail-related attributes of a mail user in the on-premises Active Directory. It doesn't retrieve the attributes of the associated cloud-based mailbox. Most of the mail-related attributes of the on-premises mail user and the associated cloud-based mailbox should be the same. However, the cloud-based mailbox has additional attributes that you can't view by using this cmdlet. To view the attributes of the cloud-based mailbox, you need to use the Exchange admin center in the cloud-based service, or connect to your cloud-based organization and run the Get-Mailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,6 +72,7 @@ This example returns a detailed information for the remote mailbox for the user ### Example 3 ```powershell $Credentials = Get-Credential + Get-RemoteMailbox -Credential $Credentials ``` @@ -81,6 +82,33 @@ First, run the following command to prompt you for your credentials and then sto ## PARAMETERS +### -Identity +The Identity parameter specifies the remote mailbox that you want to view. You can use any value that uniquely identifies the remote mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: RemoteMailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -122,7 +150,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -154,16 +182,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -178,37 +206,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the remote mailbox that you want to view. You can use any value that uniquely identifies the remote mailbox. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -```yaml -Type: RemoteMailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -250,7 +251,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -270,6 +273,8 @@ Accept wildcard characters: False ### -ResultSize The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. +**Note**: Limitations on domain controllers might affect the number of results returned for the value unlimited. For more information, see [this article](https://learn.microsoft.com/troubleshoot/windows-server/identity/domain-controller-returns-500-values-ldap-response). + ```yaml Type: Unlimited Parameter Sets: (All) @@ -312,12 +317,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md b/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md index d4bb28adbc..134a709559 100644 --- a/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md +++ b/exchange/exchange-ps/exchange/Get-ReportExecutionInstance.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-reportexecutioninstance +online version: https://learn.microsoft.com/powershell/module/exchange/get-reportexecutioninstance applicable: Exchange Online, Exchange Online Protection title: Get-ReportExecutionInstance schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-ReportExecutionInstance cmdlet to review the report execution instance in Exchange Online. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +27,7 @@ Get-ReportExecutionInstance [-Identity ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,12 +84,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md new file mode 100644 index 0000000000..483f073460 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReportSubmissionPolicy.md @@ -0,0 +1,70 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-reportsubmissionpolicy +applicable: Exchange Online +title: Get-ReportSubmissionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReportSubmissionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ReportSubmissionPolicy cmdlet to view the report submission policy in your cloud-based organization. The report submission policy controls most of the user reported message settings in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ReportSubmissionPolicy [[-Identity] ] [] +``` + +## DESCRIPTION +The report submission policy controls most of the settings for user submissions in the Microsoft Defender portal at . + +The report submission rule (\*-ReportSubmissionRule cmdlets) controls the email address of the reporting mailbox where user reported messages are delivered. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ReportSubmissionPolicy +``` + +This example returns the settings of the report submission policy in your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission policy that you want to view. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md new file mode 100644 index 0000000000..f64f8d899b --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReportSubmissionRule.md @@ -0,0 +1,88 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-reportsubmissionrule +applicable: Exchange Online +title: Get-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ReportSubmissionRule cmdlet to view the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ReportSubmissionRule [[-Identity] ] [-State ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ReportSubmissionRule +``` + +This example returns detailed information about the report submission rule in your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to view. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by whether the report submission rule is enabled or disabled. Valid values are: + +- Disabled +- Enabled + +Remember, there's only one rule in your organization. + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-ResourceConfig.md b/exchange/exchange-ps/exchange/Get-ResourceConfig.md index feadc494c5..e5087116d5 100644 --- a/exchange/exchange-ps/exchange/Get-ResourceConfig.md +++ b/exchange/exchange-ps/exchange/Get-ResourceConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-resourceconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-resourceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-ResourceConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-ResourceConfig cmdlet to view custom room and equipment mailbox properties that you've configured by using the Set-ResourceConfig cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-ResourceConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,12 +81,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ResubmitRequest.md b/exchange/exchange-ps/exchange/Get-ResubmitRequest.md index 729b4b0e77..e6837d4223 100644 --- a/exchange/exchange-ps/exchange/Get-ResubmitRequest.md +++ b/exchange/exchange-ps/exchange/Get-ResubmitRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-resubmitrequest +online version: https://learn.microsoft.com/powershell/module/exchange/get-resubmitrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ResubmitRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ResubmitRequest cmdlet to view requests to replay redundant copies of messages from Safety Net after a mailbox database recovery. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-ResubmitRequest [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -91,12 +91,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md index 32d1e8fd6b..fbb20052f5 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancepolicy +applicable: Security & Compliance title: Get-RetentionCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,18 +12,21 @@ ms.reviewer: # Get-RetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-RetentionCompliancePolicy to view existing retention policies in the Microsoft 365 compliance center. +Use the Get-RetentionCompliancePolicy to view existing retention policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-RetentionCompliancePolicy [[-Identity] ] [-DistributionDetail] + [-ErrorPolicyOnly] [-ExcludeTeamsPolicy] + [-IncludeTestModeResults] + [-PriorityCleanup] [-RetentionRuleTypes] [-TeamsPolicyOnly] [] @@ -37,7 +40,7 @@ This list describes the properties that are displayed by default. - Enabled: The value True means the policy is enabled. - Mode: The current operating mode of the policy. The possible values are Test (the content is tested, but no rules are enforced), AuditAndNotify (when content matches the conditions specified by the policy, the rule is not enforced, but notification emails are sent) or Enforce (all aspects of the policy are enabled and enforced). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -68,7 +71,7 @@ The Identity parameter specifies the retention policy that you want to view. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -86,7 +89,7 @@ If you don't use this switch, the values of the DistributionStatus and \*Locatio Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,6 +98,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ErrorPolicyOnly +The ErrorPolicyOnly switch specifies whether to show only policies that have distribution errors in the results. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExcludeTeamsPolicy The ExcludeTeamsPolicy switch specifies whether to exclude Teams policies from the results. You don't need to specify a value with this switch. @@ -102,7 +121,41 @@ The ExcludeTeamsPolicy switch specifies whether to exclude Teams policies from t Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTestModeResults +The IncludeTestModeResults switch specifies whether to include the status of test mode in the policy details. You don't need to specify a value with this switch. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -112,15 +165,15 @@ Accept wildcard characters: False ``` ### -RetentionRuleTypes -The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes property in the results. You don't need to specify a value with this switch. +The RetentionRuleTypes switch specifies whether to return the value of the RetentionRuleTypes and HasRules properties in the results. You don't need to specify a value with this switch. -To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, `Get-RetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes`. If you don't use the RetentionRuleTypes switch, the value appears blank. +To see the RetentionRuleTypes property, you need to pipe the command to a formatting cmdlet. For example, `Get-RetentionCompliancePolicy -RetentionRuleTypes | Format-Table -Auto Name,RetentionRuleTypes`. If you don't use the RetentionRuleTypes switch, the values RetentionRuleTypes appears blank and HasRules appears False. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -136,7 +189,7 @@ The TeamsPolicyOnly switch specifies whether to show only Teams policies in the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -150,12 +203,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md index ca79531159..9c1279ce96 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Get-RetentionComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-retentioncompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-retentioncompliancerule +applicable: Security & Compliance title: Get-RetentionComplianceRule schema: 2.0.0 author: chrisda @@ -12,17 +12,18 @@ ms.reviewer: # Get-RetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-RetentionComplianceRule to view retention rules in the Microsoft 365 compliance center. +Use the Get-RetentionComplianceRule to view retention rules in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-RetentionComplianceRule [[-Identity] ] [-Policy ] + [-PriorityCleanup] [] ``` @@ -34,7 +35,7 @@ This list describes the properties that are displayed by default in the summary - Mode: The current operating mode of the rule (for example, Enforce). - Comment: An administrative comment. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -65,7 +66,7 @@ The Identity parameter specifies the retention rule you want to view. You can us Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -87,7 +88,23 @@ You can use this parameter with the Identity parameter in the same command. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -101,12 +118,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RetentionEvent.md b/exchange/exchange-ps/exchange/Get-RetentionEvent.md index 9d8f75072f..c650acf830 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionEvent.md +++ b/exchange/exchange-ps/exchange/Get-RetentionEvent.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-retentionevent -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionevent +applicable: Exchange Online, Security & Compliance title: Get-RetentionEvent schema: 2.0.0 author: chrisda @@ -12,24 +12,23 @@ ms.reviewer: # Get-RetentionEvent ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in the cloud-based service. Use the Get-RetentionEvent cmdlet to view retention events in your organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-RetentionEvent [[-Identity] ] [-AllStatus] + [-DomainController ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,6 +48,22 @@ This example returns detailed information about retention the specified retentio ## PARAMETERS +### -Identity +The Identity parameter specifies the retention event that you want to view. + +```yaml +Type: EwsStoreObjectIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -AllStatus The AllStatus switch specifies whether to include zero count events in the results. You don't need to specify a value with this switch. @@ -65,19 +80,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the retention event that you want to view. +### -DomainController +This parameter is reserved for internal Microsoft use. ```yaml -Type: EwsStoreObjectIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Security & Compliance Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -86,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicy.md b/exchange/exchange-ps/exchange/Get-RetentionPolicy.md index b40bbf15aa..231c381cff 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-RetentionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-retentionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-RetentionPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-RetentionPolicy cmdlet to retrieve the settings for retention policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-RetentionPolicy [[-Identity] ] ## DESCRIPTION A retention policy is associated with a group of retention policy tags that specify retention settings for items in a mailbox. A policy may contain one default policy tag to move items to an archive mailbox, one default policy tag to delete all items, one default policy tag to delete voicemail items and multiple personal tags to move or delete items. A mailbox can have only one retention policy applied to it. The Get-RetentionPolicy cmdlet displays all policy settings associated with the specified policy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,37 +42,37 @@ This example returns all the properties of the retention policy RP Finance. The ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the policy name. ```yaml -Type: Fqdn +Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the policy name. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MailboxPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -81,12 +81,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md index 9cb252fd6d..53ece7d08e 100644 --- a/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/Get-RetentionPolicyTag.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-retentionpolicytag +online version: https://learn.microsoft.com/powershell/module/exchange/get-retentionpolicytag applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-RetentionPolicyTag schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-RetentionPolicyTag cmdlet to retrieve settings for a retention tag. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,7 +48,7 @@ Retention tags are used to apply message retention settings to messages or folde Retention policy tags are applied to default folders such as Inbox and Deleted Items. Personal tags are available to users to tag items and folders. The default policy tag is applied to all items that don't have a tag applied by the user or aren't inherited from the folder they're located in. The Get-RetentionPolicyTag cmdlet displays all the settings for the specified tag. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,42 +82,42 @@ This example returns all retention tags of Inbox and All types and pipes the res ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the name of the tag. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: RetentionPolicyTagIdParameter +Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the tag. +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: RetentionPolicyTagIdParameter -Parameter Sets: Identity +Type: Fqdn +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -IncludeSystemTags -The IncludeSystemTags switch specifies whether to return any system tags. +The IncludeSystemTags switch specifies whether to return any system tags. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -218,12 +218,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ReviewItems.md b/exchange/exchange-ps/exchange/Get-ReviewItems.md new file mode 100644 index 0000000000..b9fa1c3b40 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ReviewItems.md @@ -0,0 +1,172 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-reviewitems +applicable: Exchange Online +title: Get-ReviewItems +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ReviewItems + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ReviewItems to retrieve a list of disposition review items that are either pending review or already disposed for a specific retention label. It can also be used to retrieve a list of disposed items for a specific record label. + +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ReviewItems -TargetLabelId + [-Disposed ] + [-IncludeHeaders ] + [-PagingCookie ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +The `Get-ReviewItems` cmdlet can be used to export a list of pending or disposed items from disposition review. To learn more about disposition review, see [Disposition of content](https://learn.microsoft.com/purview/disposition). + +## EXAMPLES + +### Example 1 + +```powershell +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true + +$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers + +$formattedExportItems +``` + +This example retrieves the first page of items pending disposition for the label with the immutable ID value `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. The results are converted to PSObject types for each item and then output to the screen. + +### Example 2 + +```powershell +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -Disposed $true + +$formattedExportItems = $itemsPendingDisposition.ExportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers + +$formattedExportItems | Select Subject,Location,ReviewAction,Comment,DeletedBy,DeletedDate +``` + +This example retrieves all disposed items for the label with an immutable ID of `a8cbeaac-e7aa-42ed-8dba-54200537c9c9` and selects specific columns to output to the screen. + +### Example 3 + +```powershell +$itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true + +$exportItems = $itemsPendingDisposition.ExportItems + +While (![string]::IsNullOrEmpty($itemsPendingDisposition.PaginationCookie)) +{ + $itemsPendingDisposition = Get-ReviewItems -TargetLabelId a8cbeaac-e7aa-42ed-8dba-54200537c9c9 -IncludeHeaders $true -PagingCookie $itemsPendingDisposition.PaginationCookie + $exportItems += $itemsPendingDisposition.ExportItems +} + +$exportItems | ConvertFrom-Csv -Header $itemsPendingDisposition.Headers | Export-Csv C:\temp\ItemsPendingDisposition.csv -NoTypeInformation +``` + +This example retrieves all items pending disposition for the label with the immutable ID value `a8cbeaac-e7aa-42ed-8dba-54200537c9c9`. If multiple pages of items exist, the command continues until no more pages exist. The results are exported to the specified CSV file. + +**Note**: Although this cmdlet doesn't limit the number of items/pages that can be retrieved, other throttling might occur. To prevent throttling while retrieving a large number of items, we recommended including breaks in your script. You can use the PagingCookie parameter to pick up where the script left off after a break. + +## PARAMETERS + +### -TargetLabelId +The TargetLabelId parameter specifies the label that you want to retrieve review items for. A valid value for this parameter is the immutable ID of the label. + +To get the immutable ID value of a label, replace \ with the name of the label, and then run the following command in Exchange Online PowerShell: `Get-ComplianceTag -Identity "" | select ImmutableId`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disposed +The Disposed parameter specifies whether to return disposed items instead of items pending disposition. Valid values are: + +- $true: Return disposed items. +- $false: Return items pending disposition. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeHeaders +The IncludeHeaders parameter specifies whether headers are returned as a property with the review items. Valid values are: + +- $true: Headers are returned as a property with the review items. This option is useful when converting the output to a PSObject in PowerShell or when exporting to CSV. +- $false: Headers are not returned as a property with the review items. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PagingCookie +The PagingCookie parameter identifies the page to retrieve. This parameter is useful in the following scenarios: + +- To avoid throttling while retrieving a large number of items. +- As a method of starting where the last operation left off. + +The PagingCookie value is returned in the PaginationCookie property each time the cmdlet is successfully run. If the PaginationCookie is blank (null), there are no more items to retrieve. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md index 4cd9bedbd4..20474cb2b2 100644 --- a/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/Get-RoleAssignmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-roleassignmentpolicy +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-RoleAssignmentPolicy schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-RoleAssignmentPolicy cmdlet to view existing management role assignment policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,9 +27,9 @@ Get-RoleAssignmentPolicy [[-Identity] ] ``` ## DESCRIPTION -For more information about assignment policies, see [Understanding management role assignment policies](https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). +For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,7 +47,7 @@ Get-RoleAssignmentPolicy "End User Policy" | Format-List This example returns the details of the specified assignment policy. The output of the Get-RoleAssignmentPolicy cmdlet is piped to the Format-List cmdlet. -For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ### Example 3 ```powershell @@ -58,43 +58,43 @@ This example returns the default assignment policy. The output of the Get-RoleAssignmentPolicy cmdlet is piped to the Where cmdlet. The Where cmdlet filters out all of the policies except the policy that has the IsDefault property set to $True. -For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining and the Format-List cmdlet, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) and [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +The Identity parameter specifies the name of the assignment policy to view. If the name contains spaces, enclose the name in quotation marks ("). ```yaml -Type: Fqdn +Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the assignment policy to view. If the name contains spaces, enclose the name in quotation marks ("). +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: MailboxPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -103,12 +103,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RoleGroup.md b/exchange/exchange-ps/exchange/Get-RoleGroup.md index b9e9bf4a33..7e6cfdc324 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Get-RoleGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-rolegroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-rolegroup +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-RoleGroup schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-RoleGroup cmdlet to retrieve a list of management role groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Get-RoleGroup [[-Identity] ] ``` ## DESCRIPTION -For more information about role groups, see [Understanding management role groups](https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). +For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,7 +77,7 @@ If the Identity parameter isn't specified, all role groups are returned. Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 1 @@ -105,16 +105,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can filter on the following properties: @@ -129,7 +129,7 @@ You can filter on the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -141,7 +141,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -165,7 +167,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -175,15 +177,17 @@ Accept wildcard characters: False ``` ### -ShowPartnerLinked -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. + +This ShowPartnerLinked switch specifies whether to return built-in role groups that are of type PartnerRoleGroup. You don't need to specify a value with this switch. -This ShowPartnerLinked switch specifies whether to return built-in role groups that are of type PartnerRoleGroup. Role groups of this type are used in the cloud-based services to allow partner service providers to manage their customer organizations. These role groups can't be edited and are therefore not shown by default. +This type of role group is used in the cloud-based service to allow partner service providers to manage their customer organizations. These types of role groups can't be edited and are not shown by default. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -206,7 +210,7 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -220,12 +224,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md b/exchange/exchange-ps/exchange/Get-RoleGroupMember.md index bf774a0145..8416becc8f 100644 --- a/exchange/exchange-ps/exchange/Get-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Get-RoleGroupMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-rolegroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-rolegroupmember +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-RoleGroupMember schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-RoleGroupMember cmdlet to retrieve a list of members of a management role group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,9 +29,9 @@ Get-RoleGroupMember [-Identity] ``` ## DESCRIPTION -For more information about role groups, see [Understanding management role groups](https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). +For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +58,7 @@ The Identity parameter specifies the role group for which member information sho Type: RoleGroupMemberIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -88,7 +88,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -112,7 +114,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -126,12 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md index db669203f9..2f0f384197 100644 --- a/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md +++ b/exchange/exchange-ps/exchange/Get-RoutingGroupConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-routinggroupconnector +online version: https://learn.microsoft.com/powershell/module/exchange/get-routinggroupconnector applicable: Exchange Server 2010 title: Get-RoutingGroupConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Get-RoutingGroupConnector cmdlet to view the configuration details of the routing group connectors in a Microsoft Exchange Server 2010 organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-RoutingGroupConnector [[-Identity] ] ## DESCRIPTION The Get-RoutingGroupConnector cmdlet displays the configuration details of routing group connectors that exist when an organization is running Exchange 2010 and Exchange Server 2003. A routing group connector is used to send and receive messages between Exchange 2010 Hub Transport servers and Exchange 2003 bridgehead servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,35 +42,35 @@ This example displays detailed configuration information for the routing group c ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name]\\Routing Group Connector Name. You can use the wildcard character (\*) as part of the administrative group or routing group name. ```yaml -Type: Fqdn +Type: RoutingGroupConnectorIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name or GUID of the routing group connector. The name is expressed as [[Administrative Group Name\\]Routing Group Name]\\Routing Group Connector Name. You can use the wildcard character (\*) as part of the administrative group or routing group name. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: RoutingGroupConnectorIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -79,12 +79,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-RpcClientAccess.md b/exchange/exchange-ps/exchange/Get-RpcClientAccess.md index ff27231f51..adedda699a 100644 --- a/exchange/exchange-ps/exchange/Get-RpcClientAccess.md +++ b/exchange/exchange-ps/exchange/Get-RpcClientAccess.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-rpcclientaccess +online version: https://learn.microsoft.com/powershell/module/exchange/get-rpcclientaccess applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-RpcClientAccess schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-RpcClientAccess cmdlet to view the settings of the Microsoft Exchange RPC Client Access service on Exchange servers that have the Client Access server role installed. These settings affect Outlook clients that connect by using Outlook Anywhere (RPC over HTTP). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-RpcClientAccess [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -91,12 +91,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SCInsights.md b/exchange/exchange-ps/exchange/Get-SCInsights.md index 7ce4d23fe3..7675f4455f 100644 --- a/exchange/exchange-ps/exchange/Get-SCInsights.md +++ b/exchange/exchange-ps/exchange/Get-SCInsights.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-scinsights -applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-scinsights +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-SCInsights schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SCInsights cmdlet to view Microsoft 365 insights information. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +34,7 @@ This cmdlet returns the following output: - InsightSubType: The value All or Archive. - UsersCount: An integer count, or the size in megabytes for the InsightType value. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,13 +60,13 @@ The EndDate parameter specifies the end date of the date range. To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -82,12 +80,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SPOActiveUserReport.md b/exchange/exchange-ps/exchange/Get-SPOActiveUserReport.md deleted file mode 100644 index b608e83b88..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOActiveUserReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-spoactiveuserreport -applicable: Exchange Online -title: Get-SPOActiveUserReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-SPOActiveUserReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-SpoActiveUserReport cmdlet to view statistics about Microsoft SharePoint Online users in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-SPOActiveUserReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-SpoActiveUserReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about SharePoint Online users for November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SPOSkyDriveProDeployedReport.md b/exchange/exchange-ps/exchange/Get-SPOSkyDriveProDeployedReport.md deleted file mode 100644 index e7c7c02a13..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOSkyDriveProDeployedReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-sposkydriveprodeployedreport -applicable: Exchange Online -title: Get-SPOSkyDriveProDeployedReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-SPOSkyDriveProDeployedReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-SPOSkyDriveProDeployedReport cmdlet to view the number of My Site sites in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-SPOSkyDriveProDeployedReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get- SPOSkyDriveProDeployedReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example displays the number of My Sites as of November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SPOSkyDriveProStorageReport.md b/exchange/exchange-ps/exchange/Get-SPOSkyDriveProStorageReport.md deleted file mode 100644 index b92a9769f7..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOSkyDriveProStorageReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-sposkydriveprostoragereport -applicable: Exchange Online -title: Get-SPOSkyDriveProStorageReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-SPOSkyDriveProStorageReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-SPOSkyDriveProStorageReport cmdlet to view statistics about the space taken up (in MB) by My Sites in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-SPOSkyDriveProStorageReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-SPOSkyDriveProStorageReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about the space (in MB) taken up by My Sites for November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SPOTeamSiteDeployedReport.md b/exchange/exchange-ps/exchange/Get-SPOTeamSiteDeployedReport.md deleted file mode 100644 index 6e53ac7672..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOTeamSiteDeployedReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-spoteamsitedeployedreport -applicable: Exchange Online -title: Get-SPOTeamSiteDeployedReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-SPOTeamSiteDeployedReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-SPOTeamSiteDeployedReport cmdlet to view statistics about the number of team sites in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-SPOTeamSiteDeployedReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-SPOTeamSiteDeployedReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about the number of team sites in the month of November, 2015 - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SPOTeamSiteStorageReport.md b/exchange/exchange-ps/exchange/Get-SPOTeamSiteStorageReport.md deleted file mode 100644 index e4b6d250a6..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOTeamSiteStorageReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-spoteamsitestoragereport -applicable: Exchange Online -title: Get-SPOTeamSiteStorageReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-SPOTeamSiteStorageReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-SPOTeamSiteStorageReport cmdlet to view statistics about the space taken up (in MB) by team sites in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-SPOTeamSiteStorageReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-SPOTeamSiteStorageReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about the space taken up (in MB) by team sites for November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SPOTenantStorageMetricReport.md b/exchange/exchange-ps/exchange/Get-SPOTenantStorageMetricReport.md deleted file mode 100644 index 881fe72c8b..0000000000 --- a/exchange/exchange-ps/exchange/Get-SPOTenantStorageMetricReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-spotenantstoragemetricreport -applicable: Exchange Online -title: Get-SPOTenantStorageMetricReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-SPOTenantStorageMetricReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-SPOTenantStorageMetricReport cmdlet to view statistics about the space taken up (in MB) by all sites in for your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-SPOTenantStorageMetricReport [-EndDate ] - [-ReportType ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-SpoActiveUserReport -ReportType Monthly -StartDate 11/01/2015 -EndDate 11/30/2015 -``` - -This example shows information about the space taken up (in MB) by all sites for your cloud-based organization for November, 2015. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -The ReportType parameter aggregates the data in the report by the value you specify. Valid values for this parameter are Daily, Weekly, Monthly and Yearly. Use the value of ReportType with appropriate values for the StartDate and EndDate parameters to review the data from a specific time period. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md index acc7d16dbf..1330056090 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-safeattachmentpolicy +applicable: Exchange Online title: Get-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SafeAttachmentPolicy cmdlet to view safe attachment policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,9 +26,9 @@ Get-SafeAttachmentPolicy [[-Identity] ] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,7 +61,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -77,12 +75,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md index 04047425b2..0dded56904 100644 --- a/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Get-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-safeattachmentrule +applicable: Exchange Online title: Get-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SafeAttachmentRule cmdlet to view safe attachment rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,9 +27,9 @@ Get-SafeAttachmentRule [[-Identity] ] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,7 +62,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -80,7 +78,7 @@ The State parameter filters the results by the state of the rule. Valid values a Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -94,12 +92,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md index 7ff5fec914..27c72f641a 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-safelinksaggregatereport +online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksaggregatereport applicable: Exchange Online title: Get-SafeLinksAggregateReport schema: 2.0.0 @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-SafeLinksAggregateReport cmdlet to return to return general information about Safe Links results for the last 90 days. Yesterday is the most recent date that you can specify. +Use the Get-SafeLinksAggregateReport cmdlet to return general information about Safe Links results for the last 90 days. Yesterday is the most recent date that you can specify. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,12 +37,12 @@ Safe Links is a feature in Microsoft Defender for Office 365 that checks links i For the reporting period you specify, the cmdlet returns the following information: -- Action (Allowed, Blocked, ClickedEventBlocked, and ClickedDuringScan) +- Action - App - MessageCount - RecipientCount -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,8 +60,12 @@ The Action parameter filters the results by action. Valid values are: - Allowed - Blocked -- ClickedEvenBlocked - ClickedDuringScan +- ClickedEvenBlocked +- Scanning +- TenantAllowed +- TenantBlocked +- TenantBlockedAndClickedThrough You can specify multiple values separated by commas. @@ -84,14 +86,8 @@ Accept wildcard characters: False The AppNameList parameter filters the results by the app where the link was found. Valid values are: - Email Client -- Excel -- OneNote -- Others -- Outlook -- PowerPoint +- OfficeDocs - Teams -- Visio -- Word You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -111,7 +107,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. Yesterday is the most recent date that you can specify. You can't specify a date that's older than 90 days. @@ -131,7 +127,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. Yesterday is the most recent date that you can specify. You can't specify a date that's older than 90 days. @@ -149,13 +145,13 @@ Accept wildcard characters: False ``` ### -SummarizeBy -The SummarizeBy parameter returns totals based on the values you specify. Valid values are: +The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of Action or AppNameList on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that specific Action or App on one row in the report. + +For this cmdlet, valid values are: - Action: Only the values specified by the Action parameter are returned. - App: Only the values specified by the AppNameList parameter are returned. -If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of Action or AppNameList on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that specific Action or App on one row in the report. - ```yaml Type: String Parameter Sets: (All) @@ -174,12 +170,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md index 44779442c1..ef6379a4e6 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksDetailReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-safelinksdetailreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksdetailreport applicable: Exchange Online title: Get-SafeLinksDetailReport schema: 2.0.0 @@ -14,16 +14,14 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-SafeLinksDetailReport cmdlet to return to return detailed information about Safe Links results for the last 7 days. Yesterday is the most recent date that you can specify. +Use the Get-SafeLinksDetailReport cmdlet to return detailed information about Safe Links results for the last 7 days. Yesterday is the most recent date that you can specify. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-SafeLinksDetailReport [-Action ] +Get-SafeLinksDetailReport [-Action ] [-AppNameList ] [-Domain ] @@ -43,7 +41,7 @@ Safe Links is a feature in Microsoft Defender for Office 365 that checks links i This cmdlet returns the following information: - ClickTime -- InternalMessageId +- NetworkMessageId - ClientMessageId - SenderAddress - RecipientAddress @@ -57,7 +55,7 @@ This cmdlet returns the following information: - UrlType (currently empty) - Flags (0: Allowed 1: Blocked 2: ClickedEvenBlocked 3: ClickedDuringScan) -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,13 +77,19 @@ This example returns filters the results by the following information: ### -Action The Action parameter filters the results by action. Valid values are: -- Allowed -- Blocked -- ClickedEvenBlocked -- ClickedDuringScan +- Allowed: URL was allowed due to a "Good" verdict. +- Blocked: URL was blocked due to a "Bad" verdict. +- ClickedDuringScan: User skipped verification of the URL and proceeded to the destination URL before Safe Links finished scanning. +- ClickedEvenBlocked: User was blocked at time of click from accessing URL. +- Scanning: URL is being scanned. +- TenantAllowed: URL allow entry in the Tenant Allow/Block List. +- TenantBlocked: URL block entry in the Tenant Allow/Block List. +- TenantBlockedAndClickedThrough: URL was blocked due to a block entry in the Tenant Allow/Block List, and the user clicked through the block page to access the URL. You can specify multiple values separated by commas. +**Note**: Values for this parameter are case sensitive. No data returned for an action implies that the action didn't occur. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -103,14 +107,8 @@ Accept wildcard characters: False The AppNameList parameter filters the results by the app where the link was found. Valid values are: - Email Client -- Excel -- OneNote -- Others -- Outlook -- PowerPoint +- OfficeDocs - Teams -- Visio -- Word You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -148,7 +146,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. Yesterday is the most recent date that you can specify. You can't specify a date that's older than 7 days. @@ -218,7 +216,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. Yesterday is the most recent date that you can specify. You can't specify a date that's older than 7 days. @@ -240,12 +238,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md index 1a2cff1f7b..63a24625de 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinkspolicy +applicable: Exchange Online title: Get-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SafeLinksPolicy cmdlet to view Safe Links policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,23 +28,23 @@ Get-SafeLinksPolicy [[-Identity] ] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-SafeLinksPolicy | Format-Table Name,IsEnabled,IsDefault +Get-SafeLinksPolicy | Format-Table Name,EnableSafe* ``` This example shows a summary list of all Safe Links policies. ### Example 2 ```powershell -Get-SafeLinksPolicy -Identity Default +Get-SafeLinksPolicy -Identity "Contoso All" ``` -This example shows detailed information about the Safe Links policy named Default. +This example shows detailed information about the Safe Links policy named Contoso All. ## PARAMETERS @@ -63,7 +61,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -77,12 +75,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md index b19b3bb653..279ebc68cd 100644 --- a/exchange/exchange-ps/exchange/Get-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Get-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-safelinksrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-safelinksrule +applicable: Exchange Online title: Get-SafeLinksRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SafeLinksRule cmdlet to view Safe Links rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +29,7 @@ Get-SafeLinksRule [[-Identity] ] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,7 +62,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -80,7 +78,7 @@ The State parameter filters the results by the state of the rule. Valid values a Type: RuleState Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -94,12 +92,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md index f1a36deb16..562980e971 100644 --- a/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md +++ b/exchange/exchange-ps/exchange/Get-SearchDocumentFormat.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-searchdocumentformat +online version: https://learn.microsoft.com/powershell/module/exchange/get-searchdocumentformat applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-SearchDocumentFormat schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-SearchDocumentFormat cmdlet to retrieve details of file formats supported by Exchange Search. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-SearchDocumentFormat [[-Identity] ] ## DESCRIPTION Exchange Search includes built-in support for indexing many file formats. Output from the Get-SearchDocumentFormat cmdlet includes details about each supported file format, including whether content indexing is enabled for the file format, the format handler and the file extension (such as .docx). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,12 +95,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md index 34cf1856c1..31c46f8403 100644 --- a/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/exchange/Get-SecOpsOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-secopsoverridepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-secopsoverridepolicy +applicable: Exchange Online title: Get-SecOpsOverridePolicy schema: 2.0.0 author: chrisda @@ -12,20 +12,22 @@ ms.reviewer: # Get-SecOpsOverridePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -Use the Get-SecOpsOverridePolicy cmdlet to view SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). +Use the Get-SecOpsOverridePolicy cmdlet to view SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-SecOpsOverridePolicy [[-Identity] ] [] +Get-SecOpsOverridePolicy [[-Identity] ] + [-DomainController ] + [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,7 +52,7 @@ The Identity parameter specifies the SecOps override policy that you want to mod Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: 0 @@ -59,17 +61,29 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md deleted file mode 100644 index 93034a1756..0000000000 --- a/exchange/exchange-ps/exchange/Get-SecOpsOverrideRule.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-secopsoverriderule -applicable: Security & Compliance Center -title: Get-SecOpsOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-SecOpsOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Get-SecOpsOverrideRule cmdlet to view SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-SecOpsOverrideRule [[-Identity] ] - [-Confirm] - [-Policy ] - [-WhatIf] - [] -``` - -## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -## EXAMPLES - -### Example 1 -```powershell -Get-SecOpsOverrideRule -``` - -This example returns detailed information about the one and only SecOps mailbox override rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the SecOps override rule that you want to view. You can use any value that uniquely identifies the rule. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter filters the results by SecOps mailbox override policy. You can use any value that uniquely identifies the policy. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md b/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md index 66b2c29da0..458dcbe1b3 100644 --- a/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md +++ b/exchange/exchange-ps/exchange/Get-SecurityPrincipal.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-securityprincipal -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-securityprincipal +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-SecurityPrincipal schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-SecurityPrincipal cmdlet to return a list of security principals. Security principals are entities, such as users or security groups, which can be assigned permissions and user rights. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Get-SecurityPrincipal [[-Identity] ] ## DESCRIPTION The Get-SecurityPrincipal cmdlet is used by the Exchange admin center to populate fields that display recipient information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +69,22 @@ This example retrieves well-known security principals and displays only the Name ## PARAMETERS +### -Identity +The Identity parameter specifies the security principal. When the security principal is explicitly specified by using this parameter, no additional security principals are returned. + +```yaml +Type: ExtendedSecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -DomainController This parameter is available only in on-premises Exchange. @@ -88,22 +104,22 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -112,22 +128,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the security principal. When the security principal is explicitly specified by using this parameter, no additional security principals are returned. - -```yaml -Type: ExtendedSecurityPrincipalIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IncludeDomainLocalFrom This parameter is available only in on-premises Exchange. @@ -160,7 +160,7 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: ExtendedOrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -176,7 +176,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -192,7 +192,7 @@ The RoleGroupAssignable switch filters security principals by returning only obj Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -217,7 +217,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -231,12 +231,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SendConnector.md b/exchange/exchange-ps/exchange/Get-SendConnector.md index e0887cf70c..b285afa86f 100644 --- a/exchange/exchange-ps/exchange/Get-SendConnector.md +++ b/exchange/exchange-ps/exchange/Get-SendConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-sendconnector +online version: https://learn.microsoft.com/powershell/module/exchange/get-sendconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SendConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-SendConnector cmdlet to view the settings for a Send connector. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-SendConnector [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,12 +79,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md b/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md index 1407099263..b89a8e9412 100644 --- a/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md +++ b/exchange/exchange-ps/exchange/Get-SenderFilterConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-senderfilterconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-senderfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SenderFilterConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-SenderFilterConfig cmdlet to view the Sender Filter configuration information for the Exchange server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-SenderFilterConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,37 +40,37 @@ This example returns detailed information about the Sender Filter configuration ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +This parameter is reserved for internal Microsoft use. ```yaml -Type: Fqdn +Type: OrganizationIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -This parameter is reserved for internal Microsoft use. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: OrganizationIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -79,12 +79,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SenderIdConfig.md b/exchange/exchange-ps/exchange/Get-SenderIdConfig.md index 83a62c4020..1e0dad4cd1 100644 --- a/exchange/exchange-ps/exchange/Get-SenderIdConfig.md +++ b/exchange/exchange-ps/exchange/Get-SenderIdConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-senderidconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-senderidconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SenderIdConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-SenderIdConfig cmdlet to view the Sender ID configuration information for the Exchange server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-SenderIdConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,12 +62,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md b/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md index 47e227582f..83288be5e1 100644 --- a/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md +++ b/exchange/exchange-ps/exchange/Get-SenderReputationConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-senderreputationconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-senderreputationconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SenderReputationConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-SenderReputationConfig cmdlet to view the configuration information for sender reputation on the computer on which the command is run. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-SenderReputationConfig [-DomainController ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,12 +62,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ServerComponentState.md b/exchange/exchange-ps/exchange/Get-ServerComponentState.md index 2b5502c30f..2008d37985 100644 --- a/exchange/exchange-ps/exchange/Get-ServerComponentState.md +++ b/exchange/exchange-ps/exchange/Get-ServerComponentState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-servercomponentstate +online version: https://learn.microsoft.com/powershell/module/exchange/get-servercomponentstate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ServerComponentState schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ServerComponentState cmdlet to retrieve configuration settings for Microsoft Exchange components and endpoints. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-ServerComponentState [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -107,12 +107,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ServerHealth.md b/exchange/exchange-ps/exchange/Get-ServerHealth.md index 8e83a1e62f..329cfe409b 100644 --- a/exchange/exchange-ps/exchange/Get-ServerHealth.md +++ b/exchange/exchange-ps/exchange/Get-ServerHealth.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-serverhealth +online version: https://learn.microsoft.com/powershell/module/exchange/get-serverhealth applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ServerHealth schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ServerHealth cmdlet to return health information related to the server you specify. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,9 +28,9 @@ Get-ServerHealth [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -The cmdlet returns health values that you can use to determine the state of the server. See [Server health and performance in Exchange Server](https://docs.microsoft.com/Exchange/server-health/server-health) for related information. +The cmdlet returns health values that you can use to determine the state of the server. See [Server health and performance in Exchange Server](https://learn.microsoft.com/Exchange/server-health/server-health) for related information. The cmdlet also returns an alert value that provides the specific state of your server. The following values may be returned: @@ -74,7 +74,7 @@ Accept wildcard characters: False ``` ### -HaImpactingOnly -The HaImpactingOnly switch specifies whether the cmdlet must roll up only the monitors that have HaImpacting set to True. +The HaImpactingOnly switch specifies whether the cmdlet must roll up only the monitors that have HaImpacting set to True. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -110,12 +110,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md index 4f90f243e3..2986dafdb9 100644 --- a/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Get-ServerMonitoringOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-servermonitoringoverride +online version: https://learn.microsoft.com/powershell/module/exchange/get-servermonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ServerMonitoringOverride schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ServerMonitoringOverride cmdlet to return all overrides created on the specified server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-ServerMonitoringOverride -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,12 +67,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md b/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md index 44f17c3956..842dc2fa11 100644 --- a/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md +++ b/exchange/exchange-ps/exchange/Get-ServiceDeliveryReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-servicedeliveryreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-servicedeliveryreport applicable: Exchange Online, Exchange Online Protection title: Get-ServiceDeliveryReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-ServiceDeliveryReport cmdlet to view information about the message delivery path for a specified recipient. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +27,7 @@ Get-ServiceDeliveryReport [-ProbeTag ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,12 +77,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ServicePrincipal.md b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md new file mode 100644 index 0000000000..ee06d9d363 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-ServicePrincipal.md @@ -0,0 +1,101 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-serviceprincipal +applicable: Exchange Online, Security & Compliance, Exchange Online Protection +title: Get-ServicePrincipal +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-ServicePrincipal + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-ServicePrincipal cmdlet to view information about service principals in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-ServicePrincipal [[-Identity] ] + [-Organization ] + [] +``` + +## DESCRIPTION +Service principals exist in Microsoft Entra ID to define what apps can do, who can access the apps, and what resources the apps can access. In Exchange Online, service principals are references to the service principals in Microsoft Entra ID. To assign Exchange Online role-based access control (RBAC) roles to service principals in Microsoft Entra ID, you use the service principal references in Exchange Online. The **\*-ServicePrincipal** cmdlets in Exchange Online PowerShell let you view, create, and remove these service principal references. + +For more information, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ServicePrincipal +``` + +This example returns a summary list of all service principals within an organization. + +### Example 2 +```powershell +Get-ServicePrincipal -Identity ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1 | Format-List +``` + +This example returns detailed information about the service principal with the ObjectId value ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to view. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ObjectId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SettingOverride.md b/exchange/exchange-ps/exchange/Get-SettingOverride.md index 03df59de94..dec2d72019 100644 --- a/exchange/exchange-ps/exchange/Get-SettingOverride.md +++ b/exchange/exchange-ps/exchange/Get-SettingOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-settingoverride +online version: https://learn.microsoft.com/powershell/module/exchange/get-settingoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SettingOverride schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-SettingOverride cmdlet to view existing setting overrides that store Exchange customizations in Active Directory instead of in text files on the server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Get-SettingOverride [[-Identity] ] ## DESCRIPTION Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-specific, and they persist in Active Directory across Exchange Cumulative Updates (CUs). Exchange customizations in web.config or exe.config XML application configuration files are server-specific, and are lost when you install the next Exchange CU. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,39 +51,39 @@ This example displays a detailed information for the setting override object nam ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the setting override that you want to view. You can use any value that uniquely identifies the override. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: Fqdn +Type: SettingOverrideIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the setting override that you want to view. You can use any value that uniquely identifies the override. For example: - -- Name -- Distinguished name (DN) -- GUID +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: SettingOverrideIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -92,12 +92,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SharingPolicy.md b/exchange/exchange-ps/exchange/Get-SharingPolicy.md index 9dd7b69a37..a9e5d5b87f 100644 --- a/exchange/exchange-ps/exchange/Get-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SharingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-sharingpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-sharingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-SharingPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-SharingPolicy cmdlet to view existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-SharingPolicy [[-Identity] ] ## DESCRIPTION Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing settings for the mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,49 +42,49 @@ This example retrieves the default information for the sharing policy FourthCoff ### Example 2 ```powershell -Get-SharingPolicy Fabrikam | Format List +Get-SharingPolicy Fabrikam | Format-List ``` This example retrieves the full information for the sharing policy Fabrikam. ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. +### -Identity +The Identity parameter specifies the sharing policy that you want to view. You can use one of the following values: -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +- ADObjectID +- Distinguished name (DN) +- Legacy DN +- GUID ```yaml -Type: Fqdn +Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the sharing policy that you want to view. You can use one of the following values: +### -DomainController +This parameter is available only in on-premises Exchange. -- ADObjectID -- Distinguished name (DN) -- Legacy DN -- GUID +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: SharingPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -93,12 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SiteMailbox.md b/exchange/exchange-ps/exchange/Get-SiteMailbox.md index c84d14563c..a35a4f6e0c 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailbox.md +++ b/exchange/exchange-ps/exchange/Get-SiteMailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailbox +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SiteMailbox schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Get-SiteMailbox ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. Use the Get-SiteMailbox cmdlet to view information about site mailboxes. This cmdlet is primarily used by Microsoft SharePoint and Exchange to display information to users in the user interface. However, you may find it helpful for discovering information such as the site mailbox's owners, members, and lifecycle status. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Get-SiteMailbox [[-Identity] ] ## DESCRIPTION If you aren't a member or owner of the site mailbox that you want to view the diagnostics information for, you must use the BypassOwnerCheck parameter when running this cmdlet. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,7 +77,7 @@ The Identity parameter specifies the identity of the site mailbox. You can use a Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -99,7 +99,7 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -111,13 +111,13 @@ Accept wildcard characters: False ### -BypassOwnerCheck The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. -If you run the command without this parameter, and you aren't a member or owner of the site mailbox, then the command will fail. +If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -127,8 +127,6 @@ Accept wildcard characters: False ``` ### -DeletedSiteMailbox -This parameter is available only in on-premises Exchange. - The DeletedSiteMailbox switch returns site mailboxes that have been marked for pending deletion. You don't need to specify a value with this switch. When the lifecycle application in SharePoint closes a site mailbox, the site mailbox is retained for the period specified in the lifecycle policy in the closed state. The mailbox can then be reactivated by an end user or by a SharePoint administrator. After the retention period, the Exchange site mailbox that's housed in the mailbox database will have its name prepended with MDEL: to indicate that it has been marked for deletion. To free storage space and the alias, use the Remove-Mailbox cmdlet to manually remove these site mailboxes from the mailbox database. @@ -147,8 +145,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -165,9 +161,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -This parameter is available or functional only in on-premises Exchange. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -175,7 +171,7 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -191,7 +187,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -205,12 +201,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md b/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md index 358e98a561..a79fefc2f8 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md +++ b/exchange/exchange-ps/exchange/Get-SiteMailboxDiagnostics.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-sitemailboxdiagnostics -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailboxdiagnostics +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SiteMailboxDiagnostics schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Get-SiteMailboxDiagnostics ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. Use the Get-SiteMailboxDiagnostics cmdlet to view important event-related data for each site mailbox. This information can be used to troubleshoot site mailbox issues. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Get-SiteMailboxDiagnostics [-Identity] ## DESCRIPTION If you aren't a member or owner of the site mailbox that you want to view the diagnostics information for, you must use the BypassOwnerCheck parameter when running this cmdlet. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,7 +68,7 @@ The Identity parameter specifies the site mailbox that you want to view. You can Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -80,13 +80,13 @@ Accept wildcard characters: False ### -BypassOwnerCheck The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. -If you run the command without this parameter and you aren't a member or owner of the site mailbox, then the command will fail. +If you don't use this switch and you aren't a member or owner of the site mailbox, the command will fail. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -105,7 +105,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -121,7 +121,7 @@ The SendMeEmail switch specifies that the diagnostic information is sent to the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,7 +137,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,12 +151,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md index 8e1aad51fe..1e107e4c93 100644 --- a/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/exchange/Get-SiteMailboxProvisioningPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-sitemailboxprovisioningpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-sitemailboxprovisioningpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SiteMailboxProvisioningPolicy schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Get-SiteMailboxProvisioningPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. Use the Get-SiteMailboxProvisioningPolicy cmdlet to view site mailbox provisioning policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Get-SiteMailboxProvisioningPolicy [[-Identity] ] ## DESCRIPTION Site mailboxes allow access to both Microsoft SharePoint documents and Exchange email using the same client interface. Site mailbox provisioning policies apply settings to new site mailboxes that you create. You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. The default site mailbox provisioning policy is named Default. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,7 +62,7 @@ The Identity parameter specifies the site mailbox provisioning policy that you w Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -72,8 +72,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -94,12 +92,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SmimeConfig.md b/exchange/exchange-ps/exchange/Get-SmimeConfig.md index aba96133db..94acefe7bf 100644 --- a/exchange/exchange-ps/exchange/Get-SmimeConfig.md +++ b/exchange/exchange-ps/exchange/Get-SmimeConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-smimeconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-smimeconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-SmimeConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-SmimeConfig cmdlet to view the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-SmimeConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,12 +60,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md b/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md new file mode 100644 index 0000000000..2bc72a8f55 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-SmtpDaneInboundStatus.md @@ -0,0 +1,68 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-smtpdaneinboundstatus +applicable: Exchange Online +title: Get-SmtpDaneInboundStatus +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-SmtpDaneInboundStatus + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-SmtpDaneInboundStatus cmdlet to view information about SMTP DNS-based Authentication of Named Entities (DANE) for inbound mail to accepted domains in Exchange Online. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-SmtpDaneInboundStatus [-DomainName] [] +``` + +## DESCRIPTION +For more information about debugging, enabling, and disabling SMTP DANE with DNSSEC, see [How SMTP DANE works](https://learn.microsoft.com/purview/how-smtp-dane-works). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-SmtpDaneInboundStatus -DomainName contoso.com +``` + +This example checks the DANE status for the accepted domain contoso.com. + +## PARAMETERS + +### -DomainName +The DomainName parameter specifies the accepted domain in the Exchange Online organization where you want to view information about DANE (for example, contoso.com). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md b/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md index 2349517cde..01335195b4 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md +++ b/exchange/exchange-ps/exchange/Get-SpoofIntelligenceInsight.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-spoofintelligenceinsight +online version: https://learn.microsoft.com/powershell/module/exchange/get-spoofintelligenceinsight applicable: Exchange Online, Exchange Online Protection title: Get-SpoofIntelligenceInsight schema: 2.0.0 @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-SpoofIntelligenceInsight cmdlet to view spoofed senders that were allowed or blocked by spoof intelligence during the last 7 days. +Use the Get-SpoofIntelligenceInsight cmdlet to view spoofed senders that were allowed or blocked by spoof intelligence during the last 30 days. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +34,7 @@ The Get-SpoofIntelligenceInsight cmdlet returns the following information: - SpoofType: Indicates whether the domain is internal to your organization or external. - Action: The two possible values are Allow (messages that contain any spoofed sender email addresses in your organization are allowed from the source email server), and Block (messages that contain any spoofed sender email addresses in your organization are not allowed from the source email server). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +48,7 @@ This example returns the list of senders that appear to be sending spoofed email ### Example 2 ```powershell $file = "C:\My Documents\Spoof Insights.csv" + Get-SpoofIntelligenceInsight | Export-Csv $file ``` @@ -78,12 +77,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md b/exchange/exchange-ps/exchange/Get-SpoofMailReport.md index 7f0f8e25fd..312ec706dc 100644 --- a/exchange/exchange-ps/exchange/Get-SpoofMailReport.md +++ b/exchange/exchange-ps/exchange/Get-SpoofMailReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-spoofmailreport +online version: https://learn.microsoft.com/powershell/module/exchange/get-spoofmailreport applicable: Exchange Online, Exchange Online Protection title: Get-SpoofMailReport schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SpoofMailReport cmdlet to view information about spoofed senders in your cloud-based organization for the past 90 days. Spoofing is where the sender of the inbound message is different than the actual source of the message (for example, the sender is lila@contoso.com, but the message was sent from the email infrastructure of fabrikam.com). -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,7 +51,7 @@ The Get-SpoofMailReport cmdlet returns the following information: - DKIM - DMARC -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -105,7 +103,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -187,7 +185,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -207,12 +205,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-StaleMailboxDetailReport.md b/exchange/exchange-ps/exchange/Get-StaleMailboxDetailReport.md deleted file mode 100644 index 4d577ad162..0000000000 --- a/exchange/exchange-ps/exchange/Get-StaleMailboxDetailReport.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-stalemailboxdetailreport -applicable: Exchange Online -title: Get-StaleMailboxDetailReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-StaleMailboxDetailReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-StaleMailboxDetailReport cmdlet to view mailboxes that haven't been accessed for at least 30 days. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-StaleMailboxDetailReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-StaleMailboxDetailReport -``` - -This example retrieves all the mailboxes that haven't been accessed for at least 30 days. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. The default value is 1000. - -This cmdlet returns a maximum of 50000 results, even when you use the value unlimited. If your organization has more than 50000 mailboxes, you can use the Select-Object and Sort-Object cmdlets in multiple commands to return all of the results. For example, if your organization has 90000 mailboxes, run the following commands: - -Get-StaleMailboxDetailReport -ResultSize unlimited | Sort-Object UserName -Unique | Select-Object TenantName,UserName,WindowsLiveID,LastLogin,DaysInactive -First 45000 | Export-Csv "C:\\Data\\First45k Stale.csv" - -Get-StaleMailboxDetailReport -ResultSize unlimited | Sort-Object UserName -Unique | Select-Object TenantName,UserName,WindowsLiveID,LastLogin,DaysInactive -Last 45000 | Export-Csv "C:\\Data\\Last45k Stale.csv" - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-StaleMailboxReport.md b/exchange/exchange-ps/exchange/Get-StaleMailboxReport.md deleted file mode 100644 index 1693d95095..0000000000 --- a/exchange/exchange-ps/exchange/Get-StaleMailboxReport.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-stalemailboxreport -applicable: Exchange Online -title: Get-StaleMailboxReport -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-StaleMailboxReport - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet was deprecated in January, 2018. For information about the available replacement Microsoft Graph reports in Microsoft 365, see the subtopics of [Working with Microsoft 365 usage reports in Microsoft Graph](https://docs.microsoft.com/graph/api/resources/report). - -Use the Get-StaleMailboxReport cmdlet to view the number of mailboxes that haven't been accessed for at least 30 days. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-StaleMailboxReport [-EndDate ] - [-ResultSize ] - [-StartDate ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-StaleMailboxReport -``` - -This example retrieves the number of mailboxes that haven't been accessed for at least 30 days. - -## PARAMETERS - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSize -The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. - -```yaml -Type: Unlimited -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md b/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md index 5230b66379..4a09b7af84 100644 --- a/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md +++ b/exchange/exchange-ps/exchange/Get-StoreUsageStatistics.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-storeusagestatistics +online version: https://learn.microsoft.com/powershell/module/exchange/get-storeusagestatistics applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-StoreUsageStatistics schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-StoreUsageStatistics cmdlet to aid in diagnosing performance issues with your servers or databases. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -50,7 +50,7 @@ Get-StoreUsageStatistics -Server ## DESCRIPTION The Microsoft Exchange Information Store collects per-user information on latency, input/output (I/O), page counts, processor usage, and TimeInServer. The TimeInServer metric represents the total time that synchronous and asynchronous requests spend in the Microsoft Exchange Information Store for a user's mailbox. You can retrieve this resource information in the Microsoft Exchange Information Store for the 25 highest usage accounts on a specified database. Usage of a mailbox is defined as the amount of server time spent in performing operations for that mailbox. The cmdlet reports the top 25 users for every one-minute period for the last 10 minutes (250 objects per ten-minute interval). The resource usage is an indicator of the load that different users are placing on the server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,28 +77,6 @@ This example retrieves store usage statistics for database DB1 and sorts the out ## PARAMETERS -### -Database -The Database parameter specifies the name of the mailbox database to get usage statistics from (the top 25 largest mailboxes on the specified mailbox database). You can use any value that uniquely identifies the mailbox database. For example: - -- Name -- Distinguished name (DN) -- GUID - -You can't use this parameter with the Identity or Server parameters. - -```yaml -Type: DatabaseIdParameter -Parameter Sets: Database -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Identity The Identity parameter specifies the mailbox to get usage statistics from. You can use one of the following values to identify the mailbox: @@ -127,6 +105,28 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -Database +The Database parameter specifies the name of the mailbox database to get usage statistics from (the top 25 largest mailboxes on the specified mailbox database). You can use any value that uniquely identifies the mailbox database. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can't use this parameter with the Identity or Server parameters. + +```yaml +Type: DatabaseIdParameter +Parameter Sets: Database +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Server The Server parameter specifies the Mailbox server to get usage statistics from (the top 25 mailboxes on all active databases on the specified server). You can use one of the following values to identify the server: @@ -187,16 +187,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -214,7 +214,7 @@ Accept wildcard characters: False ### -IncludePassive The IncludePassive switch specifies whether to include usage statistics from active and passive copies of mailbox databases on the Mailbox server you specified with the Server parameter. You don't need to specify a value with this switch. -To only include statistics from active copies of mailbox databases on the specified Mailbox server, don't use this switch. +If you don't use this switch, only statistics from active copies of mailbox databases are included in the results. ```yaml Type: SwitchParameter @@ -234,12 +234,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md index aed17ec52b..420045a251 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewActivity.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewactivity -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewactivity +applicable: Exchange Online, Security & Compliance title: Get-SupervisoryReviewActivity schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-SupervisoryReviewActivity cmdlet to view all activities performed by a reviewer for a specific supervision policy. This information may be useful if reviewer activities are required in regulatory compliance audits or in litigation. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,14 +26,13 @@ Get-SupervisoryReviewActivity -EndDate -PolicyId -StartDat ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-SupervisoryReviewActivity -PolicyId $policyId -StartDate $startDate -EndDate $endDate | Sort-Object Timestamp -Descending | fl -PolicyId,ItemSubject,ActivityId,Timestamp,ActionType,ActionAppliedBy,ItemStatusAfterAction +Get-SupervisoryReviewActivity -PolicyId $policyId -StartDate $startDate -EndDate $endDate | Sort-Object Timestamp -Descending | Format-List PolicyId,ItemSubject,ActivityId,Timestamp,ActionType,ActionAppliedBy,ItemStatusAfterAction ``` This example returns all the supervisory review activities for specified supervision policy. @@ -52,13 +49,13 @@ This example exports all the supervisory review activities for a policy to a .cs ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: True Position: Named @@ -74,7 +71,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: True Position: Named @@ -86,13 +83,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: True Position: Named @@ -106,12 +103,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md index 77aec02396..3a432c1505 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewOverallProgressReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewoverallprogressreport -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewoverallprogressreport +applicable: Security & Compliance title: Get-SupervisoryReviewOverallProgressReport schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewOverallProgressReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-SupervisoryReviewOverallProgressReport cmdlet to view the total number of supervised communications classified as Pending, Resolved, Compliant, Non-compliant, and Questionable. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-SupervisoryReviewOverallProgressReport [-EndDate ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -45,13 +45,13 @@ This example returns a list of the total number of supervised communications cla ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -67,7 +67,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -83,7 +83,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +95,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md index bae269ab9b..d3982ce31b 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyreport -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyreport +applicable: Exchange Online, Security & Compliance title: Get-SupervisoryReviewPolicyReport schema: 2.0.0 author: chrisda @@ -12,13 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewPolicyReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-SupervisoryReviewPolicyReport cmdlet to view supervisory review policy events in the Microsoft 365 compliance center. +Use the Get-SupervisoryReviewPolicyReport cmdlet to view supervisory review policy events in the Microsoft Purview compliance portal. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +39,7 @@ For the reporting period you specify, the Get-SupervisoryReviewPolicyReport cmdl - Tag Type: Messages that are eligible for evaluation by the policy are `InPurview`. Messages that match the conditions of the policy are `HitPolicy`. Classifications that are manually assigned to messages by the designated reviewers using the Supervision add-in for Outlook web app are `Compliant`, `Non-compliant`, `Questionable`, and `Resolved`. Messages that match the conditions of a policy but haven't been reviewed by a designated reviewer are `Not-Reviewed`. Messages that match the conditions of a policy and have been reviewed by a designated reviewer are `New-Reviewed`. - Item Count -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -64,13 +62,13 @@ This example returns the supervisory review policy events for the policy named E ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -86,7 +84,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -102,7 +100,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -120,7 +118,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -132,13 +130,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -152,12 +150,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md index dc21918588..cc356b57a5 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewPolicyV2.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyv2 -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewpolicyv2 +applicable: Exchange Online, Security & Compliance title: Get-SupervisoryReviewPolicyV2 schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewPolicyV2 ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-SupervisoryReviewPolicyV2 cmdlet to view supervisory review policies in the Microsoft 365 compliance center. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. +Use the Get-SupervisoryReviewPolicyV2 cmdlet to view supervisory review policies in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Get-SupervisoryReviewPolicyV2 [[-Identity] ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -71,12 +71,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md index d65209e803..5e1a033aa5 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewreport -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewreport +applicable: Exchange Online, Security & Compliance title: Get-SupervisoryReviewReport schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewReport ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-SupervisoryReviewReport cmdlet to view supervisory review events in the Microsoft 365 compliance center for the last 90 days. +Use the Get-SupervisoryReviewReport cmdlet to view supervisory review events in the Microsoft Purview compliance portal for the last 90 days. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Get-SupervisoryReviewReport [-EndDate ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -54,13 +54,13 @@ This example returns the supervisory review events for the policy named US Broke ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -76,7 +76,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -92,7 +92,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -110,7 +110,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -128,7 +128,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -140,13 +140,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -160,12 +160,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md index 36c622909f..1a7f812f23 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewRule.md @@ -1,8 +1,8 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewrule -applicable: Security & Compliance Center -title: Exchange Online, Get-SupervisoryReviewRule +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewrule +applicable: Exchange Online, Security & Compliance +title: Get-SupervisoryReviewRule schema: 2.0.0 author: chrisda ms.author: chrisda @@ -12,22 +12,23 @@ ms.reviewer: # Get-SupervisoryReviewRule ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Microsoft 365 compliance center. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. +Use the Get-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-SupervisoryReviewRule [[-Identity] ] + [-IncludeRuleXml] [-Policy ] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -65,7 +66,7 @@ The Identity parameter specifies the supervisory review rule that you want to vi Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: 1 @@ -74,6 +75,22 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -IncludeRuleXml +{{ Fill IncludeRuleXml Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Policy The Policy parameter filters the results by supervisory review policy that's assigned to the rule. You can use any value that uniquely identifies the policy. For example: @@ -85,7 +102,7 @@ The Policy parameter filters the results by supervisory review policy that's ass Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -99,12 +116,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md b/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md index a9f9b2761a..f630b5e84b 100644 --- a/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md +++ b/exchange/exchange-ps/exchange/Get-SupervisoryReviewTopCasesReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-supervisoryreviewtopcasesreport -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-supervisoryreviewtopcasesreport +applicable: Security & Compliance title: Get-SupervisoryReviewTopCasesReport schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-SupervisoryReviewTopCasesReport ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Get-SupervisoryReviewTopCasesReport cmdlet to view the current status of the top supervision policies configured in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-SupervisoryReviewTopCasesReport [-EndDate ] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -44,13 +44,13 @@ This example returns detailed information on supervisory policies, including the ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -66,7 +66,7 @@ The Page parameter specifies the page number of the results you want to view. Va Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -82,7 +82,7 @@ The PageSize parameter specifies the maximum number of entries per page. Valid i Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +94,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -114,12 +114,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SweepRule.md b/exchange/exchange-ps/exchange/Get-SweepRule.md index 34604f21b7..ceab5bc86d 100644 --- a/exchange/exchange-ps/exchange/Get-SweepRule.md +++ b/exchange/exchange-ps/exchange/Get-SweepRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-sweeprule -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-sweeprule +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-SweepRule schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Get-SweepRule cmdlet to view Sweep rules in mailboxes. Sweep rules run a regular intervals to help keep your Inbox clean. +Use the Get-SweepRule cmdlet to view Sweep rules in mailboxes. Sweep rules run at regular intervals to help keep your Inbox clean. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,11 +26,12 @@ Get-SweepRule [[-Identity] ] [-DomainController ] [-Mailbox ] [-Provider ] + [-ResultSize ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +58,26 @@ This example returns detailed information for the Sweep rule with the specified ## PARAMETERS +### -Identity +The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). +- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). +- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). + +```yaml +Type: SweepRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -BypassScopeCheck The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. @@ -91,26 +112,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Sweep rule that you want to view. You can use any value that uniquely identifies the rule. For example: - -- RuleId property (for example, x2hlsdpGmUifjFgxxGIOJw==). -- Exchange Online: `MailboxAlias\RuleID` (for example, `rzaher\2hlsdpGmUifjFgxxGIOJw==`). -- On-premises Exchange: `MailboxCanonicalName\RuleID` (for example, `contoso.com/Users/Rick Zaher\x2hlsdpGmUifjFgxxGIOJw==`). - -```yaml -Type: SweepRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Mailbox The Mailbox parameter filters the results by the specified mailbox. You can use any value that uniquely identifies the mailbox. For example: @@ -129,7 +130,7 @@ The Mailbox parameter filters the results by the specified mailbox. You can use Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -145,7 +146,43 @@ The Provider parameter filters the results by the specified provider. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is available only in the cloud-based service. + +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCount +This parameter is available only in the cloud-based service. + +{{ Fill SkipCount Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -159,12 +196,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-SystemMessage.md b/exchange/exchange-ps/exchange/Get-SystemMessage.md index 2c1290c532..ba18ccc28c 100644 --- a/exchange/exchange-ps/exchange/Get-SystemMessage.md +++ b/exchange/exchange-ps/exchange/Get-SystemMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-systemmessage +online version: https://learn.microsoft.com/powershell/module/exchange/get-systemmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-SystemMessage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-SystemMessage cmdlet to view default or custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Get-SystemMessage [-Original] ## DESCRIPTION NDRs are issued to the senders of email messages that haven't reached their intended recipients. Quota messages are issued to users whose mailboxes or public folders have reached the specific warning, prohibit send, or prohibit receive quotas. Custom NDRs and quota messages replace the default messages that are included with Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,26 +73,8 @@ You should output the list to a file, because the list is very long, and you'll ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Identity -TheIdentity parameter specifies the custom system message that you want to view. You can use any value that uniquely identifies the system message. For example: +The Identity parameter specifies the custom system message that you want to view. You can use any value that uniquely identifies the system message. For example: - Identity - Distinguished name (DN) @@ -102,18 +84,18 @@ You can't use this parameter with the Original switch. The identity value of a system message uses one of these formats: -- System messages for enhanced status codes:`Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. -- System messages for quotas:`Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailBox`. +- System messages for enhanced status codes: `Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. +- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailbox`. -Language: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +\: For the list of supported language codes, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). -DSNCode: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. +\: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command `Get-SystemMessage`. To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. -QuotaMessageType: Valid value are: +\: Valid value are: Mailbox size quotas: -- ProhibitSendReceiveMailBox: A mailbox exceeds its ProhibitSendReceiveQuota limit. +- ProhibitSendReceiveMailbox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. - WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. @@ -158,6 +140,24 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Original The Original switch filters the results by the default system messages that are included with Exchange. You don't need to specify a value with this switch. @@ -181,12 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md b/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md new file mode 100644 index 0000000000..4f520c8a57 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicy.md @@ -0,0 +1,67 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicy +applicable: Exchange Online +title: Get-TeamsProtectionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-TeamsProtectionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-TeamsProtectionPolicy cmdlet to view Microsoft Teams protection policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TeamsProtectionPolicy [[-Identity] ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-TeamsProtectionPolicy +``` + +This example shows detailed information about the Teams protection policy in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Teams protection policy that you want to view. There's only one Teams protection policy in an organization named Teams Protection Policy. + +```yaml +Type: TeamsProtectionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md new file mode 100644 index 0000000000..5aba335ec7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-TeamsProtectionPolicyRule.md @@ -0,0 +1,87 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-teamsprotectionpolicyrule +applicable: Exchange Online +title: Get-TeamsProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-TeamsProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Get-TeamsProtectionPolicyRule cmdlet to view Microsoft Teams protection policy rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-TeamsProtectionPolicyRule [[-Identity] ] + [-State ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-TeamsProtectionPolicyRule +``` + +This example shows detailed information about the Teams protection policy in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Teams protection policy rule that you want to view. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -State +The State parameter filters the results by the State value of the rule. Valid values are: + +- Enabled +- Disabled + +```yaml +Type: RuleState +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md index b114c2bd34..f2a8862ef7 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListItems.md @@ -1,56 +1,55 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-tenantallowblocklistitems -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-tenantallowblocklistitems +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-TenantAllowBlockListItems schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: -ROBOTS: NOINDEX --- # Get-TenantAllowBlockListItems ## SYNOPSIS -**Note**: The features described in this topic are in Preview, are subject to change, and are not available in all organizations. - This cmdlet is available only in the cloud-based service. -Use the Get-TenantAllowBlockListItems cmdlet to view entries in the Tenant Allow/Block List in the Microsoft 365 Defender portal. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Get-TenantAllowBlockListItems cmdlet to view entries in the Tenant Allow/Block List in the Microsoft Defender portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### NoExpiration +### Expiration (Default) ``` -Get-TenantAllowBlockListItems -ListType [-NoExpiration] +Get-TenantAllowBlockListItems -ListType [-ExpirationDate ] + [-Allow] [-Block] [-Entry ] + [-ListSubType ] [-OutputJson] [] ``` -### Expiration +### NoExpiration ``` -Get-TenantAllowBlockListItems -ListType [-ExpirationDate ] +Get-TenantAllowBlockListItems -ListType [-NoExpiration] + [-Allow] [-Block] [-Entry ] + [-ListSubType ] [-OutputJson] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-TenantAllowBlockListItems -ListType Url -Action Block +Get-TenantAllowBlockListItems -ListType Url -Block ``` This example returns all blocked URLs. @@ -62,19 +61,28 @@ Get-TenantAllowBlockListItems -ListType FileHash -Entry "9f86d081884c7d659a2feaa This example returns information for the specified file hash value. +### Example 3 +```powershell +Get-TenantAllowBlockListItems -ListType Url -ListSubType AdvancedDelivery +``` + +This example returns information for all allowed third-party phishing simulation URLs. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + ## PARAMETERS ### -ListType The ListType parameter specifies the list to view. Valid values are: - FileHash +- Sender - Url +- IP ```yaml Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -86,14 +94,18 @@ Accept wildcard characters: False ### -Entry The Entry parameter filters the results based on the ListType parameter value. Valid values are: -- Url: The exact URL entry value. -- File: The exact SHA256 file hash value. +- FileHash: The exact SHA256 file hash value. +- Sender: The exact domain or email address value. +- Url: The exact URL value. +- IP: IPv6 addresses only. Single IPv6 addresses in colon-hexadecimal or zero-compression format or CIDR IPv6 ranges from 1 to 128. + +This value is shown in the Value property of the entry in the output of the Get-TenantAllowBlockListItems cmdlet. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -109,7 +121,7 @@ The NoExpiration switch filters the results by entries that are set to never exp Type: SwitchParameter Parameter Sets: NoExpiration Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -118,6 +130,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Allow +The Allow switch filters the results for allow entries. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Block The Block switch filters the results for block entries. You don't need to specify a value with this switch. @@ -125,7 +153,7 @@ The Block switch filters the results for block entries. You don't need to specif Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -140,13 +168,32 @@ The ExpirationDate parameter filters the results by expiration date in Coordinat To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, `"2021-05-06 14:30:00z"`. -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime Parameter Sets: Expiration Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListSubType +The ListSubType parameter filters the results by subtype. Valid values are: + +- AdvancedDelivery +- Tenant: This is the default value. + +```yaml +Type: ListSubType[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -164,7 +211,7 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -178,12 +225,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md index e83a75491b..a77fd3036a 100644 --- a/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/Get-TenantAllowBlockListSpoofItems.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-tenantallowblocklistspoofitems -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-tenantallowblocklistspoofitems +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Get-TenantAllowBlockListSpoofItems schema: 2.0.0 author: chrisda @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Get-TenantAllowBlockListSpoofItems cmdlet to view spoof entries in the Tenant Allow/Block List. +Use the Get-TenantAllowBlockListSpoofItems cmdlet to view spoofed sender entries in the Tenant Allow/Block List. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +36,7 @@ The Get-TenantAllowBlockListSpoofItems cmdlet returns the following information: - SpoofType: Indicates whether the domain is internal to your organization or external. - Action: The two possible values are Allow (messages that contain any spoofed sender email addresses in your organization are allowed from the source email server) or Block (messages that contain any spoofed sender email addresses in your organization are not allowed from the source email server). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,6 +62,7 @@ This example returns the list of spoof pairs that appear to be sending spoofed e ### Example 4 ```powershell $file = "C:\My Documents\Spoof Tenant Allow Block List.csv" + Get-TenantAllowBlockListSpoofItems | Export-Csv $file ``` @@ -78,7 +77,7 @@ The Identity parameter is available but isn't used. Type: HostedConnectionFilterPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: 0 @@ -97,7 +96,7 @@ The Action parameter filters the results by action type. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -116,7 +115,7 @@ The SpoofType parameter filters the results by spoof type. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -130,12 +129,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TenantAnalyticsConfig.md b/exchange/exchange-ps/exchange/Get-TenantAnalyticsConfig.md deleted file mode 100644 index f93c73ccb3..0000000000 --- a/exchange/exchange-ps/exchange/Get-TenantAnalyticsConfig.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-tenantanalyticsconfig -applicable: Exchange Online -title: Get-TenantAnalyticsConfig -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-TenantAnalyticsConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -This cmdlet has been deprecated and no longer used. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-TenantAnalyticsConfig [] -``` - -## DESCRIPTION -This cmdlet has been deprecated and no longer used. - -## EXAMPLES - -### Example 1 -```powershell -Get-TenantAnalyticsConfig -``` - -This cmdlet has been deprecated and no longer used. - -## 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md index 5b39b91bea..11e102c7e7 100644 --- a/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md +++ b/exchange/exchange-ps/exchange/Get-TextMessagingAccount.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-textmessagingaccount +online version: https://learn.microsoft.com/powershell/module/exchange/get-textmessagingaccount applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-TextMessagingAccount schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-TextMessagingAccount cmdlet to view the text notification settings on mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Get-TextMessagingAccount [-Identity] ## DESCRIPTION When text messaging notifications are enabled on a mailbox, you can configure calendar notifications, voice mail notifications, and email notifications using an inbox rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,6 +46,7 @@ This example returns the text messaging settings for Tony's mailbox. ### Example 2 ```powershell $mbx = Get-Mailbox -RecipientTypeDetails UserMailbox -ResultSize Unlimited + $mbx | foreach {Get-TextMessagingAccount -Identity $_.Alias | where {($_.NotificationPhoneNumberVerified -eq $true)} | Format-Table Identity,NotificationPhoneNumber} ``` @@ -83,7 +84,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -117,7 +118,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -155,12 +158,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md index 271a4ec9fc..5299f4079b 100644 --- a/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/Get-ThrottlingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-throttlingpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-throttlingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ThrottlingPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ThrottlingPolicy cmdlet to view the user throttling settings for one or more throttling policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Get-ThrottlingPolicy [[-Identity] ] ## DESCRIPTION The Get-ThrottlingPolicy cmdlet returns the client throttling settings for one or more throttling policies. If you use the Identity parameter, the cmdlet returns the settings for the identified throttling policy. If you don't use the Identity parameter, the cmdlet returns the settings for all throttling policies. -For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). +For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,42 +54,42 @@ This example displays the parameters and values for throttling policy Throttling ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +The Identity parameter identifies the name of the throttling policy that you want to return settings for. ```yaml -Type: Fqdn +Type: ThrottlingPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter identifies the name of the throttling policy that you want to return settings for. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: ThrottlingPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -Diagnostics -The Diagnostics switch specifies whether you want the output to include the diagnostics string. To return diagnostics information, use the syntax Get-ThrottlingPolicy -Diagnostics. You don't specify a value for this switch. +The Diagnostics switch specifies whether you want the output to include the diagnostics string. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -105,7 +105,7 @@ Accept wildcard characters: False ``` ### -Explicit -The Explicit switch specifies whether you only want to return the policy settings that have been directly assigned using this policy. By default, this parameter is set to $false. +The Explicit switch specifies whether to return only the policy settings that have been directly assigned using this policy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -127,7 +127,7 @@ The ThrottlingPolicyScope parameter specifies the scope of the throttling policy - Organization - Regular -For information about each of these policy scopes, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). +For information about each of these policy scopes, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). ```yaml Type: ThrottlingPolicyScopeType @@ -147,12 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md index 5f69707aa1..6850db5cc9 100644 --- a/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Get-ThrottlingPolicyAssociation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-throttlingpolicyassociation +online version: https://learn.microsoft.com/powershell/module/exchange/get-throttlingpolicyassociation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-ThrottlingPolicyAssociation schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-ThrottlingPolicyAssociation cmdlet to view existing throttling policy associations in your organization. Throttling policies can be associated with mailboxes, user accounts, mail contacts, mail users, and Exchange server computer accounts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,9 +41,9 @@ Get-ThrottlingPolicyAssociation [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,37 +48,37 @@ This example displays detailed information about the Transport Rule agent that's ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +The Identity parameter specifies the display name of the transport agent to be displayed. The length of the name can't exceed 64 characters. ```yaml -Type: Fqdn +Type: TransportAgentObjectId Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the display name of the transport agent to be displayed. The length of the name can't exceed 64 characters. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: TransportAgentObjectId +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -109,12 +109,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-TransportConfig.md b/exchange/exchange-ps/exchange/Get-TransportConfig.md index ab5e6007a6..3357a4be56 100644 --- a/exchange/exchange-ps/exchange/Get-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Get-TransportConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-transportconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-transportconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Get-TransportConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-TransportConfig cmdlet to view organization-wide transport configuration settings. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-TransportConfig [[-Identity] ] ## DESCRIPTION The Get-TransportConfig cmdlet displays configuration information for global transport settings applied across the organization when the cmdlet is run on a Mailbox server. When this cmdlet is run on an Edge Transport server, only the transportation configuration settings for the local computer are shown. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,41 +49,41 @@ This example lists all delivery status notification-related (DSN) configuration ## PARAMETERS -### -DomainController +### -Identity This parameter is available only in on-premises Exchange. -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +This parameter is reserved for internal Microsoft use. ```yaml -Type: Fqdn +Type: OrganizationIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity +### -DomainController This parameter is available only in on-premises Exchange. -This parameter is reserved for internal Microsoft use. +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: OrganizationIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -92,12 +92,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-TransportPipeline.md b/exchange/exchange-ps/exchange/Get-TransportPipeline.md index abbd71d8ed..8366b7fc1a 100644 --- a/exchange/exchange-ps/exchange/Get-TransportPipeline.md +++ b/exchange/exchange-ps/exchange/Get-TransportPipeline.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-transportpipeline +online version: https://learn.microsoft.com/powershell/module/exchange/get-transportpipeline applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-TransportPipeline schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-TransportPipeline cmdlet to view transport agents and the SMTP event where the transport agent is registered. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ The Get-TransportPipeline cmdlet enables you to view all the transport agents th The associated transport service must be started and at least one email message must be sent through the server since the last service restart before the transport pipeline can be viewed. Only the transport events and agents that were involved in the processing of email messages since the associated service was last started are returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,12 +77,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-TransportRule.md b/exchange/exchange-ps/exchange/Get-TransportRule.md index e9b51c36f9..d55f8756f4 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRule.md +++ b/exchange/exchange-ps/exchange/Get-TransportRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-transportrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-TransportRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-TransportRule cmdlet to view transport rules (mail flow rules) in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Get-TransportRule [[-Identity] ] ## DESCRIPTION On Mailbox servers, this cmdlet returns all rules in the Exchange organization that are stored in Active Directory. On an Edge Transport server, this cmdlet only returns rules that are configured on the local server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,61 +52,61 @@ Get-TransportRule "Ethical Wall - Sales and Brokerage Departments" | Format-List This example returns detailed information for the rule named "Ethical Wall - Sales and Brokerage Departments". -For more information about pipelining, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ### Example 3 ```powershell Get-TransportRule -DlpPolicy "PII (U.S.)" ``` -This example returns a summary list of the rules that enforce the DLP policy named PII (U.S.) in your organization. +In on-premises Exchange, this example returns a summary list of the rules that enforce the DLP policy named PII (U.S.) in the organization. ### Example 4 ```powershell Get-TransportRule | Where {$_.DlpPolicy -ne $null} ``` -This example returns a summary list of all rules that enforce DLP policies in your organization. +In on-premises Exchange, this example returns a summary list of all rules that enforce DLP policies in the organization. ## PARAMETERS -### -DomainController -This parameter is available only in on-premises Exchange. - -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: Fqdn +Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: +### -DomainController +This parameter is available only in on-premises Exchange. -- Name -- Distinguished name (DN) -- GUID +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: RuleIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -132,7 +132,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy -The DlpPolicy parameter filters the results by the named of the specified data loss prevention (DLP) policy. If the value contains spaces, enclose the value in quotation marks ("). +**Note**: This parameter is functional only in on-premises Exchange. + +The DlpPolicy parameter filters the results by the name of the specified data loss prevention (DLP) policy. If the value contains spaces, enclose the value in quotation marks ("). DLP policies in your organization allow you to prevent unintentional disclosure of sensitive information. Each DLP policy is enforced using a set of transport rules. @@ -171,11 +173,11 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter filters the results by using an OPath. This parameter searches the Description property, which includes the conditions, exceptions, actions and the associated values of a transport rule. +The Filter parameter filters the results by using an OPATH. This parameter searches the Description property, which includes the conditions, exceptions, actions and the associated values of a transport rule. This parameter uses the syntax `"Description -like 'Text*'"`. For example, `"Description -like '192.168.1.1*'"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -211,12 +213,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-TransportRuleAction.md b/exchange/exchange-ps/exchange/Get-TransportRuleAction.md index 84d8e3eb33..a7052dc127 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRuleAction.md +++ b/exchange/exchange-ps/exchange/Get-TransportRuleAction.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-transportruleaction +online version: https://learn.microsoft.com/powershell/module/exchange/get-transportruleaction applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-TransportRuleAction schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-TransportRuleAction cmdlet to view the actions that are available for transport rules (mail flow rules). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-TransportRuleAction [[-Name] ] ## DESCRIPTION In on-premises Exchange, the actions that are available on Mailboxes servers and Edge Transports server are different. Also, the names of some of the actions that are returned by this cmdlet are different than the corresponding parameter names in the New-TransportRule and Set-TransportRule cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,7 +46,7 @@ Get-TransportRuleAction -Name DeleteMessage | Format-List This example retrieves detailed information about the action named DeleteMessage. -For more information about pipelining, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ## PARAMETERS @@ -71,12 +71,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md b/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md index c9167e5ae7..1781b502e3 100644 --- a/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md +++ b/exchange/exchange-ps/exchange/Get-TransportRulePredicate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-transportrulepredicate +online version: https://learn.microsoft.com/powershell/module/exchange/get-transportrulepredicate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Get-TransportRulePredicate schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-TransportRulePredicate cmdlet to view the predicates (conditions and exceptions) that are available for transport rules (mal flow rules). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Collectively, the conditions and exceptions in rules are known as predicates, be In on-premises Exchange, the predicates that are available on Mailboxes servers and Edge Transports server are different. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,7 +48,7 @@ Get-TransportRulePredicate -Name SubjectMatches | Format-List This example returns detailed information about the predicate named SubjectMatches. -For more information about pipelining, see [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about pipelining, see [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). For more information about how to work with the output of a command, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ### Example 3 ```powershell @@ -57,7 +57,7 @@ Get-TransportRulePredicate | Where {$_.Name -like "*Attachment*"} This example returns a summary list of all predicates that have Attachment in the name. -For more information about how to work with the output of a command, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help). +For more information about how to work with the output of a command, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help). ## PARAMETERS @@ -82,12 +82,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-TransportServer.md b/exchange/exchange-ps/exchange/Get-TransportServer.md index fcbfe129c6..9e6bfd34f4 100644 --- a/exchange/exchange-ps/exchange/Get-TransportServer.md +++ b/exchange/exchange-ps/exchange/Get-TransportServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-transportserver +online version: https://learn.microsoft.com/powershell/module/exchange/get-transportserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-TransportServer schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Get-TransportServer cmdlet to view settings that are associated with the **Note**: In Exchange 2013 or later, use the Get-TransportService cmdlet instead. If you have scripts that use Get-TransportServer, update them to use Get-TransportService. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-TransportServer [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,42 +49,42 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the Transport server that you want to view. You can use any value that uniquely identifies the server. For example: -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +- Name +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN ```yaml -Type: Fqdn +Type: TransportServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Transport server that you want to view. You can use any value that uniquely identifies the server. For example: +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -- Name -- GUID -- Distinguished name (DN) -- ExchangeLegacyDN +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: TransportServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -93,12 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-TransportService.md b/exchange/exchange-ps/exchange/Get-TransportService.md index ae0f406504..de2c585879 100644 --- a/exchange/exchange-ps/exchange/Get-TransportService.md +++ b/exchange/exchange-ps/exchange/Get-TransportService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-transportservice +online version: https://learn.microsoft.com/powershell/module/exchange/get-transportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-TransportService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-TransportService cmdlet to view the settings of the Transport service on Exchange 2013 or later Mailbox servers or Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-TransportService [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,44 +47,44 @@ This example retrieves the detailed transport configuration information for the ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the Mailbox server that hosts the Transport service configuration you want to view. You can use any value that uniquely identifies the server. For example: -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +- Name +- GUID +- Distinguished name (DN) +- ExchangeLegacyDN + +You can't use this parameter on an Edge Transport server. ```yaml -Type: Fqdn +Type: TransportServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Mailbox server that hosts the Transport service configuration you want to view. You can use any value that uniquely identifies the server. For example: - -- Name -- GUID -- Distinguished name (DN) -- ExchangeLegacyDN +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. -You can't use this parameter on an Edge Transport server. +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: TransportServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -93,12 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-Trust.md b/exchange/exchange-ps/exchange/Get-Trust.md index 2690f8465b..06c4e8a053 100644 --- a/exchange/exchange-ps/exchange/Get-Trust.md +++ b/exchange/exchange-ps/exchange/Get-Trust.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-trust +online version: https://learn.microsoft.com/powershell/module/exchange/get-trust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-Trust schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-Trust cmdlet to return external and forest trusts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Get-Trust [-DomainName ] ## DESCRIPTION The Get-Trust cmdlet is used by the Exchange admin center in to populate fields that display recipient information. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,12 +62,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md b/exchange/exchange-ps/exchange/Get-UMActiveCalls.md index e1bb3e0e09..ad6d739107 100644 --- a/exchange/exchange-ps/exchange/Get-UMActiveCalls.md +++ b/exchange/exchange-ps/exchange/Get-UMActiveCalls.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umactivecalls +online version: https://learn.microsoft.com/powershell/module/exchange/get-umactivecalls applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMActiveCalls schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMActiveCalls cmdlet to return information about the calls that are active and being processed by the Mailbox server running the Microsoft Exchange Unified Messaging service. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -55,7 +55,7 @@ When a Mailbox server is process cycling, the Get-UMActiveCalls cmdlet doesn't r After this task is completed, you can see the list of active calls being processed by a Mailbox server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -187,12 +187,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md index f755ba4e87..4ae3dced8b 100644 --- a/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/Get-UMAutoAttendant.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umautoattendant +online version: https://learn.microsoft.com/powershell/module/exchange/get-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMAutoAttendant schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMAutoAttendant cmdlet to retrieve the properties and the values for a Unified Messaging (UM) auto attendant. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ The Get-UMAutoAttendant cmdlet retrieves the properties for a single UM auto att After this task is completed, if no parameter is supplied with the cmdlet, the cmdlet returns all UM auto attendants in the Active Directory forest. Or, if the UM dial plan ID is supplied but no name is supplied, the cmdlet returns all UM auto attendants linked to the UM dial plan. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,35 +59,35 @@ This examples displays all the UM auto attendants associated with the UM dial pl ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the identifier for the UM auto attendant that's being viewed. This is the directory object ID for the UM auto attendant. ```yaml -Type: Fqdn +Type: UMAutoAttendantIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identifier for the UM auto attendant that's being viewed. This is the directory object ID for the UM auto attendant. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: UMAutoAttendantIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -112,12 +112,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md index bf760a07e9..e469e77136 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/exchange/Get-UMCallAnsweringRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umcallansweringrule +online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 title: Get-UMCallAnsweringRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMCallAnsweringRule cmdlet to view the properties of a Unified Messaging (UM) call answering rule that has been created within a UM-enabled mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ The Get-UMCallAnsweringRule cmdlet enables you to view the properties of a call After this task is completed, the cmdlet returns the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,35 +52,35 @@ This example displays the properties of the call answering rule MyUMCallAnswerin ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the identifier for a call answering rule being viewed. ```yaml -Type: Fqdn +Type: UMCallAnsweringRuleIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identifier for a call answering rule being viewed. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: UMCallAnsweringRuleIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md b/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md index 6c69a2f0f8..868677c8f0 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md +++ b/exchange/exchange-ps/exchange/Get-UMCallDataRecord.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umcalldatarecord -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-umcalldatarecord +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMCallDataRecord schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-UMCallDataRecord ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the Get-UMCallDataRecord cmdlet to display Unified Messaging (UM) call data records for a specific UM-enabled user's mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,7 +44,7 @@ The Get-UMCallDataRecord cmdlet displays UM call data records for the last 90 da - RoundTripMilliseconds: Round trip time for Real Time Control Protocol (RTCP) statistics in milliseconds. - BurstLossDurationMilliseconds: Average duration of packet loss during bursts during the call. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,7 +75,7 @@ The Mailbox parameter specifies the UM-enabled mailbox that UM call data records Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -85,8 +85,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -107,12 +105,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md index 32532c7a64..44123198a3 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md +++ b/exchange/exchange-ps/exchange/Get-UMCallRouterSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umcallroutersettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallroutersettings applicable: Exchange Server 2013, Exchange Server 2016 title: Get-UMCallRouterSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMCallRouterSettings cmdlet to view the settings of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-UMCallRouterSettings [[-Server] ] ## DESCRIPTION When the cmdlet is used for a single server, it returns the UM call router properties including MaxCalls, MaxFaxCalls and UMDialPlans. The properties and their values are stored in the Unified Messaging section of the Microsoft Exchange configuration object in Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,12 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md b/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md index 50fb792015..87b5ea88f8 100644 --- a/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md +++ b/exchange/exchange-ps/exchange/Get-UMCallSummaryReport.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umcallsummaryreport -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-umcallsummaryreport +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMCallSummaryReport schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-UMCallSummaryReport ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the Get-UMCallSummaryReport cmdlet to return statistics about all calls received or placed by Mailbox servers running the Microsoft Exchange Unified Messaging service in an organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-UMCallSummaryReport -GroupBy ``` ## DESCRIPTION -The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all calls received or placed by Mailbox servers running the Microsoft Exchange Unified Messaging service in an organization including voice messages, missed calls, subscriber access, auto attendant, or fax calls. The data returned by running this cmdlet includes audio quality metrics for the sample calls such as the following: +The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all calls received or placed by servers running the Microsoft Exchange Unified Messaging service in an organization including voice messages, missed calls, subscriber access, auto attendant, or fax calls. The data returned by running this cmdlet includes audio quality metrics for the sample calls such as the following: - Date: Date in which all calls associated with the selected UM IP gateway and UM dial plan have been grouped based on the value of the GroupBy parameter: Total has the value ---, Month has the value MMM/YY and Day has the value MM/DD/YY, where MMM is the first three letters of the month and YY is the last two digits of the year. - Voice Message: Percentage of incoming calls answered by Unified Messaging on behalf of users in which callers left a voice message. @@ -39,19 +39,19 @@ The Get-UMCallSummaryReport cmdlet displays the aggregated statistics about all - Automated Attendant: Percentage of incoming calls that were answered by auto attendants. - Fax: Percentage of incoming calls that were redirected to a fax partner. - Other: Percentage of any other incoming or placed calls that don't fall in any of the previous categories. This is provided to allow different types of calls that might be provided in the future to be accounted for as well. This category includes unauthenticated calls made to pilot numbers. -- Failed Or Rejected: Percentage of calls that either failed or were rejected by the Mailbox server for that organization. +- Failed Or Rejected: Percentage of calls that either failed or were rejected by the server for that organization. - Audio Quality: Overall audio quality for the selected period of time for the organization/user. 4.50 or higher = Excellent, 3.5 to 4.49 = Good, 2.5 to 3.49 = Average, 1.50 to 2.49 =Poor, and 1.49 or lower = Bad. - Total Calls: If the UM IP gateway is selected, this is the total number of calls grouped for the selected UM IP gateway for the corresponding date, If the UM dial plan control is selected, this is the total number of calls grouped for the selected UM dial plan for the corresponding date, and If the user is selected, this column has the total number of calls for the user. - Network MOS (NMOS): Average NMOS for the specific UM dial plan or UM IP gateway. -- NMOS Degradation: -- NMOS degradation for the specific UM dial plan or UM IP gateway.: +- NMOS Degradation. +- NMOS degradation for the specific UM dial plan or UM IP gateway. - Jitter: Average jitter for the specific UM dial plan or UM IP gateway. - Packet loss: Average packet loss for the specific UM dial plan or UM IP gateway. - Round Trip: Round trip time (in milliseconds) for the selected UM dial plan or UM IP gateway. - Burst loss Duration: Average duration of packet loss during bursts of losses for the selected UM dial plan or UM IP gateway. - Number of samples: Number of calls sampled, when calculating the averages. A sample refers to any call data record that contains at least one of the audio quality metrics. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -96,7 +96,7 @@ The GroupBy parameter specifies how to return the results. Valid values are: Type: GroupBy Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True Position: Named @@ -106,8 +106,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -130,7 +128,7 @@ The UMDialPlan parameter specifies the Unified Messaging (UM) dial plan to show Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -146,7 +144,7 @@ The UMIPGateway parameter specifies the UM IP gateway to show statistics for. If Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False Position: Named @@ -160,12 +158,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMDialPlan.md b/exchange/exchange-ps/exchange/Get-UMDialPlan.md index fa81111014..fe86e9ee42 100644 --- a/exchange/exchange-ps/exchange/Get-UMDialPlan.md +++ b/exchange/exchange-ps/exchange/Get-UMDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umdialplan +online version: https://learn.microsoft.com/powershell/module/exchange/get-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMDialPlan schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMDialPlan cmdlet to display the properties of a single Unified Messaging (UM) dial plan or to return a list of all UM dial plans associated with Mailbox servers running the Microsoft Exchange Unified Messaging service. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ The Get-UMDialPlan cmdlet displays all properties for a UM dial plan. After this task is completed, when you specify the Identity parameter, you can view the values set. When the Get-UMDialPlan cmdlet is run, if no parameter is supplied, the cmdlet returns all UM dial plans in the Active Directory forest. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,35 +51,35 @@ This example displays a formatted list of properties for the UM dial plan MyUMDi ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the UM dial plan ID. ```yaml -Type: Fqdn +Type: UMDialPlanIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the UM dial plan ID. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: UMDialPlanIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -88,12 +88,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMHuntGroup.md b/exchange/exchange-ps/exchange/Get-UMHuntGroup.md index a6a168e1a6..d1a7328d41 100644 --- a/exchange/exchange-ps/exchange/Get-UMHuntGroup.md +++ b/exchange/exchange-ps/exchange/Get-UMHuntGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umhuntgroup +online version: https://learn.microsoft.com/powershell/module/exchange/get-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMHuntGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMHuntGroup cmdlet to display the properties and values for an existing Unified Messaging (UM) hunt group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ The Get-UMHuntGroup cmdlet retrieves the properties for a single UM hunt group o After this task is completed, if the Identity parameter is specified, the properties for the UM hunt group are returned. If neither the Identity nor the UMDialPlan parameter is specified, all UM hunt groups in the Active Directory forest are returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,35 +59,35 @@ This example displays all of the UM hunt groups associated with the UM dial plan ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the identifier for the UM hunt group being viewed. This is the directory object ID for the UM hunt group. ```yaml -Type: Fqdn +Type: UMHuntGroupIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identifier for the UM hunt group being viewed. This is the directory object ID for the UM hunt group. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: UMHuntGroupIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -112,12 +112,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMIPGateway.md b/exchange/exchange-ps/exchange/Get-UMIPGateway.md index 5887ff6841..f027b0d0a4 100644 --- a/exchange/exchange-ps/exchange/Get-UMIPGateway.md +++ b/exchange/exchange-ps/exchange/Get-UMIPGateway.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umipgateway +online version: https://learn.microsoft.com/powershell/module/exchange/get-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMIPGateway schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMIPGateway cmdlet to return a list of properties and values for a specified Unified Messaging (UM) IP gateway or a list of UM IP gateways. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ When you're using the Get-UMIPGateway cmdlet, you can't enter the IP address con After this task is completed, you can view the list of properties and values for a specific UM IP gateway. Or, if the Identity parameter isn't used, the cmdlet returns a list of all UM IP gateways in the forest. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,40 +61,42 @@ This example displays all the UM IP gateways including IP gateway simulators in ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the identifier for the UM IP gateway being viewed. This parameter is the directory object ID for the UM IP gateway. ```yaml -Type: Fqdn +Type: UMIPGatewayIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identifier for the UM IP gateway being viewed. This parameter is the directory object ID for the UM IP gateway. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: UMIPGatewayIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -IncludeSimulator -The IncludeSimulator switch retrieves the simulator of the UM IP gateway being viewed. A simulator allows a client to connect to the Mailbox server. +The IncludeSimulator switch retrieves the simulator of the UM IP gateway being viewed. You don't need to specify a value with this switch. + +A simulator allows a client to connect to the Mailbox server. ```yaml Type: SwitchParameter @@ -114,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMMailbox.md b/exchange/exchange-ps/exchange/Get-UMMailbox.md index 034b948df9..215a6b501d 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailbox.md +++ b/exchange/exchange-ps/exchange/Get-UMMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ummailbox +online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMMailbox cmdlet to view existing mailboxes that are Unified Messaging (UM) enabled. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,7 +49,7 @@ Get-UMMailbox [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,6 +69,33 @@ This example displays detailed information for the UM-enabled mailbox for tonysm ## PARAMETERS +### -Identity +The Identity parameter specifies the UM-enabled mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -94,7 +121,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -126,16 +153,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -150,37 +177,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the UM-enabled mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -220,7 +220,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -282,12 +284,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md b/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md index f0e1dc8ecb..c3eb5e4cc0 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md +++ b/exchange/exchange-ps/exchange/Get-UMMailboxPIN.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ummailboxpin +online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailboxpin applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMMailboxPIN schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMMailboxPIN cmdlet to return information from a Unified Messaging (UM)-enabled user's mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ The Get-UMMailboxPIN cmdlet returns information calculated from the PIN data sto After this task is completed, you can view information on a user's mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,29 +56,40 @@ This example displays the UM mailbox PIN-related properties for tonysmith@contos ## PARAMETERS -### -Credential -The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. +### -Identity +The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) ```yaml -Type: PSCredential +Type: MailboxIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Credential +The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml -Type: Fqdn +Type: PSCredential Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 @@ -90,37 +101,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MailboxIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -139,7 +139,9 @@ Accept wildcard characters: False ``` ### -IgnoreErrors -The IgnoreErrors switch specifies whether errors that may occur when running this cmdlet are written as warnings. +The IgnoreErrors switch specifies whether to ignore errors. You don't need to specify a value with this switch. + +When you use this switch, errors that occur are written as warnings. ```yaml Type: SwitchParameter @@ -155,7 +157,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -193,12 +197,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md index aed6d57523..d3e95a0446 100644 --- a/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Get-UMMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ummailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/get-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Get-UMMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMMailboxPolicy cmdlet to display the properties and values of a Unified Messaging (UM) mailbox policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ The Get-UMMailboxPolicy cmdlet retrieves the configuration properties and values After this task is completed, if the Identity parameter is supplied, the properties and values for the specified UM mailbox policy object are returned. If no parameter is specified at the command prompt, all UM mailbox policies in the Active Directory forest are returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,35 +59,35 @@ This examples displays all the UM mailbox policies associated with the UM dial p ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the identifier for the UM mailbox policy being viewed. This is the directory object ID for the UM mailbox policy. ```yaml -Type: Fqdn +Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the identifier for the UM mailbox policy being viewed. This is the directory object ID for the UM mailbox policy. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: MailboxPolicyIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -112,12 +112,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UMService.md b/exchange/exchange-ps/exchange/Get-UMService.md index 7881a56cf1..6551e952a2 100644 --- a/exchange/exchange-ps/exchange/Get-UMService.md +++ b/exchange/exchange-ps/exchange/Get-UMService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umservice +online version: https://learn.microsoft.com/powershell/module/exchange/get-umservice applicable: Exchange Server 2013, Exchange Server 2016 title: Get-UMService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UMService cmdlet to view the settings of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ When the cmdlet is used for a single Exchange server, it returns the Unified Mes The ExchangeVersion attribute that's returned is the minimum version of Exchange you can use to manage the returned object. This attribute isn't the same as the version of Exchange that's displayed in the Exchange admin center when you select Server Configuration. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,40 +51,40 @@ This example displays detailed information for the Microsoft Exchange Unified Me ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Identity +The Identity parameter specifies the Mailbox server that hosts the Unified Messaging service configuration you want to view. You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID ```yaml -Type: Fqdn +Type: UMServerIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Mailbox server that hosts the Unified Messaging service configuration you want to view. You can use any value that uniquely identifies the server. For example: - -- Name -- Distinguished name (DN) -- ExchangeLegacyDN -- GUID +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: UMServerIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -93,12 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UmServer.md b/exchange/exchange-ps/exchange/Get-UmServer.md index 7a2fe1e601..0ba48166ad 100644 --- a/exchange/exchange-ps/exchange/Get-UmServer.md +++ b/exchange/exchange-ps/exchange/Get-UmServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-umserver +online version: https://learn.microsoft.com/powershell/module/exchange/get-umserver applicable: Exchange Server 2010 title: Get-UmServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Get-UMServer cmdlet to view settings that are associated with the Unified Messaging (UM) server role. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The ExchangeVersion attribute that's returned is the minimum version of Microsof After this task is completed, you can view the parameters and values for a single Unified Messaging server or a list of all of the Unified Messaging servers in Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,12 +95,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md index 6ae291ea78..07a961fcf8 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedAuditLogRetentionPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-unifiedauditlogretentionpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedauditlogretentionpolicy +applicable: Security & Compliance title: Get-UnifiedAuditLogRetentionPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-UnifiedAuditLogRetentionPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-UnifiedAuditLogRetentionPolicy cmdlet to view the properties of the audit log retention policies in the Microsoft 365 Defender portal or the Microsoft 365 compliance center. +Use the Get-UnifiedAuditLogRetentionPolicy cmdlet to view the properties of the audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Get-UnifiedAuditLogRetentionPolicy ``` ## DESCRIPTION -Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see [Manage audit log retention policies](https://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). +Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -53,7 +53,7 @@ This example lists the configurable properties for all audit log retention polic ## PARAMETERS ### -Operation -The Operations parameter filters the results by the operations that are specified in the policy. For a list of the available values for this parameter, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). +The Operations parameter filters the results by the operations that are specified in the policy. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -61,7 +61,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -71,13 +71,13 @@ Accept wildcard characters: False ``` ### -RecordType -The RecordType parameter filters the results by the record types that are defined in the policy. For details about the available values, see [AuditLogRecordType](https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). +The RecordType parameter filters the results by the record types that are defined in the policy. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). ```yaml Type: AuditRecordType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,7 +100,7 @@ Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -118,7 +118,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -132,12 +132,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md index 512830b16d..0d661079bb 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-unifiedgroup -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedgroup +applicable: Exchange Online, Exchange Online Protection title: Get-UnifiedGroup schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-UnifiedGroup cmdlet to view Microsoft 365 Groups in your cloud-based organization. To view members, owners and subscribers for Microsoft 365 Groups, use the Get-UnifiedGroupLinks cmdlet. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +24,12 @@ For information about the parameter sets in the Syntax section below, see [Excha ``` Get-UnifiedGroup [[-Identity] ] [-Filter ] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAllProperties] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-IncludeRejectMessagesFromSendersOrMembersWithDisplayNames] [-IncludeSoftDeletedGroups] [-ResultSize ] [-SortBy ] @@ -37,7 +40,12 @@ Get-UnifiedGroup [[-Identity] ] ``` Get-UnifiedGroup [-Anr ] [-Filter ] + [-IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames] [-IncludeAllProperties] + [-IncludeBypassModerationFromSendersOrMembersWithDisplayNames] + [-IncludeGrantSendOnBehalfToWithDisplayNames] + [-IncludeModeratedByWithDisplayNames] + [-IncludeRejectMessagesFromSendersOrMembersWithDisplayNames] [-IncludeSoftDeletedGroups] [-ResultSize ] [-SortBy ] @@ -47,7 +55,7 @@ Get-UnifiedGroup [-Anr ] ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -94,6 +102,31 @@ This example returns Microsoft 365 Groups that are created when a Microsoft Team ## PARAMETERS +### -Identity +The Identity parameter specifies the Microsoft 365 Group that you want to view. You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +**Note**: You can use the DisplayName value to identify the Microsoft 365 Group, but the results aren't guaranteed to be unique. If you must return a singular and unique result, use a unique identifier for the Microsoft 365 Group. + +```yaml +Type: UnifiedGroupIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr This parameter is reserved for internal Microsoft use. @@ -101,7 +134,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,22 +144,22 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -135,28 +168,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the Microsoft 365 Group that you want to view. You can use any value that uniquely identifies the Microsoft 365 Group. For example: +### -IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames +The IncludeAcceptMessagesOnlyFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of AcceptMessagesOnlyFromSendersOrMembers recipients in the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -**Note**: You can use the DisplayName value to identify the Microsoft 365 Group, but the results aren't guaranteed to be unique. If you must return a singular and unique result, use a unique identifier for the Microsoft 365 Group. +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, AcceptMessagesOnlyFromSendersOrMembers recipients are shown as GUIDs and the AcceptMessagesOnlyFromSendersOrMembersWithDisplayNames property is empty. ```yaml -Type: UnifiedGroupIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -169,7 +195,79 @@ If you don't use this switch, the values of some properties (for example, Calend Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeBypassModerationFromSendersOrMembersWithDisplayNames +The IncludeBypassModerationFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of BypassModerationFromSendersOrMembers recipients in the BypassModerationFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, BypassModerationFromSendersOrMembers recipients are shown as GUIDs and the BypassModerationFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeGrantSendOnBehalfToWithDisplayNames +The IncludeGrantSendOnBehalfToWithDisplayNames switch specifies whether to return the SMTP addresses and display names of GrantSendOnBehalfTo recipients in the GrantSendOnBehalfToWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, GrantSendOnBehalfTo recipients are shown as GUIDs and the GrantSendOnBehalfToWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeModeratedByWithDisplayNames +The IncludeModeratedByWithDisplayNames switch specifies whether to return the SMTP addresses and display names of ModeratedBy recipients in the ModeratedByWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the ModeratedByWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeRejectMessagesFromSendersOrMembersWithDisplayNames +The IncludeRejectMessagesFromSendersOrMembersWithDisplayNames switch specifies whether to return the SMTP addresses and display names of RejectMessagesFromSendersOrMembers recipients in the RejectMessagesFromSendersOrMembersWithDisplayNames property. You don't need to specify a value with this switch. + +This switch was introduced to restore human-readable identifiers in the results of the cmdlet. If you don't use this switch, ModeratedBy recipients are shown as GUIDs and the RejectMessagesFromSendersOrMembersWithDisplayNames property is empty. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,7 +285,7 @@ Soft-deleted Microsoft 365 Groups are deleted groups that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -203,7 +301,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -227,7 +325,7 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -241,12 +339,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md index 39b8ce4e02..e47851e9e1 100644 --- a/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Get-UnifiedGroupLinks.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-unifiedgrouplinks -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-unifiedgrouplinks +applicable: Exchange Online, Exchange Online Protection title: Get-UnifiedGroupLinks schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Get-UnifiedGroupLinks cmdlet to view membership and ownership information for Microsoft 365 Groups in your cloud-based organization. To view other properties for Microsoft 365 Groups, use the Get-UnifiedGroup cmdlet. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +29,7 @@ Get-UnifiedGroupLinks [-Identity] -LinkType ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +56,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to view. Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -68,18 +66,17 @@ Accept wildcard characters: False ``` ### -LinkType -The LinkType parameter specifies the Microsoft 365 Group property that you want to view. Valid values are: +The LinkType parameter filters the results by recipient roles in the Microsoft 365 Group. Valid values are: -- Aggregators -- Members -- Owners -- Subscribers +- Members: Participate in conversations, create Teams channels, collaborate on files, and edit the connected SharePoint site. +- Owners: Add or remove members, delete conversations, changes Team settings, delete the Team, and full control of the connected SharePoint site. A group must have at least one owner. +- Subscribers: Members who receive conversation and calendar event notifications from the group. All subscribers are members of the group, but all members aren't necessarily subscribers (depending on the AutoSubscribeNewMembers property value of the group and when the member was added). ```yaml Type: LinkType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -95,7 +92,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -109,12 +106,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UrlTrace.md b/exchange/exchange-ps/exchange/Get-UrlTrace.md deleted file mode 100644 index a3521c3473..0000000000 --- a/exchange/exchange-ps/exchange/Get-UrlTrace.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-urltrace -applicable: Exchange Online, Exchange Online Protection -title: Get-UrlTrace -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-UrlTrace - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Get-UrlTrace cmdlet to view the results of Safe Links actions in your cloud-based organization. Currently, the date range can't be more than seven days. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-UrlTrace - [-ClickId ] - [-EndDate ] - [-Page ] - [-PageSize ] - [-RecipientAddress ] - [-StartDate ] - [-UrlOrDomain ] - [-Workloads ] - [] -``` - -## DESCRIPTION -Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. For more information about Safe Links protection, see [Safe Links in Microsoft Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links). - -For the reporting period you specify, the cmdlet returns the following information: - -- Time Clicked: The date/time when the URL in the message body was clicked. Every analyzed URL click is recorded, even when a user clicks a URL in an existing message that's already been scanned. -- Workload -- Application Name -- Message ID -- Message Trace ID -- Source ID -- Source Details -- ClickId: A GUID for each URL that was analyzed in a message. -- Recipient Address -- URL -- User IP Address -- UrlBlocked: The URL was detected as malicious by Safe Links (only the initial block, not subsequent clicks), or the user clicked the URL while the scan in progress (users are taken to a notification page that asks them to try again after the scan is complete). -- UrlClicked: The URL is blocked, but the applicable Safe Links policy has the DoNotAllowClickThrough parameter value $false (click through is allowed). Updated policies aren't applied to existing messages that have already been scanned. New or updated policies are applied to new messages that were received after the policy is applied to the mailbox. -- Click Action: The action of a specific click. Possible values are: - -• None: We were unable to capture the verdict for the URL. The user might have clicked through the URL. -• Allowed: The user was allowed to navigate to the URL. -• Blocked: The User was blocked from navigating to the URL. -• Pending verdict: The user was presented with the detonation pending page. -• Blocked overridden: The user was blocked from navigating to the URL; however, the user overrode the block to navigate to the URL. -• Pending verdict bypassed: The user presented with the detonation page; however, the user overrode the page to navigate to the URL. -• Error: The user was presented with the error page. This can also mean there was an error in capturing the verdict. -• Failure: There was unknown exception while capturing the verdict. The user might have clicked through the URL. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-UrlTrace -RecipientAddress "michelle@contoso.com" -StartDate "5/9/2016" -EndDate "5/11/2016" -``` - -This example returns the results of Safe Links actions during the specified time period for the user michelle@contoso.com. - -## PARAMETERS - -### -ClickId -The ClickId parameter filters the results by the URL that was scanned in the message. Each URL is represented as a GUID value. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -EndDate -The EndDate parameter specifies the end date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Page -The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize -The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecipientAddress -The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -StartDate -The StartDate parameter specifies the start date of the date range. - -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -UrlOrDomain -The UrlOrDomain parameter filters the results by the specified URL or domain value. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Workloads -The Workloads parameter filters the results by the specified workload. Valid values are: - -- Mail -- OfficeClient -- Other - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-User.md b/exchange/exchange-ps/exchange/Get-User.md index 83471a554c..3cafe8aba0 100644 --- a/exchange/exchange-ps/exchange/Get-User.md +++ b/exchange/exchange-ps/exchange/Get-User.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-user -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/get-user +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Get-User schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Get-User cmdlet to view existing user objects in your organization. This cmdlet returns all objects that have user accounts (for example, user mailboxes, mail users, and user accounts). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,6 +30,7 @@ Get-User [-Anr ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeDirectReportsWithDisplayNames] [-IsVIP] [-OrganizationalUnit ] [-PublicFolder] @@ -51,6 +52,7 @@ Get-User [[-Identity] ] [-DomainController ] [-Filter ] [-IgnoreDefaultScope] + [-IncludeDirectReportsWithDisplayNames] [-IsVIP] [-OrganizationalUnit ] [-PublicFolder] @@ -65,7 +67,7 @@ Get-User [[-Identity] ] ## DESCRIPTION The Get-User cmdlet returns no mail-related properties for mailboxes or mail users. To view the mail-related properties for a user, you need to use the corresponding cmdlet based on the object type (for example, Get-Mailbox or Get-MailUser). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,6 +101,28 @@ This example uses the Filter parameter to retrieve information about all users t ## PARAMETERS +### -Identity +The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. For example: + +- Name +- User principal name (UPN) +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -192,7 +216,7 @@ This parameter is available only in on-premises Exchange. The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -226,22 +250,22 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information about the filterable properties, see [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information about the filterable properties in Exchange server and Exchange Online, see [Filterable properties for the Filter parameter](https://learn.microsoft.com/powershell/exchange/filter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -250,42 +274,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. For example: +### -IgnoreDefaultScope +This parameter is available only in on-premises Exchange. -- Name -- Distinguished name (DN) -- Canonical DN -- GUID +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. + +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: + +- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. +- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. ```yaml -Type: UserIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreDefaultScope -This parameter is available only in on-premises Exchange. - -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +### -IncludeDirectReportsWithDisplayNames +This parameter is available only in the cloud-based service. -Using the IgnoreDefaultScope switch introduces the following restrictions: - -- You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. -- You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. +{{ Fill IncludeDirectReportsWithDisplayNames Description }} ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Identity, AnrSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,9 +318,9 @@ Accept wildcard characters: False ### -IsVIP This parameter is available only in the cloud-based service. -The IsVIP switch filters the results by priority accounts. +The IsVIP switch filters the results by priority accounts. You don't need to specify a value with this switch. -For more information about priority accounts, see [Manage and monitor priority accounts](https://docs.microsoft.com/microsoft-365/admin/setup/priority-accounts). +For more information about priority accounts, see [Manage and monitor priority accounts](https://learn.microsoft.com/microsoft-365/admin/setup/priority-accounts). ```yaml Type: SwitchParameter @@ -344,7 +365,7 @@ Public folder mailboxes are specially designed mailboxes that store the hierarch Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -356,7 +377,9 @@ Accept wildcard characters: False ### -ReadFromDomainController This parameter is available only in on-premises Exchange. -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -379,21 +402,24 @@ The RecipientTypeDetails parameter filters the results by the specified user sub - DisabledUser - DiscoveryMailbox - EquipmentMailbox -- GuestMailUser +- GuestMailUser (Exchange 2016 or later and cloud) +- GroupMailbox (Exchange 2013 only) - LegacyMailbox - LinkedMailbox +- LinkedRoomMailbox (Exchange 2013 or later and cloud) - LinkedUser - MailUser -- PublicFolderMailbox +- PublicFolderMailbox (Exchange 2013 or later and cloud) - RemoteEquipmentMailbox - RemoteRoomMailbox - RemoteSharedMailbox -- RemoteTeamMailbox +- RemoteTeamMailbox (Exchange 2013 or later and cloud) - RemoteUserMailbox - RoomMailbox -- SchedulingMailbox +- SchedulingMailbox (Exchange 2016 or later and cloud) - SharedMailbox -- TeamMailbox +- SharedWithMailUser (cloud only) +- TeamMailbox (Exchange 2013 or later and cloud) - User - UserMailbox @@ -403,7 +429,7 @@ You can specify multiple values separated by commas. Type: RecipientTypeDetails[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -419,7 +445,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -446,7 +472,7 @@ You can sort by the following properties: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -478,12 +504,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UserAnalyticsConfig.md b/exchange/exchange-ps/exchange/Get-UserAnalyticsConfig.md deleted file mode 100644 index fe5e346fe1..0000000000 --- a/exchange/exchange-ps/exchange/Get-UserAnalyticsConfig.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-useranalyticsconfig -applicable: Exchange Online -title: Get-UserAnalyticsConfig -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Get-UserAnalyticsConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -**Note**: This cmdlet has been replaced by the **Get-MyAnalyticsFeatureConfig** cmdlet in the Exchange Online PowerShell V2 module version 2.0.4 or later. For connection instructions using the module, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -Use the Get-UserAnalyticsConfig cmdlet to view the MyAnalytics privacy settings for cloud-based users. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Get-UserAnalyticsConfig -Identity - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-UserAnalyticsConfig -Identity KathleenReiter@Contoso.com -``` - -This example returns the MyAnalytics privacy setting for the user with email address KathleenReiter@Contoso.com. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the user that you want to view. You can use any value that uniquely identifies the user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md index 3fac39da34..6c04f88148 100644 --- a/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Get-UserBriefingConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-userbriefingconfig +online version: https://learn.microsoft.com/powershell/module/exchange/get-userbriefingconfig applicable: Exchange Online title: Get-UserBriefingConfig schema: 2.0.0 @@ -12,27 +12,32 @@ ms.author: chrisda # Get-UserBriefingConfig ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more details about configuring the Briefing email, see [Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin). +Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/Briefing/be-admin). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Get-UserBriefingConfig -Identity +Get-UserBriefingConfig -Identity [-ResultSize ] ``` ## DESCRIPTION -This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator - Exchange Administrator - Insights Administrator -To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. ## EXAMPLES @@ -79,14 +84,10 @@ Accept wildcard characters: False ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin) +[Configure Briefing email](https://learn.microsoft.com/Briefing/be-admin) diff --git a/exchange/exchange-ps/exchange/Get-UserPhoto.md b/exchange/exchange-ps/exchange/Get-UserPhoto.md index acec4ed0cc..5314df112d 100644 --- a/exchange/exchange-ps/exchange/Get-UserPhoto.md +++ b/exchange/exchange-ps/exchange/Get-UserPhoto.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-userphoto -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/get-userphoto +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-UserPhoto schema: 2.0.0 author: chrisda @@ -12,11 +12,13 @@ ms.reviewer: # Get-UserPhoto ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. -Use the Get-UserPhoto cmdlet to view information about the user photos feature that allows users to associate a picture with their account. User photos appear in on-premises and cloud-based client applications, such as Outlook on the web, Lync, Skype for Business and SharePoint. +Use the Get-UserPhoto cmdlet to view information about the user photos feature that allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: In Microsoft 365, you can manage user photos in Microsoft Graph PowerShell. For instructions, see [Manage user photos in Microsoft Graph PowerShell](https://learn.microsoft.com/microsoft-365/admin/add-users/change-user-profile-photos#manage-user-photos-in-microsoft-graph-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -57,7 +59,7 @@ Get-UserPhoto [[-Identity] ] ## DESCRIPTION The user photos feature allows users to associate a picture with their account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox. The user photo feature must be set for a user before you can run the Get-UserPhoto cmdlet to view information about the user's photo. Otherwise, you get an error message saying the user photo doesn't exist for the specified users. Administrators use the Set-UserPhoto cmdlet or the Exchange admin center (EAC) to configure user photos. Users can upload, preview, and save a user photo to their account by using the Outlook on the web Options page. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -77,6 +79,33 @@ This example displays information about the user photo that was uploaded to Pila ## PARAMETERS +### -Identity +The Identity parameter specifies the user account. You can use any value that uniquely identifies the user account. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Anr The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: @@ -90,7 +119,7 @@ The Anr parameter specifies a string on which to perform an ambiguous name resol Type: String Parameter Sets: AnrSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -102,13 +131,13 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the username and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,8 +147,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -136,22 +163,22 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -167,7 +194,7 @@ The GroupMailbox switch is required to return Microsoft 365 Groups in the result Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -176,37 +203,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the user account. You can use any value that uniquely identifies the user account. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -215,7 +215,7 @@ Using the IgnoreDefaultScope switch introduces the following restrictions: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -236,7 +236,7 @@ The OrganizationalUnit parameter filters the results based on the object's locat Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -252,7 +252,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -270,7 +270,7 @@ A preview photo is a photo that was uploaded to the user's account, but wasn't s Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,7 +280,9 @@ Accept wildcard characters: False ``` ### -ReadFromDomainController -The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. If you run the command Set-AdServerSettings -ViewEntireForest $true to include all objects in the forest and you don't use the ReadFromDomainController switch, it's possible that information will be read from a global catalog that has outdated information. When you use the ReadFromDomainController switch, multiple reads might be necessary to get the information. You don't have to specify a value with this switch. +The ReadFromDomainController switch specifies that information should be read from a domain controller in the user's domain. You don't need to specify a value with this switch. + +The command: `Set-AdServerSettings -ViewEntireForest $true` to include all objects in the forest requires the ReadFromDomainController switch. Otherwise, the command might use a global catalog that contains outdated information. Also, you might need to run multiple iterations of the command with the ReadFromDomainController switch to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers. @@ -288,7 +290,7 @@ By default, the recipient scope is set to the domain that hosts your Exchange se Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -304,7 +306,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -324,7 +326,7 @@ You can sort by the Id property. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -338,12 +340,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md b/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md index b0a2bfc42c..b9afdf3095 100644 --- a/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md +++ b/exchange/exchange-ps/exchange/Get-UserPrincipalNamesSuffix.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-userprincipalnamessuffix +online version: https://learn.microsoft.com/powershell/module/exchange/get-userprincipalnamessuffix applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-UserPrincipalNamesSuffix schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-UserPrincipalNamesSuffix cmdlet to view the user principal name (UPN) suffixes in the Active Directory forest. The UPN suffixes are created in Active Directory Domains and Trusts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ The default UPN is contained in the Canonical Name attribute on the Partitions c If you create user accounts by using Active Directory Users and Computers, every user must have a UPN. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,12 +71,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md index e5ddbbc46d..bbfd395ab1 100644 --- a/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md +++ b/exchange/exchange-ps/exchange/Get-VivaInsightsSettings.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/get-vivainsightssettings +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivainsightssettings applicable: Exchange Online title: Get-VivaInsightsSettings schema: 2.0.0 @@ -12,36 +12,42 @@ ms.author: chrisda # Get-VivaInsightsSettings ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is available only in version 2.0.5-Preview2 or later of the EXO V2 module. +**Note**: This cmdlet is available only in version 2.0.5 or later of the module. Use the Get-VivaInsightsSettings cmdlet to check whether a user has access to features in Microsoft Viva Insights in Microsoft Teams. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Get-VivaInsightsSettings -Identity + [-Feature ] [-ResultSize ] [] ``` ## DESCRIPTION -This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator - Exchange Administrator - Teams Administrator -To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. ## EXAMPLES ### Example 1 ```powershell -PS C:\> Get-VivaInsightsSettings -Identity roy@contoso.onmicrosoft.com +Get-VivaInsightsSettings -Identity roy@contoso.onmicrosoft.com UserId : roy@contoso.onmicrosoft.com IsInsightsHeadspaceEnabled : True @@ -67,6 +73,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Feature +The Feature parameter filters the results by the specified Microsoft Viva Insights feature. Valid values are: + +- Headspace: Represents all features of Headspace. +- MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResultSize This parameter is reserved for internal Microsoft use. @@ -88,12 +113,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md new file mode 100644 index 0000000000..b2787501f8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeature.md @@ -0,0 +1,123 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeature +applicable: Exchange Online +title: Get-VivaModuleFeature +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaModuleFeature + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls. This cmdlet provides details about the features, including the feature identifiers and descriptions. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-VivaModuleFeature -ModuleId + [[-FeatureId] ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaModuleFeature cmdlet to view the features in a Viva module that support feature access controls. + +You can view all features in a particular Viva module that support feature access controls. To view a specific feature, you can include the FeatureId parameter. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeature -ModuleId VivaInsights +``` + +This example returns all features in Viva Insights that support feature access controls. + +### Example 2 +```powershell +Get-VivaModuleFeature -ModuleId VivaInsights -FeatureId Reflection +``` + +This example returns the details of the Reflection feature in Viva Insights. + +## PARAMETERS + +### -ModuleId +The ModuleId parameter specifies the Viva module of the features that you want to view. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureId +The FeatureId parameter specifies the specific feature in the Viva module that you want to view. + +You can view details about all the features in a Viva module that support feature access controls by running the cmdlet without the FeatureId parameter. These details include the identifiers of all features in a Viva module that support feature access controls. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Positional +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md new file mode 100644 index 0000000000..8fed8e655e --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeatureEnablement.md @@ -0,0 +1,145 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeatureenablement +applicable: Exchange Online +title: Get-VivaModuleFeatureEnablement +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaModuleFeatureEnablement + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. Whether or not the feature is enabled is referred to as the feature's "enablement state". The enablement state returned by this cmdlet is based on the access policies set by the admin. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-VivaModuleFeatureEnablement -FeatureId -Identity -ModuleId + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaModuleFeatureEnablement cmdlet to view whether or not a feature in a Viva module is enabled for a specific user or group. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role to run this cmdlet. + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity user@contoso.com +``` + +This example returns the enablement state of the Reflection feature in Viva Insights for the **user@contoso.com** user. + +### Example 2 +```powershell +Get-VivaModuleFeatureEnablement -ModuleId VivaInsights -FeatureId Reflection -Identity group@contoso.com +``` + +This example returns the enablement state of the Reflection feature in Viva Insights for the **group@contoso.com** group. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module. + +To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Type: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity +The Identity parameter specifies the user principal name (UPN) of the user or the SMTP address (email address) of the group that you want to view the feature enablement status of. + +[Mail-enabled Microsoft Entra groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Type: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Type: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Type: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..1e4a57e8a1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaModuleFeaturePolicy.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivamodulefeaturepolicy +applicable: Exchange Online +title: Get-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. Policies are used to restrict or grant access to the specified feature for specific users, groups, or the entire tenant. This cmdlet provides details about the policies, including the policy's identifier, name, and creation date. The cmdlet can filter policies based on MemberIds, allowing admins to view policies specific to certain users or groups. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### FeaturePolicy +``` +Get-VivaModuleFeaturePolicy -FeatureId -ModuleId [[-PolicyId] ] + [-ResultSize ] + [] +``` + +### FeaturePolicyWithMembers +``` +Get-VivaModuleFeaturePolicy -ModuleId [[-FeatureId] ] [[-MemberIds] ] + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaModuleFeaturePolicy cmdlet to view the access policies for a specified feature in a Viva module in Viva. + +You can view all policies for a specified feature in a Viva module in Viva. To view a specific policy, you can include the PolicyId parameter. + +The cmdlet can filter policies based on MemberIds, allowing admins to view policies specific to certain users or groups. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role or the roles that have been assigned at the feature level to run this cmdlet. + +To learn more about assigned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management). + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection +``` + +This example returns details about all the policies added for the Reflection feature in Viva Insights. + +### Example 2 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b +``` + +This example returns details about a specific policy added for the Reflection feature in Viva Insights. + +### Example 3 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -MemberIds user1@contoso.com +``` + +This example returns details about the policies for the Reflection feature in Viva Insights that apply to the user with the email user1@contoso.com. + +### Example 4 +```powershell +Get-VivaModuleFeaturePolicy -ModuleId * -FeatureId * -MemberIds user1@contoso.com,group1@contoso.com +``` + +This example returns details about the policies for all features across all Viva modules that apply to the user with the email user1@contoso.com and the group with the email group1@contoso.com. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to view the policies for. + +To view details about the features in a Viva module that support feature access controls, refer to the Get-VivaModuleFeature cmdlet. The details provided by the Get-VivaModuleFeature cmdlet include the feature identifier. + +```yaml +Type: String +Parameter Sets: FeaturePolicy +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: FeaturePolicyWithMembers +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: True +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module of the feature policies that you want to view. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the specific policy for the feature in the Viva module that you want to view. + +To view details about all policies for a feature in a Viva module, run this cmdlet without the PolicyId parameter. These details include the identifiers of all the policies for a feature in a Viva module. + +```yaml +Type: String +Parameter Sets: FeaturePolicy +Aliases: +Applicable: Exchange Online + +Required: False +Position: Positional +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MemberIds +The MemberIds parameter specifies the specific users or groups for which you want to view the policies for the feature in the Viva module. + +You can provide up to three member IDs. Use the \* character to specify all modules or features. + +```yaml +Type: String[] +Parameter Sets: FeaturePolicyWithMembers +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..22defddf64 --- /dev/null +++ b/exchange/exchange-ps/exchange/Get-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,94 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/get-vivaorginsightsdelegatedrole +title: Get-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Get-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Get-VivaOrgInsightsDelegatedRole cmdlet to view all delegates of the specified delegator. Delegate accounts can view organizational insights like the specified delegator. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Get-VivaOrgInsightsDelegatedRole -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +Typically, you use this cmdlet with the Remove-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of the delegate accounts. + +To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Get-VivaOrgInsightsDelegatedRole -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example filters the results by the specified delegator. + +## PARAMETERS + +### -Delegator +The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is given to delegates. + +A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md index efae6a3f1b..1345ae232f 100644 --- a/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Get-WebServicesVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-webservicesvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/get-webservicesvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-WebServicesVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-WebServicesVirtualDirectory cmdlet to view Exchange Web Services (EWS) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ The Get-WebServicesVirtualDirectory cmdlet can be run on a local server or run r The Get-WebServicesVirtualDirectory cmdlet can be run on any server that has the Exchange administration tools installed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,7 +118,9 @@ Accept wildcard characters: False ``` ### -ADPropertiesOnly -The ADPropertiesOnly switch specifies whether to return only the properties about the virtual directory stored in Active Directory. The properties stored in the Internet Information Services (IIS) metabase aren't returned. +The ADPropertiesOnly switch specifies whether to return only the virtual directory properties that are stored in Active Directory. You don't need to specify a value with this switch. + +If you don't use this switch, the properties in Active Directory and in the Internet Information Services (IIS) metabase are returned. ```yaml Type: SwitchParameter @@ -174,12 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md index a5a4819504..3be7ea0728 100644 --- a/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/exchange/Get-X400AuthoritativeDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-x400authoritativedomain +online version: https://learn.microsoft.com/powershell/module/exchange/get-x400authoritativedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Get-X400AuthoritativeDomain schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Get-X400AuthoritativeDomain cmdlet to view the configuration information for the X.400 authoritative domains configured in your organization. For more information about how to configure an X.400 authoritative domain, see [Set-X400AuthoritativeDomain](https://docs.microsoft.com/powershell/module/exchange/set-x400authoritativedomain). +Use the Get-X400AuthoritativeDomain cmdlet to view the configuration information for the X.400 authoritative domains configured in your organization. For more information about how to configure an X.400 authoritative domain, see [Set-X400AuthoritativeDomain](https://learn.microsoft.com/powershell/module/exchange/set-x400authoritativedomain). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,7 @@ Get-X400AuthoritativeDomain [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -40,37 +40,37 @@ This example displays detailed information about the X.400 authoritative domain ## PARAMETERS -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. - -The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. +### -Identity +The Identity parameter specifies a string value for the X.400 authoritative domain. Enter either the GUID or the name of the remote domain. ```yaml -Type: Fqdn +Type: X400AuthoritativeDomainIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies a string value for the X.400 authoritative domain. Enter either the GUID or the name of the remote domain. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data. ```yaml -Type: X400AuthoritativeDomainIdParameter +Type: Fqdn Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -79,12 +79,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md index 5b95cfc2ab..2af5f1721a 100644 --- a/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Get-eDiscoveryCaseAdmin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/get-ediscoverycaseadmin -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/get-ediscoverycaseadmin +applicable: Security & Compliance title: Get-eDiscoveryCaseAdmin schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Get-eDiscoveryCaseAdmin ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Get-eDiscoveryCaseAdmin cmdlet to view eDiscovery Administrators in the Microsoft 365 compliance center. An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. +Use the Get-eDiscoveryCaseAdmin cmdlet to view eDiscovery Administrators in the Microsoft Purview compliance portal. An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Get-eDiscoveryCaseAdmin [-DomainController ] ## DESCRIPTION To add or remove individual eDiscovery Administrators, use the Add-eDiscoveryCaseAdmin and Remove-eDiscoveryCaseAdmin cmdlets. To replace all existing eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -49,7 +49,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -65,7 +65,7 @@ The ResultSize parameter specifies the maximum number of results to return. If y Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -79,12 +79,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Import-ContactList.md b/exchange/exchange-ps/exchange/Import-ContactList.md deleted file mode 100644 index 24ab5a847e..0000000000 --- a/exchange/exchange-ps/exchange/Import-ContactList.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-contactlist -applicable: Exchange Online -title: Import-ContactList -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Import-ContactList - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Import-ContactList cmdlet and a .csv file to import a user's mail contacts to a cloud-based mailbox. Users can use an email client to export their contacts to a .csv file that is formatted for Microsoft Office Outlook. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -### Data -``` -Import-ContactList [-Identity] -CSVData - [-CSV] - [-Confirm] - [-DateCultureName ] - [-WhatIf] - [] -``` - -### Stream -``` -Import-ContactList [-Identity] -CSVStream - [-CSV] - [-Confirm] - [-DateCultureName ] - [-WhatIf] - [] -``` - -## DESCRIPTION -The Import-ContactList cmdlet submits a request to import a list of mail contacts that are contained in a .csv file to a cloud-based mailbox. Many MAPI and Web-based email clients allow users to export contacts to a Microsoft Office Outlook .csv format. Users can then provide that .csv file to you to import contacts to their cloud-based mailbox. During the import process, Microsoft Exchange matches the column names in the header row of the .csv file to the property names of an Exchange contact. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Import-ContactList -CSV -CSVData ([System.IO.File]::ReadAllBytes("D:\Users\Administrator\Desktop\TerryAdams.csv")) -DateCultureName "en-GB" -Identity terrya@contoso.edu -``` - -This example imports a list of contacts in a .csv file named TerryAdams.csv to a mailbox for a user whose email address is terrya@contoso.edu. The date fields are parsed using the date format of "en-GB" locale (dd/MM/YYYY). - -## PARAMETERS - -### -Identity -The Identity parameter specifies the target mailbox to which the contacts are imported. You can use any value that uniquely identifies the mailbox. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -```yaml -Type: MailboxIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CSV -The CSV parameter simply specifies that the contacts will be imported from a .csv file. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CSVData -The CSVData parameter specifies the .csv file you want to import. Use the following syntax for this parameter: `([System.IO.File]::ReadAllBytes(""))`. For example, `([System.IO.File]::ReadAllBytes("C:\My Documents\Contacts.csv"))`. - -```yaml -Type: Byte[] -Parameter Sets: Data -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CSVStream -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Stream -Parameter Sets: Stream -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateCultureName -The DateCultureName parameter specifies the culture to use for parsing date fields (e.g. Birthday and Anniversary). For example, setting the parameter to "en-GB" would lead to 01/02/2018 being parsed as February 1st, 2018, whereas setting it to "en-US" would lead to the same date being parsed as January 2nd, 2018. If the parameter is not provided, the culture of the current user is assumed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md b/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md index 9d4f2f5a26..bdec677fd8 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md +++ b/exchange/exchange-ps/exchange/Import-DlpPolicyCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-dlppolicycollection +online version: https://learn.microsoft.com/powershell/module/exchange/import-dlppolicycollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Import-DlpPolicyCollection schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Import-DlpPolicyCollection ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: This cmdlet has been retired from the cloud-based service. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/exchange-online-etrs-to-stop-supporting-dlp-policies/ba-p/3886713). -Use the Import-DlpPolicyCollection cmdlet to import data loss prevention (DLP) policy collections into your organization. +This cmdlet is functional only in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the Import-DlpPolicyCollection cmdlet to import data loss prevention (DLP) policy collections that are based on transport rules (mail flow rules) into your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,13 +36,13 @@ The Import-DlpPolicyCollection cmdlet imports all the settings of the DLP polici Importing a DLP policy collection from an XML file removes or overwrites all pre-existing DLP policies that were defined in your organization. Make sure that you have a backup of your current DLP policy collection before you import and overwrite your current DLP policies. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Import-DlpPolicyCollection -FileData ([Byte[]]$(Get-Content -Path " C:\My Documents\DLP Backup.xml " -Encoding Byte -ReadCount 0)) +Import-DlpPolicyCollection -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\DLP Backup.xml')) ``` This example imports the DLP policy collection in the file C:\\My Documents\\DLP Backup.xml. @@ -66,7 +68,7 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the DLP policy collection file you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -101,8 +103,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -119,7 +119,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -155,12 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md index c5c9e246ce..41752441f8 100644 --- a/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/exchange/Import-DlpPolicyTemplate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-dlppolicytemplate +online version: https://learn.microsoft.com/powershell/module/exchange/import-dlppolicytemplate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Import-DlpPolicyTemplate schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Import-DlpPolicyTemplate cmdlet to import a data loss prevention (DLP) policy template file into your Exchange organization. +Use the Import-DlpPolicyTemplate cmdlet to import data loss prevention (DLP) policy template files that are based on transport rules (mail flow rules) into your Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,13 +28,13 @@ Import-DlpPolicyTemplate [-FileData] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Import-DlpPolicyTemplate -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External DLP Policy Template.xml" -Encoding Byte -ReadCount 0)) +Import-DlpPolicyTemplate -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External DLP Policy Template.xml')) ``` This example imports the DLP policy template file C:\\My Documents\\External DLP Policy Template.xml. @@ -44,7 +44,7 @@ This example imports the DLP policy template file C:\\My Documents\\External DLP ### -FileData The FileData parameter specifies the DLP policy template file you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -99,12 +99,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md index caac5d0776..f9175f98ff 100644 --- a/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Import-ExchangeCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-exchangecertificate +online version: https://learn.microsoft.com/powershell/module/exchange/import-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Import-ExchangeCertificate schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Import-ExchangeCertificate cmdlet to import certificates on Exchange servers. You use this cmdlet to install certificates that were exported from other servers, and to complete pending certification requests (also known as certificate signing requests or CSRs) from certification authorities (CAs). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,29 +62,38 @@ Import-ExchangeCertificate -FileName ## DESCRIPTION You can use the Import-ExchangeCertificate cmdlet to import the following types of certificate files on an Exchange server: -- APKCS #7 certificate or chain of certificates file (.p7b or .p7c) that was issued by a certification authority (CA). PKCS #7 is the Cryptographic Message Syntax Standard, a syntax used for digitally signing or encrypting data using public key cryptography, including certificates. For more information, see [PKCS #7 Cryptographic Messaging Syntax Concepts](https://docs.microsoft.com/windows/win32/seccrypto/pkcs--7-concepts). +- APKCS #7 certificate or chain of certificates file (.p7b or .p7c) that was issued by a certification authority (CA). PKCS #7 is the Cryptographic Message Syntax Standard, a syntax used for digitally signing or encrypting data using public key cryptography, including certificates. For more information, see [PKCS #7 Cryptographic Messaging Syntax Concepts](https://learn.microsoft.com/windows/win32/seccrypto/pkcs--7-concepts). - A PKCS #12 certificate file (.cer, .crt, .der, .p12, or .pfx) that contains the private key. PKCS #12 is the Personal Information Exchange Syntax Standard, a file format used to store certificates with corresponding private keys that are protected by a password. For more information, see [PKCS #12: Personal Information Exchange Syntax v1.1](https://tools.ietf.org/html/rfc7292). After you import a certificate on an Exchange server, you need to assign the certificate to one or more Exchange services by using the Enable-ExchangeCertificate cmdlet. -There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://docs.microsoft.com/Exchange/architecture/client-access/certificates). +There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/certificates). -Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out [Protecting you against the SSL 3.0 vulnerability](https://blogs.office.com/2014/10/29/protecting-ssl-3-0-vulnerability/). +Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). For more information, see [Exchange Server TLS configuration best practices](https://learn.microsoft.com/Exchange/exchange-tls-configuration). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Import-ExchangeCertificate -Server Mailbox01 -FileName "\\FileServer01\Data\Exported Fabrikam Cert.pfx" -Password (ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force) +Import-ExchangeCertificate -Server Mailbox01 -FileName "\\FileServer01\Data\Exported Fabrikam Cert.pfx" -Password (Get-Credential).password ``` -This example imports the certificate from the PKCS #12 file from \\\\FileServer01\\Data\\Exported Fabrikam Cert.pfx to the Exchange server named Mailbox01. This file requires the password P@ssw0rd1. This certificate could have been exported from another server, or issued by a certification authority. +In **Exchange 2013**, this example imports the certificate from the PKCS #12 file from \\\\FileServer01\\Data\\Exported Fabrikam Cert.pfx to the Exchange server named Mailbox01. This file requires the password of the file. This certificate could have been exported from another server or issued by a certification authority. + +To export the certificate in Exchange 2016 or Exchange 2019, use the FileData parameter as described in Example 2. ### Example 2 ```powershell -Import-ExchangeCertificate -FileData ([Byte[]](Get-Content -Path "C:\Certificates\Fabrikam IssuedCert.p7b" -Encoding byte -ReadCount 0)) +Import-ExchangeCertificate -Server Mailbox01 -FileData ([System.IO.File]::ReadAllBytes('\\FileServer01\Data\Exported Fabrikam Cert.pfx')) -Password (Get-Credential).password +``` + +This example imports the same certificate file from Example 1. This method is required in Exchange 2016 and Exchange 2019 because the FileName parameter is not available. + +### Example 3 +```powershell +Import-ExchangeCertificate -FileData ([System.IO.File]::ReadAllBytes('C:\Certificates\Fabrikam IssuedCert.p7b')) ``` This example imports a chain of certificates from the PKCS #7 file C:\\Certificates\\Fabrikam IssuedCert.p7b on the local Exchange server. @@ -92,12 +101,14 @@ This example imports a chain of certificates from the PKCS #7 file C:\\Certifica ## PARAMETERS ### -FileData -The FileData parameter specifies the contents of the certificate file that you want to import. Typically, you use this parameter for PKCS #7 text certificate files that have .p7b or .p7c filename extensions. These text files contain the text: -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- or -----BEGIN PKCS7----- and -----END PKCS7-----. +The FileData parameter specifies the contents of the certificate file that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\Server\Share`). +When you use this parameter to import PKCS #7 text certificate files, these files contain contain: -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- or -----BEGIN PKCS7----- and -----END PKCS7----- and have .p7b or .p7c filename extensions. + If the value contains spaces, enclose the value in quotation marks ("). ```yaml @@ -113,6 +124,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FileName +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To import a certificate file without using the FileName parameter, use the FileData parameter. + +This parameter is available only in Exchange 2013. + +The FileName parameter specifies the certificate file that you want to import. Typically, you use this parameter for PKCS #12 binary certificate files that have .cer, .crt, .der, .p12, or .pfx filename extensions. This type of binary certificate file is protected by a password when the file contains the private key or chain of trust. + +You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\Server\Share`). + +If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: Instance +Aliases: +Applicable: Exchange Server 2013 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance This parameter has been deprecated and is no longer used. @@ -187,7 +222,11 @@ Accept wildcard characters: False ### -Password The Password parameter specifies the password that's required to import the certificate. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString @@ -260,37 +299,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileName -The FileName parameter specifies the certificate file that you want to import. Typically, you use this parameter for PKCS #12 binary certificate files that have .cer, .crt, .der, .p12, or .pfx filename extensions. This type of binary certificate file is protected by a password when the file contains the private key or chain of trust. - -You can use a local path if the certificate file is located on the Exchange server where you're running the command, and this is the same server where you want to install the certificate. Otherwise, use a UNC path (`\\Server\Share`). - -If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Import-FilePlanProperty.md b/exchange/exchange-ps/exchange/Import-FilePlanProperty.md index 0ddbde04f2..0a64f7f630 100644 --- a/exchange/exchange-ps/exchange/Import-FilePlanProperty.md +++ b/exchange/exchange-ps/exchange/Import-FilePlanProperty.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-fileplanproperty -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/import-fileplanproperty +applicable: Security & Compliance title: Import-FilePlanProperty schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Import-FilePlanProperty ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Import-FilePlanProperty cmdlet to import file plan properties. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Import-FilePlanProperty [-RawCsv] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -48,7 +48,7 @@ The RawCsv parameter specifies the CSV file to import. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -67,7 +67,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -83,7 +83,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -93,13 +93,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,7 +117,7 @@ The ValidateOnly switch validates the CSV file without importing. You don't need Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -125,13 +127,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -145,12 +147,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md b/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md index 98d2827b22..535e6e67f0 100644 --- a/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md +++ b/exchange/exchange-ps/exchange/Import-JournalRuleCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-journalrulecollection +online version: https://learn.microsoft.com/powershell/module/exchange/import-journalrulecollection applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Import-JournalRuleCollection schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Import-JournalRuleCollection cmdlet to import journal rules from an XML file. You can import a journal rule collection you previously exported as a backup, or import rules you exported from an older version of Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,23 +33,18 @@ The Import-JournalRuleCollection cmdlet imports a journal rule collection you pr Importing a journal rule collection from an XML file removes or overwrites all pre-existing journal rules in your organization. Make sure that you have a backup of your current journal rule collection before you import and overwrite your current journal rules. -Importing file data is a two-step process. First you must load the data to a variable using the Get-Content cmdlet, and then use that variable to transmit the data to the cmdlet. +For more information about how to export a journal rule collection to an XML file, see [Export-JournalRuleCollection](https://learn.microsoft.com/powershell/module/exchange/export-journalrulecollection). -For more information about how to export a journal rule collection to an XML file, see [Export-JournalRuleCollection](https://docs.microsoft.com/powershell/module/exchange/export-journalrulecollection). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -[Byte[]]$Data = Get-Content -Path "C:\JournalRules\ExportedJournalRules.xml" -Encoding Byte -ReadCount 0 -Import-JournalRuleCollection -FileData $Data +Import-JournalRuleCollection -FileData ([System.IO.File]::ReadAllBytes('C:\JournalRules\ExportedJournalRules.xml')) ``` -This example imports journal rules from the XML file ExportedJournalRules.xml in a two-step process. - -The first step retrieves journal rules from the previously exported XML file ExportedJournalRules.xml using the Get-Content cmdlet, and then stores the results in the variable $Data. The second step retrieves data from the variable $Data and imports journal rules to your organization, overwriting existing journal rules. +This example imports journal rules from the XML file named ExportedJournalRules.xml in the C:\\JournalRules folder. ## PARAMETERS @@ -70,9 +65,9 @@ Accept wildcard characters: False ``` ### -FileData -The FileData parameter specifies the variable name that contains the content of the XML file. +The FileData parameter specifies the XML file that contains the exported journal rule collection from the Export-JournalRuleCollection cmdlet. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -143,12 +138,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Import-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/Import-RMSTrustedPublishingDomain.md deleted file mode 100644 index dc8462ce8f..0000000000 --- a/exchange/exchange-ps/exchange/Import-RMSTrustedPublishingDomain.md +++ /dev/null @@ -1,325 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-rmstrustedpublishingdomain -applicable: Exchange Online -title: Import-RMSTrustedPublishingDomain -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Import-RMSTrustedPublishingDomain - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -**Note**: This cmdlet has been deprecated and is no longer used. - -Use the Import-RMSTrustedPublishingDomain cmdlet to import a trusted publishing domain (TPD) from an on-premises server running Active Directory Rights Management Services (AD RMS) or from RMS Online into your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -### IntranetLicensingUrl -``` -Import-RMSTrustedPublishingDomain [-Name] -ExtranetLicensingUrl -FileData -IntranetLicensingUrl -Password - [-Confirm] - [-Default] - [-WhatIf] - [] -``` - -### ImportFromFile -``` -Import-RMSTrustedPublishingDomain [-Name] -ExtranetLicensingUrl -FileData -IntranetLicensingUrl -Password - [-ExtranetCertificationUrl ] - [-IntranetCertificationUrl ] - [-Confirm] - [-Default] - [-WhatIf] - [] -``` - -### RefreshTemplates -``` -Import-RMSTrustedPublishingDomain [-Name] -FileData -Password - [-RefreshTemplates] - [-Confirm] - [-Default] - [-WhatIf] - [] -``` - -### RMSOnline -``` -Import-RMSTrustedPublishingDomain [-Name] - [-RMSOnline] - [-RefreshTemplates] - [-Confirm] - [-Default] - [-WhatIf] - [] -``` - -## DESCRIPTION -A TPD contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. After you export the TPD from an on-premises AD RMS server to an XML file, you can import the XML file into your cloud-based organization. - -If the InternalLicensingEnabled parameter value is $true on the Set-IRMConfiguration cmdlet, all TPDs require a private key. If the InternalLicensingEnabled parameter value is $false, TPDs don't require a private key. However, the only RMS feature available to the organization is Outlook protection rules. Typically, TPDs without private keys are created when the AD RMS server uses a hardware-based cryptographic service provider (CSP) or a custom CSP. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Import-RMSTrustedPublishingDomain -Name "Contoso TPD" -FileData $([byte[]](Get-Content -Encoding byte -Path "C:\My Documents\Contoso.xml" -ReadCount 0)) -Password (ConvertTo-SecureString -String 'Pa$$word1' -AstPlainText -Force)-ExtranetLicensingUrl https://rms.contoso.com/_wmcs/licensing -IntranetLicensingUrl https://RMS01/_wmcs/licensing -``` - -This example imports a TPD from an AD RMS server into a cloud-based organization. The TPD uses the following values: - -- Path to exported XML file: C:\\My Documents\\Contoso.xml -- Password of exported XML file: Pa$$word1 -- External licensing URL: `https://rms.contoso.com/_wmcs/licensing` -- Internal licensing URL: `https://RMS01/_wmcs/licensing` -- TPD name: Contoso TPD - -## PARAMETERS - -### -ExtranetLicensingUrl -The ExtranetLicensingUrl parameter specifies the external licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. - -By default, the value of the ExtranetLicensingUrl parameter is `https:///_wmcs/licensing`. - -```yaml -Type: Uri -Parameter Sets: IntranetLicensingUrl, ImportFromFile -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileData -The FileData parameter specifies the XML file you want to import. The XML file contains the TPD you exported from the on-premises AD RMS server. - -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. - -```yaml -Type: Byte[] -Parameter Sets: IntranetLicensingUrl, ImportFromFile, RefreshTemplates -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntranetLicensingUrl -The IntranetLicensingUrl parameter specifies the internal licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. - -By default, the value of the IntranetLicensingUrl parameter is `https:///_wmcs/licensing`. - -```yaml -Type: Uri -Parameter Sets: IntranetLicensingUrl, ImportFromFile -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the TPD. If you use the RefreshTemplates switch, the value must match the name of the previously imported TPD. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password of the TPD that you want to import. The password value must match the password in the XML file when you exported the TPD from the on-premises AD RMS server. - -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - -```yaml -Type: SecureString -Parameter Sets: IntranetLicensingUrl, ImportFromFile, RefreshTemplates -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RMSOnline -The RMSOnline switch specifies that the TPD is imported from RMS Online. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: RMSOnline -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -The Default switch specifies that this is the default TPD. You don't need to specify a value with this switch. - -The default TPD displays RMS templates and provides rights protection to all new content. There can be only one default TPD in an organization. - -The first TPD you import into your organization is automatically set as the default. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtranetCertificationUrl -The ExtranetCertificationUrl parameter specifies the external certification URL of the on-premises AD RMS server that's stamped into the Rights Account Certificate (RAC). The RAC establishes a user's identity in the AD RMS system, and is used to decrypt content. - -By default, the value of the ExtranetCertificationUrl parameter is `https:///_wmcs/certification/servercertification.asmx`. - -```yaml -Type: Uri -Parameter Sets: ImportFromFile -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntranetCertificationUrl -The IntranetCertificationUrl parameter specifies the internal certification URL of the on-premises AD RMS server that's stamped into the RAC. The RAC establishes a user's identity in the AD RMS system, and is used to decrypt content. - -By default, the value of the IntranetCertificationUrl parameter is `https:///_wmcs/certification/servercertification.asmx`. - -```yaml -Type: Uri -Parameter Sets: ImportFromFile -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefreshTemplates -The RefreshTemplates switch specifies whether to update the RMS templates in a previously imported TPD. You don't need to specify a value with this switch. - -When you add, modify, or remove RMS templates in a TPD on the AD RMS server, you export the updated TPD to a new XML file, and import the new XML file in your cloud-based organization. The RefreshTemplates switch uses the following rules: - -- Only the FileData, Password, and Name parameters are required. The value of the Name parameter must match the name of the previously imported TPD. -- If the new XML file doesn't contain an RMS template that was defined in the previously imported TPD, the RMS template is removed from the cloud-based organization. -- If the new XML file contains an updated RMS template that was defined in the previously imported TPD, the RMS template settings are updated in the cloud-based organization. However, the RMS template isn't changed from Archived to Distributed or vice versa. -- If the new XML file contains an RMS template that wasn't imported in the original TPD, the RMS template is added to the cloud-based organization in the Archived state. To make the new RMS template usable, you must change its state from Archived to Distributed using the Set-RMSTemplate cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: RefreshTemplates, RMSOnline -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md index 013de79e77..3c8ed062fd 100644 --- a/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md +++ b/exchange/exchange-ps/exchange/Import-RecipientDataProperty.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-recipientdataproperty +online version: https://learn.microsoft.com/powershell/module/exchange/import-recipientdataproperty applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Import-RecipientDataProperty schema: 2.0.0 @@ -12,9 +12,11 @@ ms.reviewer: # Import-RecipientDataProperty ## SYNOPSIS -Use the Import-RecipientDataProperty cmdlet to add a picture or an audio file of a spoken name to a mailbox or contact. The picture and audio files display on the global address list property dialog box, contact card, reading pane, and meeting requests in Outlook. +Use the Import-RecipientDataProperty cmdlet to add a picture or a spoken name audio file to a mailbox or mail contact. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: Profile cards across Microsoft apps and services don't support imported pictures for mail contacts. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,22 +41,20 @@ Import-RecipientDataProperty [-Identity] -FileDa ``` ## DESCRIPTION -Importing and exporting files require a specific syntax because importing and exporting use Remote PowerShell. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Import-RecipientDataProperty -Identity "Tony Smith" -SpokenName -FileData ([Byte[]]$(Get-Content -Path "M:\AudioFiles\TonySmith.wma" -Encoding Byte -ReadCount 0)) +Import-RecipientDataProperty -Identity "Tony Smith" -SpokenName -FileData ([System.IO.File]::ReadAllBytes('M:\AudioFiles\TonySmith.wma')) ``` This example imports the audio file for Tony Smith's spoken name. ### Example 2 ```powershell -Import-RecipientDataProperty -Identity Ayla -Picture -FileData ([Byte[]]$(Get-Content -Path "M:\Employee Photos\AylaKol.jpg" -Encoding Byte -ReadCount 0)) +Import-RecipientDataProperty -Identity Ayla -Picture -FileData ([System.IO.File]::ReadAllBytes('M:\Employee Photos\AylaKol.jpg')) ``` This example imports the picture file for Ayla Kol. @@ -83,9 +83,13 @@ Accept wildcard characters: False ``` ### -FileData -The FileData parameter specifies the location and file name of the picture or audio file. +The FileData parameter specifies the picture or spoken name file that you want to import. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +To import a picture, use the Picture switch. A valid picture file is JPEG and less than 10 kilobytes (KB). + +To import a spoken name, use the SpokenName switch. A valid spoken name file is WMA 9 and less than 32 KB. ```yaml Type: Byte[] @@ -138,9 +142,9 @@ Accept wildcard characters: False ``` ### -Picture -The Picture switch specifies that the file you're importing is a picture file. You don't need to specify a value with this switch. +The Picture switch specifies that you're importing the user's picture file. You don't need to specify a value with this switch. -The picture must be a JPEG file and shouldn't be larger than 10 kilobytes (KB). You can't use this switch with the SpokenName switch. You can only import one file type at a time. +You can't use this switch with the SpokenName switch. ```yaml Type: SwitchParameter @@ -156,14 +160,9 @@ Accept wildcard characters: False ``` ### -SpokenName -The SpokenName switch specifies that the file you're importing is an audio file. You don't need to specify a value with this switch. - -The maximum file size should be less than 32 KB. You can use one of the following formats: - -- WMA 9-voice -- PCM 8-KHz, 16-bits, mono format +The SpokenName switch specifies that you're importing the user's spoken name file. You don't need to specify a value with this switch. -You can't use this switch with the Picture switch. You can only import one file type at a time. +You can't use this switch with the Picture switch. ```yaml Type: SwitchParameter @@ -199,12 +198,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md index f91748ca26..30fae12016 100644 --- a/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md +++ b/exchange/exchange-ps/exchange/Import-TransportRuleCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-transportrulecollection +online version: https://learn.microsoft.com/powershell/module/exchange/import-transportrulecollection applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Import-TransportRuleCollection schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Import-TransportRuleCollection ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is functional only in on-premises Exchange. Use the Import-TransportRuleCollection cmdlet to import a transport rule collection. You can import a rule collection you previously exported as a backup, or import rules that you've exported from an older version of Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: For replacement import functionality in Exchange Online using a PowerShell script, see [Import or export a mail flow rule collection in Exchange Online](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/manage-mail-flow-rules#import-or-export-a-mail-flow-rule-collection-in-exchange-online). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,28 +34,23 @@ Import-TransportRuleCollection [[-Identity] ] [-FileData] " -ReadCount 0)`. - -**Note**: In PowerShell 6.0 or later, replace `-Encoding Byte` with `-AsByteStream`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -134,7 +129,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies that the command will override any errors or warnings encountered during the import operation. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -170,12 +167,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Import-UMPrompt.md b/exchange/exchange-ps/exchange/Import-UMPrompt.md index c9c3807d72..5f34ab73ab 100644 --- a/exchange/exchange-ps/exchange/Import-UMPrompt.md +++ b/exchange/exchange-ps/exchange/Import-UMPrompt.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/import-umprompt +online version: https://learn.microsoft.com/powershell/module/exchange/import-umprompt applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Import-UMPrompt schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Import-UMPrompt cmdlet to copy or upload a custom audio file to be used by Unified Messaging (UM) dial plans and auto attendants. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -61,39 +61,38 @@ The Import-UMPrompt cmdlet imports custom greeting audio files into UM dial plan After this task is completed, the custom audio file can be used by a UM dial plan or auto attendant. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -[byte[]]$c = Get-content -Path "d:\UMPrompts\welcomegreeting.wav" -Encoding Byte -ReadCount 0 -Import-UMPrompt -UMDialPlan MyUMDialPlan -PromptFileName "welcomegreeting.wav" -PromptFileData $c +Import-UMPrompt -UMDialPlan MyUMDialPlan -PromptFileName "welcomegreeting.wav" -PromptFileData ([System.IO.File]::ReadAllBytes('D:\UMPrompts\welcomegreeting.wav')) ``` -This example imports the welcome greeting file welcomegreeting.wav from d:\\UMPrompts into the UM dial plan MyUMDialPlan. +This example imports the welcome greeting file welcomegreeting.wav from D:\\UMPrompts into the UM dial plan MyUMDialPlan. ### Example 2 ```powershell -[byte[]]$c = Get-content -Path "d:\UMPrompts\welcomegreeting.wav" -Encoding Byte -ReadCount 0 -Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "welcomegreeting.wav" -PromptFileData $c +Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "welcomegreeting.wav" -PromptFileData ([System.IO.File]::ReadAllBytes('D:\UMPrompts\welcomegreeting.wav')) ``` -This example imports the welcome greeting file welcomegreeting.wav from d:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. +This example imports the welcome greeting file welcomegreeting.wav from D:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. ### Example 3 ```powershell -[byte[]]$c = Get-content -Path "d:\UMPrompts\AfterHoursWelcomeGreeting.wav" -Encoding Byte -ReadCount 0 -Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "AfterHoursWelcomeGreeting.wav" -PromptFileData $c +Import-UMPrompt -UMAutoAttendant MyUMAutoAttendant -PromptFileName "AfterHoursWelcomeGreeting.wav" -PromptFileData ([System.IO.File]::ReadAllBytes('D:\UMPrompts\AfterHoursWelcomeGreeting.wav')) ``` -This example imports the welcome greeting file AfterHoursWelcomeGreeting.wav from d:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. +This example imports the welcome greeting file AfterHoursWelcomeGreeting.wav from D:\\UMPrompts into the UM auto attendant MyUMAutoAttendant. ## PARAMETERS ### -PromptFileData The PromptFileData parameter specifies the byte array of the custom prompt. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + ```yaml Type: Byte[] Parameter Sets: UploadDialPlanPrompts, UploadAutoAttendantPrompts @@ -227,12 +226,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Install-TransportAgent.md b/exchange/exchange-ps/exchange/Install-TransportAgent.md index addf9d205c..9e51b2aaa8 100644 --- a/exchange/exchange-ps/exchange/Install-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Install-TransportAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/install-transportagent +online version: https://learn.microsoft.com/powershell/module/exchange/install-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Install-TransportAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Install-TransportAgent cmdlet to register transport agents on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Install-TransportAgent [-Name] -AssemblyPath -TransportAgentFa ## DESCRIPTION Transport agents have full access to all email messages that they encounter. Exchange puts no restrictions on a transport agent's behavior. Transport agents that are unstable or contain security flaws may affect the stability and security of Exchange. Therefore, you need to only install transport agents that you fully trust and that have been fully tested. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -45,8 +45,8 @@ This example shows how a fictitious application named Test App is installed in t ## PARAMETERS -### -AssemblyPath -The AssemblyPath parameter specifies the location of the transport agent Microsoft.NET assembly. Universal Naming Convention (UNC) file paths can't be used. +### -Name +The Name parameter specifies the display name of the transport agent to be installed. The length of the name can't exceed 64 characters. ```yaml Type: String @@ -55,14 +55,14 @@ Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the display name of the transport agent to be installed. The length of the name can't exceed 64 characters. +### -AssemblyPath +The AssemblyPath parameter specifies the location of the transport agent Microsoft.NET assembly. Universal Naming Convention (UNC) file paths can't be used. ```yaml Type: String @@ -71,7 +71,7 @@ Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -173,12 +173,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md b/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md index 0cdfa41bff..dfc3b902a4 100644 --- a/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md +++ b/exchange/exchange-ps/exchange/Install-UnifiedCompliancePrerequisite.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/install-unifiedcomplianceprerequisite -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/install-unifiedcomplianceprerequisite +applicable: Security & Compliance title: Install-UnifiedCompliancePrerequisite schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Install-UnifiedCompliancePrerequisite ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Install-UnifiedCompliancePrerequisite cmdlet to view, create, or configure the Compliance Policy Center in Microsoft SharePoint Online. The Compliance Policy Center is a site collection that's used by the Microsoft 365 compliance center to store preservation policies that act on content in SharePoint Online sites. +Use the Install-UnifiedCompliancePrerequisite cmdlet to view, create, or configure the Compliance Policy Center in Microsoft SharePoint. The Compliance Policy Center is a site collection that's used by the Microsoft Purview compliance portal to store preservation policies that act on content in SharePoint sites. Typically, you don't need to run this cmdlet. You use this cmdlet for troubleshooting and diagnostics. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ This cmdlet returns the following information about the Compliance Policy Center - SharepointSuccessInitializedUtc: The time that the Compliance Policy Center was last initialized in coordinated universal time (UTC). - SharepointPolicyCenterSiteUrl: This value is typically `https://.sharepoint.com/sites/compliancepolicycenter`. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Install-UnifiedCompliancePrerequisite ``` -This example creates the Compliance Policy Center in SharePoint Online. If it has already been created, the command displays the current configuration information. +This example creates the Compliance Policy Center in SharePoint. If it has already been created, the command displays the current configuration information. ### Example 2 ```powershell @@ -79,7 +79,7 @@ You can't use this switch with the LoadOnly switch. Type: SwitchParameter Parameter Sets: Initialize Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -97,7 +97,7 @@ You can't use this switch with the ForceInitialize switch. Type: SwitchParameter Parameter Sets: LoadOnly Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -113,7 +113,7 @@ The PolicyCenterSiteOwner parameter specifies the email address of the owner of Type: SmtpAddress Parameter Sets: Initialize Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -127,12 +127,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md b/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md index d825a4f943..d208ed10b8 100644 --- a/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md +++ b/exchange/exchange-ps/exchange/Invoke-ComplianceSearchActionStep.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/invoke-compliancesearchactionstep -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/invoke-compliancesearchactionstep +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance title: Invoke-ComplianceSearchActionStep schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. This cmdlet is reserved for internal Microsoft use. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,7 +46,7 @@ This cmdlet is reserved for internal Microsoft use. Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: 1 @@ -62,7 +62,7 @@ This cmdlet is reserved for internal Microsoft use. Type: PSObject Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: Named @@ -78,7 +78,7 @@ This cmdlet is reserved for internal Microsoft use. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: Named @@ -92,12 +92,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md b/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md new file mode 100644 index 0000000000..af2ca95201 --- /dev/null +++ b/exchange/exchange-ps/exchange/Invoke-ComplianceSecurityFilterAction.md @@ -0,0 +1,248 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/invoke-compliancesecurityfilteraction +applicable: Security & Compliance +title: Invoke-ComplianceSecurityFilterAction +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Invoke-ComplianceSecurityFilterAction + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Invoke-ComplianceSecurityFilterAction cmdlet to view and set compliance boundaries for Microsoft OneDrive sites in cloud-based organizations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Invoke-ComplianceSecurityFilterAction [-Action] [[-EmailAddress] ] [-PropertyName] [[-PropertyValue] ] [-SiteUrl] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +This cmdlet is useful in scenarios where the OneDrive site has fallen out of the compliance boundary due to a departed user and a corresponding inactive mailbox. + +To use this cmdlet in Security & Compliance PowerShell, you need to be a member of the Compliance Administrator role group. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Invoke-ComplianceSecurityFilterAction -Action GetStatus -PropertyName CustomAttribute1 -SiteUrl https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx + +SiteUrlOrEmailAddress : https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx +BoundaryType : UserMailbox +BoundaryInstruction : Set via Set-Mailbox +BoundaryObjectId : SPO_f82ace6e-817e-4752-8917-67164dabde98@SPO_775ea11f-a2af-7821-b04c-9848e903ce47 +BoundaryStatus : Success +BoundaryProperty : CustomAttribute1 +BoundaryPropertyValue : +``` + +This example returns the status of a OneDrive site to indicate it's associated to a user mailbox and the CustomAttribute1 property isn't currently set. + +### Example 2 +```powershell +PS C:\> Invoke-ComplianceSecurityFi1terAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "nina@contoso.onmicrosoft.com" + +SiteUrlOrEmailAddress : nina@contoso.onmicrosoft.com +BoundaryType : UserMailbox +BoundaryInstruction : Set via Set-Mailbox +BoundaryObjectId : nina@contoso.onmicrosoft.com +BoundaryStatus : Success +BoundaryProperty : CustomAttribute3 +BoundaryPropertyVa1ue : +``` + +This example returns the status of a mailbox to indicate the mailbox is inactive, and the CustomAttribute3 property isn't currently set. + +### Example 3 +```powershell +PS C:\> Invoke-ComplianceSecurityFi1terAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "zhexuan@contoso.onmicrosoft.com" + +SiteUrlOrEmailAddress : zhexuan@contoso.onmicrosoft.com +BoundaryType : InactiveMailbox +BoundaryInstruction : Set via Invoke-ComplianceSecurityFiIterAction -Set +BoundaryObjectId : zhexuan@contoso.onmicrosoft.com +BoundaryStatus : Success +BoundaryProperty : CustomAttribute3 +BoundaryPropertyVa1ue : test33 +``` + +This example returns the status of a mailbox to indicate the mailbox is inactive, and the CustomAttribute3 property is currently set to test33. + +### Example 4 +```powershell +Invoke-ComplianceSecurityFilterAction -Action Set -PropertyName CustomAttribute1 -PropertyValue "Research and Development" -SiteUrl https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx +``` + +This example sets the boundary of the specified OneDrive site for a user who left the company. + +### Example 5 +```powershell +PS C:\> Invoke-ComplianceSecurityFiIterAction -Action Set -PropertyName "CustomAttribute3" -PropertyValue "ProjectX" -EmailAddress "zhexuan@contoso.onmicrosoft.com" + +Set action succeeded, please use GetStatus to check the result. + +PS C:\> Invoke-ComplianceSecurityFiIterAction -Action GetStatus -PropertyName "CustomAttribute3" -EmailAddress "zhexuan@contoso.onmicrosoft.com" + +SiteUrlOrEmailAddress : zhexuan@contoso.onmicrosoft.com +BoundaryType : InactiveMailbox +BoundaryInstruction : Set via Invoke-ComplianceSecurityFiIterAction -Set +BoundaryObjectId : zhexuan@contoso.onmicrosoft.com +BoundaryStatus : Success +BoundaryProperty : CustomAttribute3 +BoundaryPropertyVa1ue : ProjectX +``` + +This example sets the boundary of the specified OneDrive site to the specified CustomAttribute3 property value, and runs another command to review the result. + +## PARAMETERS + +### -Action +The Action parameter specifies the action for the command. Valid values are: + +- GetStatus +- Set + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EmailAddress +The EmailAddress parameter specifies the the affected user mailbox. You can use the following values to uniquely identify the mailbox: + +- Name +- Email address +- Alias +- ExchangeGUID + +If the value contains spaces, enclose the value in quotation marks. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertyName +The PropertyName parameter specifies the name of the property of the compliance boundary for the OneDrive site that you want to view or modify. Valid values are: + +- CustomAttribute1 to CustomAttribute15 + +Use the PropertyValue parameter to set the compliance boundary. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PropertyValue +The PropertyValue parameter specifies the value of the PropertyName value when you use the Action parameter value Set to set the compliance boundary of a OneDrive site. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteUrl +The SiteUrl parameter specifies the OneDrive site that you want to view or modify. This parameter uses the syntax `https://-my.sharepoint.com/personal/__onmicrosoft_com/_layouts/15/onedrive.aspx`. For example: `https://contoso-my.sharepoint.com/personal/lila_contoso_onmicrosoft_com/_layouts/15/onedrive.aspx`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 5 +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md b/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md new file mode 100644 index 0000000000..3579f174b8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Invoke-HoldRemovalAction.md @@ -0,0 +1,198 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/invoke-holdremovalaction +applicable: Security & Compliance +title: Invoke-HoldRemovalAction +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Invoke-HoldRemovalAction + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Invoke-HoldRemovalAction cmdlet to view and remove holds on mailboxes and SharePoint sites. You can also see holds that were previously removed by using this cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Invoke-HoldRemovalAction -Action + [-Confirm] + [-ExchangeLocation ] + [-Force] + [-HoldId ] + [-SharePointLocation ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. Only Compliance Administrator can remove hold for Exchange or Sharepoint locations. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Invoke-HoldRemovalAction -Action RemoveHold -ExchangeLocation "KittyPetersen@contoso.onmicrosoft.com" -HoldId "UniHecbf89df-74fc-444a-a2dc-c0756c7d3503" +``` + +This example removes the specified hold on Kitty Petersen's mailbox if policy UniHecbf89df-74fc-444a-a2dc-c0756c7d3503 is not an active case hold policy. + +### Example 2 +```powershell +Invoke-HoldRemovalAction -Action GetHolds -SharePointLocation "https://contoso.sharepoint.com/sites/finance" +``` + +This example displays all hold information on the specified SharePoint site. + +### Example 3 +```powershell +Invoke-HoldRemovalAction -Action GetHoldRemovals +``` + +This example displays all hold removals that have been done using this cmdlet. + +## PARAMETERS + +### -Action +The Action parameter specifies the mode that the cmdlet operates in. Valid values are: + +- GetHoldRemovals: Shows all hold removals that were done using this cmdlet. +- GetHolds: Shows holds on the specified mailbox (the ExchangeLocation parameter) or SharePoint site (the SharePointLocation parameter). +- RemoveHold: Removes the specified hold (the HoldId parameter) from the specified mailbox (the ExchangeLocation parameter) or SharePoint site (the SharePointLocation parameter). + +```yaml +Type: HoldRemovalActionType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: True +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies the email address of the mailbox that contains the holds to view or remove. + +This parameter is required when you use the value GetHolds or RemoveHold for the Action parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to force remove the hold even when the policy is active. Instead, you should remove the hold from the case hold policy. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HoldId +The HoldId parameter specifies the hold that you want to view or remove. + +To find valid values for this parameter, use this cmdlet with the Action parameter value GetHolds and look for the HoldId property in the output. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointLocation +The SharePointLocation parameter specifies the URL of the SharePoint site that contains the holds to view or remove. + +This parameter is required when you use the value GetHolds or RemoveHold for the Action parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md b/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md index 7c62548f12..858171d8c8 100644 --- a/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md +++ b/exchange/exchange-ps/exchange/Invoke-MonitoringProbe.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/invoke-monitoringprobe +online version: https://learn.microsoft.com/powershell/module/exchange/invoke-monitoringprobe applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Invoke-MonitoringProbe schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Invoke-MonitoringProbe cmdlet to run a Managed Availability probe on a s This cmdlet cannot be used to run every Managed Availability probe. Only some probes (mainly the deep test probes) can be run manually using this cmdlet. Probes that cannot be run with this cmdlet will generate an error message when Invoke-MonitoringProbe is used to run them. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Invoke-MonitoringProbe [-Identity] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -238,12 +238,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Mount-Database.md b/exchange/exchange-ps/exchange/Mount-Database.md index 81a5c5dec0..8d6dc5909a 100644 --- a/exchange/exchange-ps/exchange/Mount-Database.md +++ b/exchange/exchange-ps/exchange/Mount-Database.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/mount-database +online version: https://learn.microsoft.com/powershell/module/exchange/mount-database applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Mount-Database schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Mount-Database cmdlet to mount mailbox databases on Exchange servers. The cmdlet mounts the database only if the Microsoft Exchange Information Store service and the Microsoft Exchange Replication service are running. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Mount-Database [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -117,9 +117,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -Use this parameter to mount an empty database, or to override any errors or warnings that are encountered during the database mount. +Use this switch to mount an empty database, or to override any errors or warnings that are encountered during the database mount. ```yaml Type: SwitchParameter @@ -171,12 +171,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md b/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md index 0997f14b36..c59b2bf565 100644 --- a/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Move-ActiveMailboxDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/move-activemailboxdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/move-activemailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Move-ActiveMailboxDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Move-ActiveMailboxDatabase cmdlet to perform a database or server switchover. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -99,7 +99,7 @@ Move-ActiveMailboxDatabase [-Identity] [-ActivateOnServer] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -483,12 +483,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Move-AddressList.md b/exchange/exchange-ps/exchange/Move-AddressList.md index d2545d6897..d2c70381c6 100644 --- a/exchange/exchange-ps/exchange/Move-AddressList.md +++ b/exchange/exchange-ps/exchange/Move-AddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/move-addresslist +online version: https://learn.microsoft.com/powershell/module/exchange/move-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Move-AddressList schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Move-AddressList cmdlet to move an existing address list to a new container under the root address list. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Move-AddressList [-Identity] -Target ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -67,6 +67,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -140,12 +142,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md new file mode 100644 index 0000000000..85953675d6 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ATPBuiltInProtectionRule.md @@ -0,0 +1,238 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-atpbuiltinprotectionrule +applicable: Exchange Online +title: New-ATPBuiltInProtectionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ATPBuiltInProtectionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +**Note**: Don't use this cmdlet. This cmdlet is used by the system to create the one and only rule for the Built-in protection preset security policy during the creation of the organization. You can't use this cmdlet if a rule for the Built-in protection preset security policy already exists. The Remove-ATPBuiltInProtectionRule cmdlet is not available to remove rules. + +Use the New-ATPBuiltInProtectionRule cmdlet to create the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ATPBuiltInProtectionRule -SafeAttachmentPolicy -SafeLinksPolicy + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Name ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ATPBuiltInProtectionRule -SafeAttachmentPolicy "Built-In Protection Policy" -SafeLinksPolicy "Built-In Protection Policy" +``` + +This cmdlet creates the rule for the Built-in protection preset security policy. This command will fail if the rule already exists. + +## PARAMETERS + +### -SafeAttachmentPolicy +The SafeAttachmentPolicy parameter specifies the Safe Attachments policy that's associated with the Built-in preset security policy. Use the following command to identify the policy: `Get-SafeAttachmentPolicy | Where-Object -Property IsBuiltInProtection -eq -Value "True"`. + +The name of the default Safe Attachments policy that's used for the Built-in protection preset security policy is Built-In Protection Policy. + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeLinksPolicy +The SafeLinksPolicy parameter specifies the Safe Links policy that's associated with the Built-in preset security policy. Use the following command to identify the policy: `Get-SafeLinksPolicy | Where-Object -Property IsBuiltInProtection -eq -Value "True"`. + +The name of the default Safe Links policy that's used for the Built-in protection preset security policy is Built-In Protection Policy. + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +The name of the only rule is ATP Built-In Protection Rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..9397716f14 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ATPProtectionPolicyRule.md @@ -0,0 +1,364 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-atpprotectionpolicyrule +applicable: Exchange Online +title: New-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ATPProtectionPolicyRule cmdlet to create rules for Microsoft Defender for Office 365 protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. + +**Note**: Unless you manually removed a rule using the Remove-ATPProtectionPolicyRule cmdlet, we don't recommend using this cmdlet to create rules. To create the rule, you need to specify the existing individual security policies that are associated with the preset security policy. We never recommend creating these required individual security policies manually. Turning on the preset security policy for the first time in the Microsoft Defender portal automatically creates the required individual security policies, but also creates the associated rules using this cmdlet. So, if the rules already exist, you don't need to use this cmdlet to create them. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ATPProtectionPolicyRule [-Name] -SafeAttachmentPolicy -SafeLinksPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ATPProtectionPolicyRule -Name "Standard Preset Security Policy" -SafeAttachmentPolicy "Standard Preset Security Policy1622650008019" -SafeLinksRule "Standard Preset Security Policy1622650008534" Priority 1 +``` + +This example creates the rule for the Standard preset security policy. No restrictions are placed on who the Defender for Office 365 protections apply to. If the rule already exists, the command will fail. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. Since you don't need to create rules other than those used by the Standard preset security policy or the Strict preset security policy, we highly recommend that you use the default rule names for clarity and consistency. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeAttachmentPolicy +The SafeAttachmentPolicy parameter specifies the existing Safe Attachments policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650008019`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034872546`. + +You can find the Safe Attachments policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-SafeAttachmentPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `Get-SafeAttachmentPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: SafeAttachmentPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SafeLinksPolicy +The SafeLinksPolicy parameter specifies the existing Safe Links policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the Safe Attachments policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650008534`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034873192`. + +You can find the Safe Links policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-SafeLinksPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `Get-SafeLinksPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: SafeLinksPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled. Valid values are: + +- $true: The rule is enabled. The State value of the rule is Enabled. This is the default value. +- $false: The rule is disabled. The State value of the rule is Disabled. + +After you create the rule, you turn on or turn off the preset security policy using one of the following commands: + +- Turn off: Disable-ATPProtectionPolicyRule and Disable-EOPProtectionPolicyRule. +- Turn on: Enable-ATPProtectionPolicyRule and Enable-EOPProtectionPolicyRule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. + +When you create the policy, you must use the default value. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AcceptedDomain.md b/exchange/exchange-ps/exchange/New-AcceptedDomain.md index a4a560c47d..157ffaec81 100644 --- a/exchange/exchange-ps/exchange/New-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/New-AcceptedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-accepteddomain +online version: https://learn.microsoft.com/powershell/module/exchange/new-accepteddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-AcceptedDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-AcceptedDomain cmdlet to create an accepted domain in your organization. An accepted domain is any SMTP namespace for which an Exchange organization sends and receives email. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ New-AcceptedDomain [-Name] -DomainName ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,35 +43,35 @@ This example creates the new authoritative accepted domain Contoso. ## PARAMETERS -### -DomainName -The DomainName parameter specifies the SMTP domain that you want to establish as an accepted domain. Valid input for the DomainName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. - -However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. The domain name string may not contain more than 256 characters. +### -Name +The Name parameter specifies a unique name for the accepted domain object. ```yaml -Type: SmtpDomainWithSubdomains +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the accepted domain object. +### -DomainName +The DomainName parameter specifies the SMTP domain that you want to establish as an accepted domain. Valid input for the DomainName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. + +However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. The domain name string may not contain more than 256 characters. ```yaml -Type: String +Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -155,12 +155,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md index b08d1e3065..136f962987 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ActiveSyncDeviceAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-activesyncdeviceaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncdeviceaccessrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-ActiveSyncDeviceAccessRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-ActiveSyncDeviceAccessRule cmdlet to define the access levels for Exchange ActiveSync devices based on the identity of the device. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ New-ActiveSyncDeviceAccessRule -AccessLevel -Characteristic ## DESCRIPTION You can create multiple rules that define groups of devices: Allowed devices, blocked devices and quarantined devices. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -165,12 +165,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md index 172b334b4d..e194e62483 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-ActiveSyncMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-activesyncmailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncmailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-ActiveSyncMailboxPolicy schema: 2.0.0 @@ -18,7 +18,7 @@ Use the New-ActiveSyncMailboxPolicy cmdlet to create a Microsoft Mobile Device m **Note**: In Exchange 2013 or later, use the New-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use New-ActiveSyncMailboxPolicy, update them to use New-MobileDeviceMailboxPolicy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -88,7 +88,7 @@ The New-ActiveSyncMailboxPolicy cmdlet creates a Mobile Device mailbox policy fo Some Mobile Device mailbox policy settings require the mobile device to have certain built-in features that enforce these security and device management settings. If your organization allows all devices, you must set the AllowNonProvisionableDevices parameter to $true. This allows devices that can't enforce all policy settings to synchronize with your server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -1056,12 +1056,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md index 0b986eb965..03c846da01 100644 --- a/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-ActiveSyncVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-activesyncvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/new-activesyncvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-ActiveSyncVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-ActiveSyncVirtualDirectory cmdlet to create Exchange ActiveSync virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,7 +44,7 @@ New-ActiveSyncVirtualDirectory [-ApplicationRoot ] ## DESCRIPTION The New-ActiveSyncVirtualDirectory cmdlet creates an Exchange ActiveSync virtual directory on the specified server under the specified website. The Exchange ActiveSync virtual directory created is named Microsoft-Server-ActiveSync. Only one Exchange ActiveSync virtual directory can exist in each Exchange ActiveSync website. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -426,12 +426,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ActivityAlert.md b/exchange/exchange-ps/exchange/New-ActivityAlert.md deleted file mode 100644 index 1eeb9f056a..0000000000 --- a/exchange/exchange-ps/exchange/New-ActivityAlert.md +++ /dev/null @@ -1,472 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-activityalert -applicable: Security & Compliance Center -title: New-ActivityAlert -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-ActivityAlert - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the New-ActivityAlert cmdlet to create activity alerts in the Microsoft 365 Defender portal or the Microsoft 365 compliance center. Activity alerts send you email notifications when users perform specific activities in Microsoft 365. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -### AnomalousOperationAuditAlert -``` -New-ActivityAlert -Multiplier -Name -NotifyUser -Type - [-Operation ] - [-Category ] - [-Condition ] - [-Confirm] - [-Description ] - [-Disabled ] - [-EmailCulture ] - [-RecordType ] - [-ScopeLevel ] - [-Severity ] - [-UserId ] - [-WhatIf] - [] -``` - -### SimpleAggregationAuditAlert -``` -New-ActivityAlert -Name -NotifyUser -Threshold -TimeWindow -Type - [-Operation ] - [-Category ] - [-Condition ] - [-Confirm] - [-Description ] - [-Disabled ] - [-EmailCulture ] - [-RecordType ] - [-ScopeLevel ] - [-Severity ] - [-UserId ] - [-WhatIf] - [] -``` - -### Default -``` -New-ActivityAlert -Name -NotifyUser -Operation - [-Type ] - [-Category ] - [-Confirm] - [-Description ] - [-Disabled ] - [-EmailCulture ] - [-RecordType ] - [-Severity ] - [-UserId ] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -New-ActivityAlert -Name "External Sharing Alert" -Operation sharinginvitationcreated -NotifyUser chrisda@contoso.com,michelle@contoso.com -UserId laura@contoso.com,julia@contoso.com -Description "Notification for external sharing events by laura@contoso.com and julia@contoso.com" -``` - -This example creates a new activity alert named External Sharing Alert that has the following properties: - -- Operation: sharinginvitationcreated. -- NotifyUser: chrisda@contoso.com and michelle@contoso.com. -- UserId: laura@contoso.com and julia@contoso.com. -- Description: Notification for external sharing events by laura@contoso.com and julia@contoso.com. - -## PARAMETERS - -### -Multiplier -The Multiplier parameter specifies the number of events that trigger an activity alert. The value of this parameter indicates a multiplier from a baseline value. - -You can only use this parameter with the Type parameter value AnomalousAggregation. - -```yaml -Type: Double -Parameter Sets: AnomalousOperationAuditAlert -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the unique name of the activity alert. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -The NotifyUser parameter specifies the email addressesfor notification messages. You can specify internal and external email addresses. - -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operation -The Operation parameter specifies the activity that triggers an activity alert. - -A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -You can't use this parameter if the Type parameter value is ElevationOfPrivilege. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: MultiValuedProperty -Parameter Sets: AnomalousOperationAuditAlert, SimpleAggregationAuditAlert -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -The Threshold parameter specifies the number of events that trigger an activity alert in the time interval that's specified by the TimeWindow parameter. The minimum value for this parameter is 3. - -You can only use this parameter with the Type parameter value SimpleAggregation. - -```yaml -Type: Int32 -Parameter Sets: SimpleAggregationAuditAlert -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeWindow -The TimeWindow parameter specifies the time window in minutes that's used by the Threshold parameter. - -You can only use this parameter with the Type parameter value SimpleAggregation. - -```yaml -Type: Int32 -Parameter Sets: SimpleAggregationAuditAlert -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter specifies the type alert. Valid values are: - -- Custom: An alert is created for the activities you specify with the Operation parameter. Typically, you don't need to use this value (if you don't use the Type parameter, and you specify the activities with the Operations parameter, the value Custom is automatically added to the Type property). -- ElevationOfPrivilege: This value is being retired. -- SimpleAggregation: An alert is created based on the activities defined by the Operation and Condition parameters, the number of activities specified by the Threshold parameter, and the time period specified by the TimeWindow parameter. -- AnomalousAggregation: An alert is created based the activities defined by the Operation and Condition parameters, and the number of activities specified by the Multiplier parameter. - -**Note**: You can't change the Type value in an existing activity alert. - -```yaml -Type: AlertType -Parameter Sets: AnomalousOperationAuditAlert, SimpleAggregationAuditAlert -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: AlertType -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Category -The Category parameter specifies a category for the activity alert. Valid values are: - -- None (This is the default value) -- DataLossPrevention -- ThreatManagement -- DataGovernance -- AccessGovernance -- Others - -```yaml -Type: AlertRuleCategory -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -The Condition parameter specifies filter conditions for event aggregation. - -```yaml -Type: String -Parameter Sets: AnomalousOperationAuditAlert, SimpleAggregationAuditAlert -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the activity alert is enabled or disabled. Valid values are: - -- $true: The activity alert is disabled. -- $false: The activity alert is enabled. This is the default value. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailCulture -The EmailCulture parameter specifies the language of the notification email message. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordType -The RecordType parameter specifies a record type label for the activity alert. For details about the available values, see [AuditLogRecordType](https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - -You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - -```yaml -Type: AuditRecordType -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeLevel -The ScopeLevel parameter specifies the scope for activity alerts that use the Type parameter values SimpleAggregation or AnomalousAggregation. Valid values are: - -- SingleUser (This is the default value) -- AllUsers - -```yaml -Type: AlertScopeLevel -Parameter Sets: AnomalousOperationAuditAlert, SimpleAggregationAuditAlert -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Severity -The Severity parameter specifies a severity level for the activity alert. Valid values are: - -- None -- Low (This is the default value) -- Medium -- High - -```yaml -Type: RuleSeverity -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The UserId parameter specifies who you want to monitor. - -- If you specify a user's email address, you'll receive an email notification when the user performs the specified activity. You can specify multiple email addresses separated by commas. -- If this parameter is blank ($null), you'll receive an email notification when any user in your organization performs the specified activity. - -You can only use this parameter with the Type parameter values Custom or ElevationOfPrivilege. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AdaptiveScope.md b/exchange/exchange-ps/exchange/New-AdaptiveScope.md new file mode 100644 index 0000000000..88433a9deb --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AdaptiveScope.md @@ -0,0 +1,175 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-adaptivescope +applicable: Security & Compliance +title: New-AdaptiveScope +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-AdaptiveScope + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-AdaptiveScope cmdlet to create adaptive scopes in your organization. Adaptive scopes (or static scopes) are used in retention policies and retention label policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-AdaptiveScope -Name -FilterConditions -LocationType + [-AdministrativeUnit ] + [-Comment ] + [] +``` + +### AdaptiveScopeRawQuery +``` +New-AdaptiveScope -Name -LocationType -RawQuery + [-AdministrativeUnit ] + [-Comment ] + [] +``` + +## DESCRIPTION +For more information about the properties to use in adaptive scopes, see [Configuration information for adaptive scopes](https://learn.microsoft.com/purview/retention-settings#configuration-information-for-adaptive-scopes). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AdaptiveScope -Name "Project X" -LocationType User -FilterConditions @{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"} +``` + +This example create an adaptive query scope named Project X with the following details: + +- Scope: Users +- Query: "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'". + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the adaptive scope. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterConditions +The FilterConditions parameter specifies the conditions that are included in the dynamic boundary. Valid syntax and values depend of the value of the LocationType parameter: + +- User or Group: Active Directory attributes. For example, for the condition "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'", use the following syntax: `@{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"}` +- Site: Indexed custom properties. For example, for the condition "'Refinable string 0' equals 'Human Resources', use the following syntax: `@{"Conditions" = @{"Value" = "Human Resources"; "Operator" = "Equals"; "Name" = "RefinableString00"}; "Conjunction" = "And"}` + +You can't use this parameter with the RawQuery parameter. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationType +The LocationType parameter specifies the location where the adaptive scope filter is defined. Valid values are: + +- User +- Group (Microsoft 365 group) +- Site + +```yaml +Type: DynamicBoundaryLocationType +Parameter Sets: (All) +Aliases: +Accepted values: Unknown, User, Group, Site +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawQuery +The RawQuery parameter switches the scope to advanced query mode. You use OPATH filter syntax for advanced query mode. + +You can't use this parameter with the FilterConditions parameter. + +```yaml +Type: String +Parameter Sets: AdaptiveScopeRawQuery +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministrativeUnit +{{ Fill AdministrativeUnit Description }} + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md b/exchange/exchange-ps/exchange/New-AddressBookPolicy.md index fa51099946..4bade089b4 100644 --- a/exchange/exchange-ps/exchange/New-AddressBookPolicy.md +++ b/exchange/exchange-ps/exchange/New-AddressBookPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-addressbookpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-addressbookpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-AddressBookPolicy schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-AddressBookPolicy cmdlet to create an address book policy. Address book policies define the global address list (GAL), offline address book (OAB), room list, and address lists that will be displayed to mailbox users who are assigned the policy. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ New-AddressBookPolicy [-Name] -AddressLists ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -115,7 +115,19 @@ Accept wildcard characters: False ``` ### -RoomList -The RoomList parameter specifies the room address list that will be used by mailbox users who are assigned this address book policy. You can specify only one room list for each address book policy. +The RoomList parameter specifies an address list that used for location experiences for mailbox users who have this address book policy assigned to them. + +- When using location experiences (for example, Room Finder or selecting a conference room when scheduling a meeting), users see only resources that match the [RecipientFilter](https://learn.microsoft.com/powershell/module/exchange/new-addresslist#-recipientfilter) results from the address list that's specified by this parameter. +- When using experiences that aren't location specific (for example, the To or Cc fields of a calendar event), the address lists specified by the AddressLists parameter in this address book policy are applied. The address list specified by this parameter isn't used. + +A valid value for this parameter is one address list. You can use any value that uniquely identifies the address list. For example: + +- Name +- Distinguished name (DN) +- GUID + +> [!NOTE] +> There's no automatic association between this parameter and [room list distribution groups](https://learn.microsoft.com/exchange/recipients/room-mailboxes#create-a-room-list), which also use a parameter named RoomList in the New-DistributionGroup and Set-DistributionGroup cmdlets. You still need to create room list distribution groups and assign resources as group members. Location experiences are filtered to show only rooms included in the address list that's specified by the RoomList property of the address book policy that's assigned to the user (if any). ```yaml Type: AddressListIdParameter @@ -188,12 +200,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AddressList.md b/exchange/exchange-ps/exchange/New-AddressList.md index 1a2be3771b..540855b553 100644 --- a/exchange/exchange-ps/exchange/New-AddressList.md +++ b/exchange/exchange-ps/exchange/New-AddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-addresslist +online version: https://learn.microsoft.com/powershell/module/exchange/new-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-AddressList schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-AddressList cmdlet to create address lists and apply them to recipients. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -71,15 +71,15 @@ The Conditional parameters that are used with the IncludedRecipients parameter a - The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-AddressList -Name MyAddressList -RecipientFilter "((RecipientType -eq 'UserMailbox') -and ((StateOrProvince -eq 'Washington') -or (StateOrProvince -eq 'Oregon')))" +New-AddressList -Name MyAddressList -RecipientFilter "((RecipientTypeDetails -eq 'UserMailbox') -and ((StateOrProvince -eq 'Washington') -or (StateOrProvince -eq 'Oregon')))" ``` This example creates the address list MyAddressList. The address list includes recipients that are mailbox users and have the StateOrProvince property set to Washington or Oregon. @@ -93,7 +93,7 @@ This example creates the address list MyAddressList2 that includes mailboxes tha ### Example 3 ```powershell -New-AddressList -Name "AL_AgencyB" -RecipientFilter "((RecipientType -eq 'UserMailbox') -and (CustomAttribute15 -like 'AgencyB*'))" +New-AddressList -Name "AL_AgencyB" -RecipientFilter "((RecipientTypeDetails -eq 'UserMailbox') -and (CustomAttribute15 -like 'AgencyB*'))" ``` This example creates the address list AL\_AgencyB that includes mailboxes that have the value of the CustomAttribute15 parameter contains AgencyB. @@ -128,7 +128,7 @@ The IncludedRecipients parameter specifies a precanned filter that's based on th You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. -You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: WellKnownRecipientType @@ -144,16 +144,16 @@ Accept wildcard characters: False ``` ### -RecipientFilter -The RecipientFilter parameter specifies a custom OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). @@ -175,7 +175,7 @@ The ConditionalCompany parameter specifies a precanned filter that's based on th When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -195,7 +195,7 @@ The ConditionalCustomAttribute1 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -215,7 +215,7 @@ The ConditionalCustomAttribute10 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -235,7 +235,7 @@ The ConditionalCustomAttribute11 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -255,7 +255,7 @@ The ConditionalCustomAttribute12 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -275,7 +275,7 @@ The ConditionalCustomAttribute13 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -295,7 +295,7 @@ The ConditionalCustomAttribute14 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -315,7 +315,7 @@ The ConditionalCustomAttribute15 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -335,7 +335,7 @@ The ConditionalCustomAttribute2 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -355,7 +355,7 @@ The ConditionalCustomAttribute3 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -375,7 +375,7 @@ The ConditionalCustomAttribute4 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -395,7 +395,7 @@ The ConditionalCustomAttribute5 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -415,7 +415,7 @@ The ConditionalCustomAttribute6 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -435,7 +435,7 @@ The ConditionalCustomAttribute7 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -455,7 +455,7 @@ The ConditionalCustomAttribute8 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -475,7 +475,7 @@ The ConditionalCustomAttribute9 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -495,7 +495,7 @@ The ConditionalDepartment parameter specifies a precanned filter that's based on When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -515,7 +515,7 @@ The ConditionalStateOrProvince parameter specifies a precanned filter that's bas When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -654,12 +654,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md index ed7795b613..1c5c9541bd 100644 --- a/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md +++ b/exchange/exchange-ps/exchange/New-AddressRewriteEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-addressrewriteentry +online version: https://learn.microsoft.com/powershell/module/exchange/new-addressrewriteentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-AddressRewriteEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the New-AddressRewriteEntry cmdlet to create an address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -206,12 +206,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md b/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md index 8b1955294f..1059619e55 100644 --- a/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md +++ b/exchange/exchange-ps/exchange/New-AdminAuditLogSearch.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-adminauditlogsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protectiontitle: New-AdminAuditLogSearch +online version: https://learn.microsoft.com/powershell/module/exchange/new-adminauditlogsearch +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection +title: New-AdminAuditLogSearch schema: 2.0.0 author: chrisda ms.author: chrisda @@ -11,11 +12,14 @@ ms.reviewer: # New-AdminAuditLogSearch ## SYNOPSIS +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: . + This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the New-AdminAuditLogSearch cmdlet to search the contents of the administrator audit log and send the results to one or more mailboxes that you specify. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +40,7 @@ New-AdminAuditLogSearch -EndDate -StartDate -StatusMai ## DESCRIPTION After the New-AdminAuditLogSearch cmdlet is run, the report is delivered to the mailboxes you specify within 15 minutes. The log is included as an XML attachment on the report email message. The maximum size of the log that can be generated is 10 megabytes (MB). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,13 +68,13 @@ This example returns entries in the administrator audit log of an Exchange Onlin ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -81,13 +85,13 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -104,7 +108,7 @@ If you want to specify more than one recipient, separate each SMTP address with Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named Default value: None @@ -121,7 +125,7 @@ If you want to specify more than one cmdlet, separate each cmdlet with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -139,7 +143,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -172,7 +176,7 @@ The ExternalAccess parameter returns only audit log entries for cmdlets that wer Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -189,7 +193,7 @@ If the name of the report contains spaces, enclose the name in quotation marks ( Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -206,7 +210,7 @@ If you want to specify more than one object ID, separate each ID with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -223,7 +227,7 @@ If you want to specify more than one parameter, separate each parameter with a c Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -240,7 +244,7 @@ If you want to specify more than one user ID, separate each ID with a comma. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -249,7 +253,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -257,7 +261,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named Default value: None @@ -270,12 +274,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md index 15ee90e6f5..412a2a5340 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-antiphishpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-antiphishpolicy applicable: Exchange Online, Exchange Online Protection title: New-AntiPhishPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-AntiPhishPolicy cmdlet to create antiphish policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,6 +25,8 @@ New-AntiPhishPolicy [-Name] [-AdminDisplayName ] [-AuthenticationFailAction ] [-Confirm] + [-DmarcQuarantineAction ] + [-DmarcRejectAction ] [-Enabled ] [-EnableFirstContactSafetyTips ] [-EnableMailboxIntelligence ] @@ -42,18 +42,24 @@ New-AntiPhishPolicy [-Name] [-EnableViaTag ] [-ExcludedDomains ] [-ExcludedSenders ] + [-HonorDmarcPolicy ] [-ImpersonationProtectionState ] [-MailboxIntelligenceProtectionAction ] [-MailboxIntelligenceProtectionActionRecipients ] + [-MailboxIntelligenceQuarantineTag ] + [-MakeDefault] [-PhishThresholdLevel ] [-PolicyTag ] [-RecommendedPolicyType ] [-SimilarUsersSafetyTipsCustomText ] + [-SpoofQuarantineTag ] [-TargetedDomainActionRecipients ] [-TargetedDomainProtectionAction ] + [-TargetedDomainQuarantineTag ] [-TargetedDomainsToProtect ] [-TargetedUserActionRecipients ] [-TargetedUserProtectionAction ] + [-TargetedUserQuarantineTag ] [-TargetedUsersToProtect ] [-UnusualCharactersSafetyTipsCustomText ] [-WhatIf] @@ -65,7 +71,7 @@ Phishing messages contain fraudulent links or spoofed domains in an effort to ge New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the AntiPhishPolicy parameter on the New-AntiPhishRule or Set-AntiPhishRule cmdlets to associate the policy with a rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -121,8 +127,8 @@ This setting is part of spoof protection. The AuthenticationFailAction parameter specifies the action to take when the message fails composite authentication (a mixture of traditional SPF, DKIM, and DMARC email authentication checks and proprietary backend intelligence). Valid values are: -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- MoveToJmf: This is the default value. Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. ```yaml Type: SpoofAuthenticationFailAction @@ -156,11 +162,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DmarcQuarantineAction +This setting is part of spoof protection. + +The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: + +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. This is the default value. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcQuarantineAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DmarcRejectAction +This setting is part of spoof protection. + +The DmarcRejectAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: + +- Quarantine: Deliver the message to quarantine. +- Reject: Reject the message. This is the default value. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcRejectAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Enabled -The Enabled parameter specifies whether the policy is enabled. Valid values are: +This parameter is reserved for internal Microsoft use. + +To create a disabled anti-phishing policy (the combination of the antiphish rule and the associated antiphish policy), use `-Enabled $false` on the **New-AntiPhishRule** cmdlet. + +To enable or disable an existing anti-phishing policy, use the **Enable-AntiPhishRule** or **Disable-AntiPhishRule** cmdlets. -- $true: The policy is enabled. This is the default value. -- $false: The policy is disabled. +In the output of the **Get-AntiPhishRule** cmdlet, whether the anti-phishing policy is enabled or disabled is visible in the State property. ```yaml Type: Boolean @@ -195,7 +250,7 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligence -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence, which is artificial intelligence (AI) that determines user email patterns with their frequent contacts. Mailbox intelligence helps distinguish between messages from legitimate and impersonated senders based on a recipient's previous communication history. Valid values are: @@ -206,7 +261,7 @@ The EnableMailboxIntelligence parameter specifies whether to enable or disable m Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -216,7 +271,7 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligenceProtection -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligenceProtection specifies whether to enable or disable taking action for impersonation detections from mailbox intelligence results. Valid values are: @@ -241,9 +296,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationDomainsProtection -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: +The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: - $true: Domain impersonation protection is enabled for all registered domains in the Microsoft 365 organization. - $false: Domain impersonation protection isn't enabled for all registered domains in the Microsoft 365 organization. This is the default value. You can enable protection for specific domains by using the EnableTargetedDomainsProtection and TargetedDomainsToProtect parameters. @@ -262,9 +317,9 @@ Accept wildcard characters: False ``` ### -EnableSimilarDomainsSafetyTips -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: +The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: - $true: Safety tips for similar domains are enabled. - $false: Safety tips for similar domains are disabled. This is the default value. @@ -283,9 +338,9 @@ Accept wildcard characters: False ``` ### -EnableSimilarUsersSafetyTips -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: +The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: - $true: Safety tips for similar users are enabled. - $false: Safety tips for similar users are disabled. This is the default value. @@ -308,7 +363,7 @@ This setting is part of spoof protection. The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: -- $true: Antispoofing is enabled for the policy. This is the default and recommended value. You specify the spoofed senders to allow or block using the Set-PhishFilterPolicy cmdlet. +- $true: Antispoofing is enabled for the policy. This is the default and recommended value. Use the \*-TenantAllowBlockListSpoofItems, Get-SpoofIntelligenceInsight, and Get-SpoofMailReport cmdlets to view and specify the spoofed senders to allow or block. - $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. ```yaml @@ -325,9 +380,9 @@ Accept wildcard characters: False ``` ### -EnableTargetedDomainsProtection -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: +The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: - $true: Domain impersonation protection is enabled for the domains specified by the TargetedDomainsToProtect parameter. - $false: The TargetedDomainsToProtect parameter isn't used. This is the default value. @@ -346,9 +401,9 @@ Accept wildcard characters: False ``` ### -EnableTargetedUserProtection -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: +The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: - $true: User impersonation protection is enabled for the users specified by the TargetedUsersToProtect parameter. - $false: The TargetedUsersToProtect parameter isn't used. This is the default value. @@ -369,15 +424,15 @@ Accept wildcard characters: False ### -EnableUnauthenticatedSender This setting is part of spoof protection. -The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: +The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: - $true: This is the default value. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. - $false: A question mark is never applied to the sender's photo. To prevent these identifiers from being added to messages from specific senders, you have the following options: -- Allow the sender to spoof in the spoof intelligence policy. For instructions, see [Configure spoof intelligence in Microsoft 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). -- If you own the sender's domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://docs.microsoft.com/microsoft-365/security/office-365-security/email-validation-and-authentication#configure-email-authentication-for-domains-you-own). +- Allow the sender to spoof in the spoof intelligence policy. For instructions, see [Configure spoof intelligence in Microsoft 365](https://learn.microsoft.com/defender-office-365/anti-spoofing-spoof-intelligence). +- If you own the domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://learn.microsoft.com/defender-office-365/email-authentication-about). ```yaml Type: Boolean @@ -393,9 +448,9 @@ Accept wildcard characters: False ``` ### -EnableUnusualCharactersSafetyTips -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: +The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: - $true: Safety tips for unusual characters are enabled. - $false: Safety tips for unusual characters are disabled. This is the default value. @@ -416,15 +471,15 @@ Accept wildcard characters: False ### -EnableViaTag This setting is part of spoof protection. -The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: +The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: - $true: The via tag is added to the From address (the message sender that's displayed in email clients) if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. This is the default value. - $false: The via tag is not added to the From address. To prevent the via tag from being added to messages from specific senders, you have the following options: -- Allow the sender to spoof. For instructions, see [Configure spoof intelligence in Microsoft 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). -- If you own the sender's domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://docs.microsoft.com/microsoft-365/security/office-365-security/email-validation-and-authentication#configure-email-authentication-for-domains-you-own). +- Allow the sender to spoof. For instructions, see [Configure spoof intelligence in Microsoft 365](https://learn.microsoft.com/defender-office-365/anti-spoofing-spoof-intelligence). +- If you own the domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://learn.microsoft.com/defender-office-365/email-authentication-about). ```yaml Type: Boolean @@ -440,12 +495,14 @@ Accept wildcard characters: False ``` ### -ExcludedDomains -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. +The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. The maximum number of entries is approximately 1000. +**Note**: Domain entries don't include subdomains of the specified domain. You need to add an entry for each subdomain. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -460,9 +517,9 @@ Accept wildcard characters: False ``` ### -ExcludedSenders -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. +The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. The maximum number of entries is approximately 1000. @@ -479,8 +536,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HonorDmarcPolicy +This setting is part of spoof protection. + +The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: + +- $true: If a message fails DMARC and the sender's DMARC policy is `p=quarantine` or `p=reject`, the DmarcQuarantineAction or DmarcRejectAction parameters specify the action to take on the message. This is the default value. +- $false: If the message fails DMARC, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ImpersonationProtectionState -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ImpersonationProtectionState parameter specifies the configuration of impersonation protection. Valid values are: @@ -502,16 +580,16 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionAction -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: - NoAction: This is the default value. Note that this value has the same result as setting the EnableMailboxIntelligenceProtection parameter to $false when the EnableMailboxIntelligence parameter is $true. - BccMessage: Add the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter to the Bcc field of the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. -- Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. This parameter is meaningful only if the EnableMailboxIntelligence and EnableMailboxIntelligenceProtection parameters are set to the value $true. @@ -529,9 +607,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionActionRecipients -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. +The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. @@ -548,8 +626,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxIntelligenceQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by mailbox intelligence (the MailboxIntelligenceProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by mailbox intelligence impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeDefault +The MakeDefault switch makes this antiphish policy the default antiphish policy. You don't need to specify a value with this switch. + +The default antiphish policy is applied to everyone (no corresponding antiphish rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PhishThresholdLevel -This setting is part of advanced settings and is only available in Microsoft Defender for Office 365. +This setting is part of advanced settings and is available only in Microsoft Defender for Office 365. The PhishThresholdLevel parameter specifies the tolerance level that's used by machine learning in the handling of phishing messages. Valid values are: @@ -588,13 +712,12 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType -The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this parameter yourself. +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Accepted values: Custom, Standard, Strict Applicable: Exchange Online, Exchange Online Protection Required: False @@ -620,10 +743,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SpoofQuarantineTag +The SpoofQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by spoof intelligence (the AuthenticationFailAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by spoof intelligence protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetedDomainActionRecipients -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. +The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. @@ -641,16 +790,16 @@ Accept wildcard characters: False ``` ### -TargetedDomainProtectionAction -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: +The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: - NoAction: This is the default value. - BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. -- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. ```yaml Type: MultiValuedProperty @@ -665,8 +814,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetedDomainQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedDomainQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by domain impersonation protection (the TargetedDomainProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by domain impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetedDomainsToProtect -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. @@ -686,9 +863,9 @@ Accept wildcard characters: False ``` ### -TargetedUserActionRecipients -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. +The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. @@ -706,16 +883,16 @@ Accept wildcard characters: False ``` ### -TargetedUserProtectionAction -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: +The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: - NoAction: This is the default value. - BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. -- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. ```yaml Type: MultiValuedProperty @@ -730,8 +907,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetedUserQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedUserQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by user impersonation protection (the TargetedUserProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined by user impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetedUsersToProtect -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. @@ -739,7 +944,7 @@ This parameter uses the syntax: "DisplayName;EmailAddress". - DisplayName specifies the display name of the user that could be a target of impersonation. This value can contain special characters. - EmailAddress specifies the internal or external email address that's associated with the display name. -- You can specify multiple values by using the syntax: "DisplayName1;EmailAddress1","DisplayName2;EmailAddress2",..."DisplayNameN;EmailAddressN". The combination of DisplayName and EmailAddress needs to be unique for each value. +- You can specify multiple values by using the syntax: `"DisplayName1;EmailAddress1","DisplayName2;EmailAddress2",..."DisplayNameN;EmailAddressN"`. The combination of DisplayName and EmailAddress needs to be unique for each value. ```yaml Type: MultiValuedProperty @@ -791,12 +996,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AntiPhishRule.md b/exchange/exchange-ps/exchange/New-AntiPhishRule.md index fe651de436..79afcd0346 100644 --- a/exchange/exchange-ps/exchange/New-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/New-AntiPhishRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-antiphishrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-antiphishrule applicable: Exchange Online, Exchange Online Protection title: New-AntiPhishRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-AntiPhishRule cmdlet to create antiphish rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +39,10 @@ New-AntiPhishRule [-Name] -AntiPhishPolicy ## DESCRIPTION You need to add the antiphish rule to an existing policy by using the AntiPhishPolicy parameter. You create antiphish policies by using the New-AntiPhishPolicy cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Common policy settings](https://learn.microsoft.com/defender-office-365/anti-phishing-policies-about#common-policy-settings). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -154,7 +155,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -195,7 +196,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -246,7 +247,7 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -287,7 +288,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -334,12 +335,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-App.md b/exchange/exchange-ps/exchange/New-App.md index 84a52d398b..12f88e9b57 100644 --- a/exchange/exchange-ps/exchange/New-App.md +++ b/exchange/exchange-ps/exchange/New-App.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-app +online version: https://learn.microsoft.com/powershell/module/exchange/new-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-App schema: 2.0.0 @@ -16,29 +16,31 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-App cmdlet to install apps for Outlook. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### ExtensionOfficeMarketplace ``` -New-App [-Etoken ] - [-Mailbox ] - [-MarketplaceCorrelationID ] - [-MarketplaceAssetID ] - [-MarketplaceQueryMarket ] - [-MarketplaceServicesUrl ] - [-MarketplaceUserProfileType ] +New-App [-Etoken ] [-MarketplaceCorrelationID ] [-MarketplaceAssetID ] [-MarketplaceQueryMarket ] [-MarketplaceServicesUrl ] [-MarketplaceUserProfileType ] + [-AddInOverrides ] [-AllowReadWriteMailbox] + [-AllowSetting ] + [-AppState ] + [-AppType ] [-Confirm] [-DefaultStateForUser ] [-DomainController ] [-DownloadOnly] [-Enabled ] + [-Identity ] + [-Mailbox ] [-OrganizationApp] [-PrivateCatalog] [-ProvidedTo ] + [-UpdateAppState] [-UserList ] + [-Version ] [-WhatIf] [] ``` @@ -46,17 +48,24 @@ New-App [-Etoken ] ### ExtensionFileData ``` New-App [-FileData ] + [-AddInOverrides ] [-AllowReadWriteMailbox] + [-AllowSetting ] + [-AppState ] + [-AppType ] [-Confirm] [-DefaultStateForUser ] [-DomainController ] [-DownloadOnly] [-Enabled ] + [-Identity ] [-Mailbox ] [-OrganizationApp] [-PrivateCatalog] [-ProvidedTo ] + [-UpdateAppState] [-UserList ] + [-Version ] [-WhatIf] [] ``` @@ -64,17 +73,24 @@ New-App [-FileData ] ### ExtensionFileStream ``` New-App [-FileStream ] + [-AddInOverrides ] [-AllowReadWriteMailbox] + [-AllowSetting ] + [-AppState ] + [-AppType ] [-Confirm] [-DefaultStateForUser ] [-DomainController ] [-DownloadOnly] [-Enabled ] + [-Identity ] [-Mailbox ] [-OrganizationApp] [-PrivateCatalog] [-ProvidedTo ] + [-UpdateAppState] [-UserList ] + [-Version ] [-WhatIf] [] ``` @@ -82,17 +98,24 @@ New-App [-FileStream ] ### ExtensionPrivateURL ``` New-App [-Url ] + [-AddInOverrides ] [-AllowReadWriteMailbox] + [-AllowSetting ] + [-AppState ] + [-AppType ] [-Confirm] [-DefaultStateForUser ] [-DomainController ] [-DownloadOnly] [-Enabled ] + [-Identity ] [-Mailbox ] [-OrganizationApp] [-PrivateCatalog] [-ProvidedTo ] + [-UpdateAppState] [-UserList ] + [-Version ] [-WhatIf] [] ``` @@ -100,15 +123,15 @@ New-App [-Url ] ## DESCRIPTION If the app is enabled for the entire organization, users can activate the new app when viewing mail or calendar items within Microsoft Outlook or Outlook on the web. If an installed app isn't enabled, users can enable the app from Outlook on the web Options. Similarly, administrators can enable installed apps from the Exchange admin center or by using the Enable-App or Set-App cmdlet. -For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://docs.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://docs.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). +For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://learn.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://learn.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-App -FileData ([Byte[]](Get-Content -Encoding Byte -Path "C:\Apps\FinanceTestApp.xml" -ReadCount 0)) +New-App -FileData ([System.IO.File]::ReadAllBytes('C:\Apps\FinanceTestApp.xml')) ``` This example installs the Finance Test app manifest file that has been copied to the local hard disk. @@ -122,6 +145,24 @@ This example installs the Contoso CRM app manifest.xml from a URL on the Contoso ## PARAMETERS +### -AddInOverrides +This parameter is available only in the cloud-based service. + +{{ Fill AddInOverrides Description }} + +```yaml +Type: AddInOverrides +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowReadWriteMailbox The AllowReadWriteMailbox switch specifies whether the app allows read/write mailbox permission. You don't need to specify a value with this switch. @@ -138,6 +179,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowSetting +This parameter is available only in the cloud-based service. + +{{ Fill AllowSetting Description }} + +```yaml +Type: AllowSetting +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppState +This parameter is available only in the cloud-based service. + +{{ Fill AppState Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AppType +This parameter is available only in the cloud-based service. + +{{ Fill AppType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -255,7 +350,7 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the location of the app manifest file. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url, or FileData parameter. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -286,8 +381,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity +This parameter is available only in the cloud-based service. + +{{ Fill Identity Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Mailbox -The Mailbox parameter specifies the mailbox where you want to install the app. You can use any value that uniquely identifies the mailbox. For example: For example: +The Mailbox parameter specifies the mailbox where you want to install the app. You can use any value that uniquely identifies the mailbox. For example: - Name - Alias @@ -446,9 +559,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UpdateAppState +This parameter is available only in the cloud-based service. + +{{ Fill UpdateAppState Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Url The Url parameter specifies the full URL location of the app manifest file that you want to install. You need to specify only one source location for the app manifest file. You can specify the app manifest file by using the MarketplaceServicesUrl, Url or FileData parameter. +**Note**: URLs with redirections are not supported in Exchange Server 2016, Exchange Server 2019, and Exchange Online. Use a direct URL to the manifest. + ```yaml Type: Uri Parameter Sets: ExtensionPrivateURL @@ -463,7 +596,7 @@ Accept wildcard characters: False ``` ### -UserList -The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). +The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://learn.microsoft.com/office/dev/add-ins/publish/centralized-deployment). Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: @@ -495,6 +628,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Version +This parameter is available only in the cloud-based service. + +{{ Fill Version Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -516,12 +667,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md new file mode 100644 index 0000000000..669e94235e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AppRetentionCompliancePolicy.md @@ -0,0 +1,398 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancepolicy +applicable: Security & Compliance +title: New-AppRetentionCompliancePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-AppRetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-AppRetentionCompliancePolicy to create app retention compliance policies. App retention & labeling policies target new ways to scope and manage policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### AdaptiveScopeLocation +``` +New-AppRetentionCompliancePolicy [-Name] -AdaptiveScopeLocation -Applications + [-Confirm] + [-Comment ] + [-Enabled ] + [-Force] + [-RestrictiveRetention ] + [-WhatIf] + [] +``` + +### Default +``` +New-AppRetentionCompliancePolicy [-Name] -Applications + [-Comment ] + [-Confirm] + [-Enabled ] + [-ExchangeLocation ] + [-ExchangeLocationException ] + [-Force] + [-ModernGroupLocation ] + [-ModernGroupLocationException ] + [-PolicyRBACScopes ] + [-RestrictiveRetention ] + [-WhatIf] + [] +``` + +## DESCRIPTION +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies in the locations described in [Retention cmdlets for newer locations](https://learn.microsoft.com/purview/retention-cmdlets#retention-cmdlets-for-newer-locations). You can only set the list of included or excluded scopes for all included workloads, which means you likely need to create one policy per workload. + +\*-RetentionCompliance\* cmdlets continue to primarily support the locations described in [Retention cmdlets for older locations](https://learn.microsoft.com/purview/retention-cmdlets#retention-cmdlets-for-older-locations). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AppRetentionCompliancePolicy -Name "Regulation 567 Compliance" -Applications "User:MicrosoftTeams,VivaEngage","Group:MicrosoftTeams,VivaEngage" -ExchangeLocation "Jennifer Petersen","Kitty Nakamura" +``` + +This example creates a static scope retention policy named Regulation 567 Compliance for the Viva Engage user messages of Jennifer Petersen and Kitty Nakamura. + +After you create the retention policy, use the New-AppRetentionComplianceRule cmdlet to create a retention rule and assign it the retention policy to it. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the app retention compliance policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdaptiveScopeLocation +The AdaptiveScopeLocation parameter specifies the adaptive scope location to include in the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Applications +The Applications parameter specifies the applications to include in the policy. + +This parameter uses the following syntax: `"LocationType:App1,LocationType:App2,...LocationType:AppN`: + +`LocationType` is User or Group. + +`App` is a supported value as shown in the following examples. + +- **Microsoft 365 apps**: For example: + + `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:VivaEngage"` + +- **Microsoft Copilot experiences**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` + + **Note**: Even though you must use `CopilotinBusinessApplicationplatformsSales` and `SQLCopilot`, those values are currently irrelevant. + +- **Enterprise AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` + +- **Other AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"` + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the policy. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocation +The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). +- The value All for all mailboxes. You can only use this value by itself. + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeLocationException +The ExchangeLocationException parameter specifies the mailboxes exclude from the policy when you use the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModernGroupLocation +The ModernGroupLocation parameter specifies the Microsoft 365 Groups to include in the policy. Valid values are: + +- A Microsoft 365 Group +- The value All for all Microsoft 365 Groups. You can only use this value by itself. + +To identify the Microsoft 365 Group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModernGroupLocationException +The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude from the policy when you use the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +**Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. + +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictiveRetention +The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: + +- $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. +- $false: Preservation Lock isn't enabled for the policy. This is the default value. + +After a policy has been locked, no one can turn off or disable it, or remove apps from the policy. The only ways that you can modify the policy are by adding apps to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. + +Therefore, before you lock a policy, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md new file mode 100644 index 0000000000..9cf40c975c --- /dev/null +++ b/exchange/exchange-ps/exchange/New-AppRetentionComplianceRule.md @@ -0,0 +1,325 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-appretentioncompliancerule +applicable: Security & Compliance +title: New-AppRetentionComplianceRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-AppRetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the New-AppRetentionComplianceRule to create app retention compliance rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-AppRetentionComplianceRule [-Name] -Policy + [-Comment ] + [-Confirm] + [-ContentMatchQuery ] + [-ExcludedItemClasses ] + [-ExpirationDateOption ] + [-RetentionComplianceAction ] + [-RetentionDuration ] + [-RetentionDurationDisplayHint ] + [-WhatIf] + [] +``` + +### ComplianceTag +``` +New-AppRetentionComplianceRule -Policy + [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentMatchQuery ] + [-ExpirationDateOption ] + [-MachineLearningModelIDs ] + [-RetentionComplianceAction ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-AppRetentionComplianceRule -Name RetUnlimited -Policy "Regulation 567 Compliance" -RetentionDuration Unlimited +``` + +This example creates a new retention rule named RetUnlimited and adds it to the retention policy named Regulation 567 Compliance. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the app retention compliance rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Policy +The Policy parameter specifies the app retention compliance policy that contains the app retention compliance policy rule. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +```yaml +Type: PswsHashtable[] +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: Default, ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedItemClasses +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +- IPM.Note.Microsoft.Conversation +- IPM.Note.Microsoft.Conversation.Voice +- IPM.Note.Microsoft.Missed +- IPM.Note.Microsoft.Missed.Voice +- IPM.Note.Microsoft.Voicemail +- IPM.Note.Microsoft.VoiceMessage.UA +- IPM.Note.Microsoft.Voicemail.UM +- IPM.Note.Microsoft.Voicemail.UM.CA + +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. + +You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDateOption +The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: + +- CreationAgeInDays +- ModificationAgeInDays + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MachineLearningModelIDs +{{ Fill MachineLearningModelIDs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: ComplianceTag +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionComplianceAction +The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: + +- Delete +- Keep +- KeepAndDelete + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: + +- An integer: The hold duration in days. +- Unlimited: The content is held indefinitely. + +```yaml +Type: Unlimited +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDurationDisplayHint +The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. + +- Days +- Months +- Years + +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. + +```yaml +Type: HoldDurationHint +Parameter Sets: Default +Aliases: +Accepted values: Days, Months, Years +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md index 94c71707d6..3a8139e536 100644 --- a/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/New-ApplicationAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-applicationaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection title: New-ApplicationAccessPolicy schema: 2.0.0 @@ -14,14 +14,14 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the New-ApplicationAccessPolicy cmdlet to restrict or deny access to a specific set of mailboxes by an application that uses APIs (Outlook REST, Microsoft Graph, or Exchange Web Services (EWS)). These policies are complementary to the permission scopes that are declared by the application. +> [!IMPORTANT] +> App Access Policies will soon be replaced by Role Based Access Control for Applications. To learn more, see [Role Based Access Control for Exchange Applications](https://learn.microsoft.com/exchange/permissions-exo/application-rbac). -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the New-ApplicationAccessPolicy cmdlet to restrict or deny access to a specific set of mailboxes by an application that uses APIs (Outlook REST, Microsoft Graph, or Exchange Web Services (EWS)). These policies are complementary to the permission scopes that are declared by the application. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX - ``` New-ApplicationAccessPolicy -AccessRight -AppId -PolicyScopeGroupId [-Confirm] @@ -31,11 +31,11 @@ New-ApplicationAccessPolicy -AccessRight -AppId < ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -You can create a limited number of policies in your organization based on a fixed amount of space. If your oganization runs out of space for these policies, you'll see the error: "The total size of App Access Policies exceeded the limit." To maximize the number of policies and reduce the amount of space that's consumed by the policies, set a one space charachter description for the policy. This method will allow aproximately 300 policies (versus a previous limit of 100 policies). +You can create a limited number of policies in your organization based on a fixed amount of space. If your organization runs out of space for these policies, you'll see the error: "The total size of App Access Policies exceeded the limit." To maximize the number of policies and reduce the amount of space that's consumed by the policies, set a one space character description for the policy. This method will allow approximately 300 policies (versus a previous limit of 100 policies). -While scope-based resource access like Mail.Read or Calendar.Read is effective to ensure that the application can only read email or events within a mailbox and not do anything else, application access policies allow admins to enforce limits that are based on a list of mailboxes. For example, apps developed for one country shouldn't have access to data from other countries. Or, or a CRM integration application should only access calendars in the Sales organization and no other departments. +While scope-based resource access like Mail.Read or Calendar.Read is effective to ensure that the application can only read email or events within a mailbox and not do anything else, application access policies allow admins to enforce limits that are based on a list of mailboxes. For example, apps developed for one country/region shouldn't have access to data from other countries/regions. Or, or a CRM integration application should only access calendars in the Sales organization and no other departments. Every API request using the Outlook REST APIs or Microsoft Graph APIs to a target mailbox done by an application is verified using the following rules (in the same order): @@ -123,8 +123,13 @@ Accept wildcard characters: False ``` ### -PolicyScopeGroupID -The PolicyScopeGroupID parameter specifies the recipient to define in the policy. You can use any value that uniquely identifies the recipient. You can also specify a mail enabled security group to restrict/deny access to a large number of user mailboxes. -For example: +The PolicyScopeGroupID parameter specifies the recipient to define in the policy. Valid recipient types are security principals in Exchange Online (users or groups, including nested groups, that can have permissions assigned to them). For example: + +- Mailboxes with associated user accounts (UserMailbox) +- Mail users, also known as mail-enabled users (MailUser) +- Mail-enabled security groups (MailUniversalSecurityGroup) + +You can use any value that uniquely identifies the recipient. For example: - Name - Distinguished name (DN) @@ -132,16 +137,20 @@ For example: - Email address - GUID -This parameter only accepts recipients that are security principals (users or groups that can have permissions assigned to them). The following types of recipients are not security principals, so you can't use them with this parameter: +To verify that a recipient is a security principal, run either of the following commands: `Get-Recipient -Identity | Select-Object IsValidSecurityPrincipal` or `Get-Recipient -ResultSize unlimited | Format-Table -Auto Name,RecipientType,RecipientTypeDetails,IsValidSecurityPrincipal`. -- Discovery mailboxes -- Dynamic distribution groups -- Distribution groups -- Shared mailboxes +You can't use recipients that aren't security principals with this parameter. For example, the following types of recipients won't work: -To verify that a recipient is a security principal, use the syntax `Get-Recipient -Identity | Select-Object IsValidSecurityPrincipal`. +- Discovery mailboxes (DiscoveryMailbox) +- Dynamic distribution groups (DynamicDistributionGroup) +- Distribution groups (MailUniversalDistributionGroup) +- Mail contacts (MailContact) +- Mail-enabled public folders (PublicFolder) +- Microsoft 365 Groups (GroupMailbox) +- Resource mailboxes (RoomMailbox or EquipmentMailbox) +- Shared mailboxes (SharedMailbox) -If you need to scope the policy to shared mailboxes, you can add them to a mail enabled security group. +If you need to scope the policy to shared mailboxes, you can add the shared mailboxes as members of a mail-enabled security group. ```yaml Type: RecipientIdParameter @@ -192,7 +201,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work on this cmdlet. +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 @@ -212,12 +221,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md deleted file mode 100644 index b786009ad5..0000000000 --- a/exchange/exchange-ps/exchange/New-AuditConfigurationPolicy.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-auditconfigurationpolicy -applicable: Security & Compliance Center -title: New-AuditConfigurationPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-AuditConfigurationPolicy - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the New-AuditConfigurationPolicy cmdlet to create audit configuration policies. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -New-AuditConfigurationPolicy -Workload - [-Confirm] - [-DomainController ] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -New-AuditConfigurationPolicy -Workload SharePoint -``` - -This example creates an audit configuration policy for Microsoft SharePoint Online. - -## PARAMETERS - -### -Workload -The Workload parameter specifies where auditing is allowed. Valid values are: - -- Exchange -- OneDriveForBusiness -- SharePoint - -```yaml -Type: Workload -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/New-AuditConfigurationRule.md deleted file mode 100644 index d35e2bcee8..0000000000 --- a/exchange/exchange-ps/exchange/New-AuditConfigurationRule.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-auditconfigurationrule -applicable: Security & Compliance Center -title: New-AuditConfigurationRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the New-AuditConfigurationRule cmdlet to create audit configuration rules. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -New-AuditConfigurationRule -AuditOperation -Workload - [-Confirm] - [-DomainController ] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -New-AuditConfigurationRule -Workload SharePoint -AuditOperation Delete -``` - -This example creates a new audit configuration rule for Microsoft SharePoint Online that audits delete operations. - -## PARAMETERS - -### -AuditOperation -The AuditOperation parameter specifies the operations that are audited by the rule. Valid values are: - -- Administrate -- CheckIn -- CheckOut -- Count -- CreateUpdate -- Delete -- Forward -- MoveCopy -- PermissionChange -- ProfileChange -- SchemaChange -- Search -- SendAsOthers -- View -- Workflow - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Workload -The Workload parameter specifies where the audit configuration policy applies. Valid values are: - -- Exchange -- OneDriveForBusiness -- SharePoint - -```yaml -Type: Workload -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AuthRedirect.md b/exchange/exchange-ps/exchange/New-AuthRedirect.md index 983832c1fb..d885bf6957 100644 --- a/exchange/exchange-ps/exchange/New-AuthRedirect.md +++ b/exchange/exchange-ps/exchange/New-AuthRedirect.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-authredirect +online version: https://learn.microsoft.com/powershell/module/exchange/new-authredirect applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-AuthRedirect schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-AuthRedirect cmdlet to create OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ New-AuthRedirect -AuthScheme -TargetUrl ## DESCRIPTION Exchange 2010 Client Access servers don't support OAuth authentication requests. Use this cmdlet to redirect OAuth authentication requests to Exchange servers that are running later versions of Exchange. This cmdlet is only useful if your organization has Exchange 2010 Client Access servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,7 +64,7 @@ Accept wildcard characters: False ``` ### -TargetUrl -The TargetUrl parameter specifies the FQDN of the Exchange 2013 or later server that has the Client Access server role installed that's responsible for processing the redirected OAuth authentication requests. +The TargetUrl parameter specifies the FQDN of the Exchange Client Access Server that's responsible for processing the redirected OAuth authentication requests. ```yaml Type: String @@ -135,12 +135,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AuthServer.md b/exchange/exchange-ps/exchange/New-AuthServer.md index d625eb297b..5837e8cdb9 100644 --- a/exchange/exchange-ps/exchange/New-AuthServer.md +++ b/exchange/exchange-ps/exchange/New-AuthServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-authserver +online version: https://learn.microsoft.com/powershell/module/exchange/new-authserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-AuthServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-AuthServer cmdlet to create an authorization server object in Microsoft Exchange and specify its AuthMetadataUrl. Exchange honors tokens issued by the authorization server for access by a partner application. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,6 +47,7 @@ New-AuthServer [-Name] -AuthMetadataUrl -Type ### AppSecret ``` New-AuthServer [-Name] -Type + [-ApplicationIdentifier ] [-Confirm] [-DomainController ] [-DomainName ] @@ -58,7 +59,7 @@ New-AuthServer [-Name] -Type ## DESCRIPTION Partner applications authorized by Exchange can access their resources after they're authenticated using server-to-server authentication. A partner application can authenticate by using self-issued tokens trusted by Exchange or by using an authorization server trusted by Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -125,6 +126,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApplicationIdentifier +This parameter is available in the April 18, 2025 Hotfix update (HU) for Exchange 2019 CU15 and Exchange 2016 CU23. + +{{ Fill ApplicationIdentifier Description }} + +```yaml +Type: String +Parameter Sets: AppSecret +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +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. @@ -180,7 +199,7 @@ Accept wildcard characters: False The Enabled parameter specifies whether the authorization server is enabled. Valid values are: - $true: Authorization tokens that are issued by the authorization server are accepted. This is the default value -- $false: Authorization tokens that are issued by the authorization server are are not accepted. +- $false: Authorization tokens that are issued by the authorization server are not accepted. ```yaml Type: Boolean @@ -196,7 +215,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether Exchange should accept certificates from an untrusted certification authority. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -234,12 +253,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md index 27d647ea6f..4c06f72d1a 100644 --- a/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/New-AuthenticationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-authenticationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-authenticationpolicy applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-AuthenticationPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-AuthenticationPolicy cmdlet to create authentication policies in your organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,13 +42,21 @@ New-AuthenticationPolicy [[-Name] ] [-BlockLegacyAuthPop] [-BlockLegacyAuthRpc] [-BlockLegacyAuthWebServices] + [-BlockModernAuthActiveSync] + [-BlockModernAuthAutodiscover] + [-BlockModernAuthImap] + [-BlockModernAuthMapi] + [-BlockModernAuthOfflineAddressBook] + [-BlockModernAuthPop] + [-BlockModernAuthRpc] + [-BlockModernAuthWebServices] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -297,7 +303,7 @@ By default, Basic authentication is blocked for the protocol. Use this switch to Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -534,6 +540,150 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BlockModernAuthActiveSync +This parameter is available only in on-premises Exchange. + +The BlockModernAuthActiveSync switch specifies whether to block modern authentication with Exchange ActiveSync in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthAutodiscover +This parameter is available only in on-premises Exchange. + +The BlockModernAuthAutodiscover switch specifies whether to block modern authentication with Autodiscover in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthImap +This parameter is available only in on-premises Exchange. + +The BlockModernAuthImap switch specifies whether to block modern authentication with IMAP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthMapi +This parameter is available only in on-premises Exchange. + +The BlockModernAuthMapi switch specifies whether to block modern authentication with MAPI in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthOfflineAddressBook +This parameter is available only in on-premises Exchange. + +The BlockModernAuthOfflineAddressBook switch specifies whether to block modern authentication with Offline Address Books in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthPop +This parameter is available only in on-premises Exchange. + +The BlockModernAuthPop switch specifies whether to block modern authentication with POP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthRpc +This parameter is available only in on-premises Exchange. + +The BlockModernAuthRpc switch specifies whether to block modern authentication with RPC in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthWebServices +This parameter is available only in on-premises Exchange. + +The BlockModernAuthWebServices switch specifies whether to block modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +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. @@ -574,12 +724,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md index 273658748a..41c5654713 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-autosensitivitylabelpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-autosensitivitylabelpolicy +applicable: Security & Compliance title: New-AutoSensitivityLabelPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-AutoSensitivityLabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-AutoSensitivityLabelPolicy cmdlet to create auto-labeling policies in your organization. +Use the New-AutoSensitivityLabelPolicy cmdlet to create auto-labeling policies in your organization. Create auto-labeling policy rules using the New-AutoSensitivityLabelRule cmdlet and associate them with the policy to complete the policy creation. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,24 +24,40 @@ For information about the parameter sets in the Syntax section below, see [Excha New-AutoSensitivityLabelPolicy [-Name] -ApplySensitivityLabel [-Comment ] [-Confirm] + [-ExceptIfOneDriveSharedBy ] + [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] [-ExchangeLocation ] [-ExchangeSender ] [-ExchangeSenderException ] [-ExchangeSenderMemberOf ] [-ExchangeSenderMemberOfException ] + [-ExternalMailRightsManagementOwner ] [-Force] + [-Locations ] [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] [-OneDriveLocation ] [-OneDriveLocationException ] + [-OneDriveSharedBy ] + [-OneDriveSharedByMemberOf ] + [-OverwriteLabel ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] [-Priority ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] [-SharePointLocation ] [-SharePointLocationException ] + [-UnifiedAuditLogEnabled ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -50,7 +66,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as New-AutoSensitivityLabelPolicy -Name "GlobalPolicy" -Comment "Primary policy" -SharePointLocation "https://my.url/","https://my.url2/" -OneDriveLocation "https://my.url3/","https://my.url4/" -Mode TestWithoutNotifications -ApplySensitivityLabel "Test" ``` -This example creates an autolabel policy named GlobalPolicy for the specified SharePoint Online and OneDrive for Business locations with the label "Test". The new policy has a descriptive comment and will be in simulation mode on creation. +This example creates an auto-labeling policy named GlobalPolicy for the specified SharePoint and OneDrive locations with the label "Test". The new policy has a descriptive comment and will be in simulation mode on creation. ## PARAMETERS @@ -61,7 +77,7 @@ The Name parameter specifies a unique name for the auto-labeling policy. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -71,13 +87,13 @@ Accept wildcard characters: False ``` ### -ApplySensitivityLabel -The ApplySensitivityLabel parameter specifies the label to use for the autolabel policy. +The ApplySensitivityLabel parameter specifies the label to use for the auto-labeling policy. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -93,7 +109,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -112,7 +128,77 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedBy +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedByMemberOf +{{ Fill ExceptIfOneDriveSharedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopes +{{ Fill ExchangeAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopesException +{{ Fill ExchangeAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -122,26 +208,27 @@ Accept wildcard characters: False ``` ### -ExchangeLocation -The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: +The ExchangeLocation parameter specifies whether to include email messages in the policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null). -- A mailbox -- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). -- The value All for all mailboxes. You can only use this value by itself. +You can use this parameter in the following procedures: -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: +- If you use `-ExchangeLocation All` by itself, the policy applies to email for all internal users. -- Name -- Distinguished name (DN) -- Email address -- GUID +- To include email of specific internal or external users in the policy, use `-ExchangeLocation All` with the ExchangeSender parameter in the same command. Only email of the specified users is included in the policy. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +- To include only email of specific group members in the policy, use `-ExchangeLocation All` with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy. + +- To exclude email of specific internal users from the policy, use `-ExchangeLocation All` with the ExchangeSenderException parameter in the same command. Only email of the specified users is excluded from the policy. + +- To exclude only email of specific group members from the policy, use `-ExchangeLocation All` with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy. + +You can't specify inclusions and exclusions in the same policy. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -151,13 +238,19 @@ Accept wildcard characters: False ``` ### -ExchangeSender -The ExchangeSender parameter specifies which senders to include in the policy. +The ExchangeSender parameter specifies the users whose email is included in the policy. You identify the users by email address. You can specify internal or external email addresses. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -167,13 +260,19 @@ Accept wildcard characters: False ``` ### -ExchangeSenderException -The ExchangeSenderException parameter specifies which senders to exclude in the policy. +The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -183,15 +282,21 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf -The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the auto-labeling policy. You identify the group by its email address. +The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. -You can enter multiple values separated by commas. +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters. + +You can't use this parameter to specify Microsoft 365 Groups. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -201,9 +306,13 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException -The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the auto-labeling policy. You identify the group by its email address. +The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. -You can enter multiple values separated by commas. +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. You can't use this parameter to specify Microsoft 365 Groups. @@ -211,7 +320,25 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMailRightsManagementOwner +The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS. + +This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -221,13 +348,31 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +{{ Fill Locations Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -249,7 +394,39 @@ Type: PolicyMode Parameter Sets: (All) Aliases: Accepted values: Enable, TestWithNotifications, TestWithoutNotifications, Disable, PendingDeletion -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopes +{{ Fill OneDriveAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopesException +{{ Fill OneDriveAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -259,14 +436,15 @@ Accept wildcard characters: False ``` ### -OneDriveLocation -The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value. The value All is currently not supported. +The OneDriveLocation parameter specifies the OneDrive sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. + You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -276,7 +454,7 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException -This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. +This parameter specifies the OneDrive sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -284,7 +462,100 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedBy +The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedByMemberOf +{{ Fill OneDriveSharedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteLabel +The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are: + +- $true: Overwrite the manual label. +- $false: Don't overwrite the manual label. This is the default value. + +This parameter works only on Exchange locations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -300,7 +571,39 @@ The Priority parameter specifies the priority of the policy. The highest priorit Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopes +{{ Fill SharePointAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopesException +{{ Fill SharePointAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -310,14 +613,15 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value. The value All is currently not supported. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to a policy until they have been indexed. +The SharePointLocation parameter specifies the SharePoint sites to include in the policy. You identify the site by its URL value, or you can use the value All to include all sites. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint sites can't be added to a policy until they have been indexed. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -327,7 +631,7 @@ Accept wildcard characters: False ``` ### -SharePointLocationException -This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +This parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -335,7 +639,23 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnifiedAuditLogEnabled +{{ Fill UnifiedAuditLogEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -345,13 +665,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -365,12 +685,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md index 971ce3c636..43a5384ec8 100644 --- a/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/New-AutoSensitivityLabelRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-autosensitivitylabelrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-autosensitivitylabelrule +applicable: Security & Compliance title: New-AutoSensitivityLabelRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-AutoSensitivityLabelRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-AutoSensitivityLabelPolicy cmdlet to create auto-labeling policy rules in your organization. +Use the New-AutoSensitivityLabelRule cmdlet to create auto-labeling rules and associate then with auto-labeling policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,41 +24,66 @@ For information about the parameter sets in the Syntax section below, see [Excha New-AutoSensitivityLabelRule [-Name] -Policy -Workload [-AccessScope ] [-ActivationDate ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] [-Comment ] [-Confirm] [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] + [-ContentPropertyContainsWords ] [-Disabled ] + [-DocumentCreatedBy ] [-DocumentIsPasswordProtected ] [-DocumentIsUnsupported ] + [-DocumentNameMatchesWords ] + [-DocumentSizeOver ] [-ExceptIfAccessScope ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentContainsSensitiveInformation ] [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentPropertyContainsWords ] + [-ExceptIfDocumentCreatedBy ] [-ExceptIfDocumentIsPasswordProtected ] [-ExceptIfDocumentIsUnsupported ] + [-ExceptIfDocumentNameMatchesWords ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] [-ExceptIfFromMemberOf ] + [-ExceptIfHeaderMatchesPatterns ] [-ExceptIfProcessingLimitExceeded ] [-ExceptIfRecipientDomainIs ] + [-ExceptIfSenderDomainIs ] [-ExceptIfSenderIPRanges ] [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-ExceptIfSubjectMatchesPatterns ] [-ExpiryDate ] [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] [-FromMemberOf ] + [-HeaderMatchesPatterns ] [-ImmutableId ] [-Priority ] [-ProcessingLimitExceeded ] [-RecipientDomainIs ] [-ReportSeverityLevel ] [-RuleErrorAction ] + [-SenderDomainIs ] [-SenderIPRanges ] [-SentTo ] + [-SentToMemberOf ] + [-SourceType ] + [-SubjectMatchesPatterns ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -78,7 +103,7 @@ The Name parameter specifies a unique name for the auto-labeling policy rule. If Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -99,7 +124,7 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: Exchange, SharePoint, OneDriveForBusiness -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -120,7 +145,7 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -136,7 +161,51 @@ This parameter is reserved for internal Microsoft use. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressContainsWords +The AnyOfRecipientAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressMatchesPatterns +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -152,7 +221,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -171,7 +240,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -185,11 +254,15 @@ The ContentContainsSensitiveInformation parameter specifies a condition for the This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"; minCount="1"; minConfidence="85"})`. +Exact Data Match sensitive information types are supported only groups. For example: + +`@(@{operator="And"; groups=@(@{name="Default"; operator="Or"; sensitivetypes=@(@{id="<>"; name="<>"; maxcount="-1"; classifiertype="ExactMatch"; mincount="100"; confidencelevel="Medium"})})})` + ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -205,7 +278,25 @@ The ContentExtensionMatchesWords parameter specifies a condition for the auto-la Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentPropertyContainsWords +The ContentPropertyContainsWords parameter specifies a condition for the auto-labeling policy rule that's based on a property match in content. The rule is applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -224,7 +315,23 @@ The Disabled parameter specifies whether the auto-labeling policy rule is enable Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedBy +{{ Fill DocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -234,7 +341,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -243,7 +350,7 @@ The DocumentIsPasswordProtected parameter specifies a condition for the auto-lab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -262,7 +369,57 @@ The DocumentIsUnsupported parameter specifies a condition for the auto-labeling Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentNameMatchesWords +The DocumentNameMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentSizeOver +The DocumentSizeOver parameter specifies a condition for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in auto-labeling policy rules that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -283,7 +440,51 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressContainsWords +The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressMatchesPatterns +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -295,13 +496,13 @@ Accept wildcard characters: False ### -ExceptIfContentContainsSensitiveInformation The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. -This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -317,7 +518,41 @@ The ExceptIfContentExtensionMatchesWords parameter specifies an exception for th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentPropertyContainsWords +The ExceptIfContentPropertyContainsWords parameter specifies an exception for the auto-labeling policy rule that's based on a property match in content. The rule is not applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentCreatedBy +{{ Fill ExceptIfDocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -327,7 +562,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -336,7 +571,7 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -355,7 +590,57 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesWords +The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentSizeOver +The ExceptIfDocumentSizeOver parameter specifies an exception for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this exception in auto-labeling policy rules that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -378,7 +663,51 @@ The ExceptIfFrom parameter specifies an exception for the auto-labeling policy r Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressContainsWords +The ExceptIfFromAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressMatchesPatterns +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -396,7 +725,25 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesPatterns +The HeaderMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -415,7 +762,7 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the aut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -425,13 +772,31 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +The ExceptIfSenderDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -453,7 +818,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -480,7 +845,45 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectMatchesPatterns +The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -496,7 +899,7 @@ This parameter is reserved for internal Microsoft use. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -512,7 +915,51 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressContainsWords +The FromAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressMatchesPatterns +The FromAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -528,7 +975,25 @@ This parameter is reserved for internal Microsoft use. Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesPatterns +The HeaderMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -544,7 +1009,7 @@ This parameter is reserved for internal Microsoft use. Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -564,7 +1029,7 @@ The Policy parameter specifies the auto-labeling policy that contains the auto-l Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -580,7 +1045,7 @@ This parameter is reserved for internal Microsoft use. Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -599,7 +1064,7 @@ The ProcessingLimitExceeded parameter specifies a condition for the auto-labelin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -609,13 +1074,13 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -637,7 +1102,7 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -658,7 +1123,25 @@ Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +The SenderDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -680,7 +1163,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -707,7 +1190,61 @@ You can use this condition in auto-sensitivity policies that are scoped only to Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +{{ Fill SourceType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectMatchesPatterns +The SubjectMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -717,13 +1254,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -737,12 +1274,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md index be91e44dc2..d79e23f643 100644 --- a/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-AutodiscoverVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-autodiscovervirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/new-autodiscovervirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-AutodiscoverVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-AutodiscoverVirtualDirectory cmdlet to create Autodiscover virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,7 +48,7 @@ If your organization has multiple email domains and each requires its own Autodi When you're creating an Autodiscover virtual directory, we recommend that you enable Secure Sockets Layer (SSL) for the Autodiscover service. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -417,12 +417,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md b/exchange/exchange-ps/exchange/New-AvailabilityConfig.md index 0f8bc8c1ca..7019d149b7 100644 --- a/exchange/exchange-ps/exchange/New-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/New-AvailabilityConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-availabilityconfig +online version: https://learn.microsoft.com/powershell/module/exchange/new-availabilityconfig applicable: Exchange Online title: New-AvailabilityConfig schema: 2.0.0 @@ -14,62 +14,45 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the New-AvailabilityConfig cmdlet to create an availability configuration. An availability configuration specifies an existing account that's used to exchange free/busy information between organizations. +Use the New-AvailabilityConfig cmdlet to create the availability configuration that specifies the Microsoft 365 organizations to exchange free/busy information with. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -New-AvailabilityConfig -OrgWideAccount +New-AvailabilityConfig + [-AllowedTenantIds ] [-Confirm] + [-OrgWideAccount ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-AvailabilityConfig -OrgWideAccount "Tony Smith" +New-AvailabilityConfig -AllowedTenantIds "d6b0a40e-029b-43f2-9852-f3724f68ead9","87d5bade-cefc-4067-a221-794aea71922d" ``` -This example creates a new availability configuration. The existing account named Tony Smith will be used to exchange free/busy information between organizations. +This example creates a new availability configuration to share free/busy information with the specified Microsoft 365 organizations. ## PARAMETERS -### -OrgWideAccount -The OrgWideAccount parameter specifies who has permission to issue proxy Availability service requests on an organization-wide basis. You can specify the following types of users or groups (security principals) for this parameter: - -- Mailbox users -- Mail users with a Microsoft account -- Security groups - -You can use any value that uniquely identifies the user or group. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) +### -AllowedTenantIds +The AllowedTenantIds parameter specifies the tenant ID values of Microsoft 365 organization that you want to share free/busy information with (for example, d6b0a40e-029b-43f2-9852-f3724f68ead9). You can specify multiple values separated by commas. A maximum of 25 values are allowed. ```yaml -Type: SecurityPrincipalIdParameter +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -95,6 +78,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OrgWideAccount +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -116,12 +115,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md index 7cb352b1fd..4c31737bf7 100644 --- a/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/exchange/New-AvailabilityReportOutage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-availabilityreportoutage +online version: https://learn.microsoft.com/powershell/module/exchange/new-availabilityreportoutage applicable: Exchange Server 2010 title: New-AvailabilityReportOutage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the New-AvailabilityReportOutage cmdlet to create an outage to add unrecorded issues to availability reporting. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ New-AvailabilityReportOutage [-SiteName] -Comment -DowntimeMin ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,8 +44,8 @@ This example creates a timed injected outage scoped to site Site1 on the selecte ## PARAMETERS -### -Comment -The Comment parameter specifies why the outage was inserted. +### -SiteName +The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. ```yaml Type: String @@ -54,17 +54,17 @@ Aliases: Applicable: Exchange Server 2010 Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DowntimeMinutes -The DowntimeMinutes parameter specifies the number of minutes of downtime to insert into the outage report. +### -Comment +The Comment parameter specifies why the outage was inserted. ```yaml -Type: Double +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 @@ -76,11 +76,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportDate -The ReportDate parameter specifies the date to query for the outage report. +### -DowntimeMinutes +The DowntimeMinutes parameter specifies the number of minutes of downtime to insert into the outage report. ```yaml -Type: ExDateTime +Type: Double Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 @@ -92,17 +92,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteName -The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. +### -ReportDate +The ReportDate parameter specifies the date to query for the outage report. ```yaml -Type: String +Type: ExDateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -128,7 +128,9 @@ Accept wildcard characters: False ``` ### -Force -The Force parameter suppresses the warning or confirmation messages that appear during specific configuration changes. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -196,12 +198,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md index 564e2e045f..87605314fc 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/New-CaseHoldPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-caseholdpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-caseholdpolicy +applicable: Security & Compliance title: New-CaseHoldPolicy schema: 2.0.0 author: chrisda @@ -12,13 +12,16 @@ ms.reviewer: # New-CaseHoldPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-CaseHoldPolicy cmdlet to create new case hold policies in the Microsoft 365 compliance center. +Use the New-CaseHoldPolicy cmdlet to create new case hold policies in the Microsoft Purview compliance portal. -After you use the New-CaseHoldPolicy cmdlet to create a case hold policy, you need to use the New-CaseHoldRule cmdlet to create a case hold rule and assign the rule to the policy. If you don't create a rule for the policy, the hold won't be created, and content locations won't be placed on hold. +> [!NOTE] +> After you use the New-CaseHoldPolicy cmdlet to create a case hold policy, you need to use the New-CaseHoldRule cmdlet to create a case hold rule and assign the rule to the policy. **If you don't create a rule for the policy, the hold won't be created, and content locations won't be placed on hold**. +> +> Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to create multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +39,7 @@ New-CaseHoldPolicy [-Name] -Case ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -45,44 +48,44 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as New-CaseHoldPolicy -Name "Regulation 123 Compliance" -Case "123 Compliance Case" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" ``` -This example creates a case hold policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site for the eDiscovery case named "123 Compliance Case". +This example creates a case hold policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint site for the eDiscovery case named "123 Compliance Case". Remember, after you create the policy, you need to create a rule for the policy by using the New-CaseHoldRule cmdlet. ## PARAMETERS -### -Case -The Case parameter specifies the eDiscovery case that you want to associate with the case hold policy. You can use the following values to identify the eDiscovery case: - -- Name -- Identity (GUID value). - -You can find these values by running the command: Get-ComplianceCase | Format-Table -Auto Name,Status,Identity. +### -Name +The Name parameter specifies the unique name of the case hold policy. If the value contains spaces, enclose the value in quotation marks. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the unique name of the case hold policy. If the value contains spaces, enclose the value in quotation marks. +### -Case +The Case parameter specifies the eDiscovery case that you want to associate with the case hold policy. You can use the following values to identify the eDiscovery case: + +- Name +- Identity (GUID value). + +You can find these values by running the command: Get-ComplianceCase | Format-Table -Auto Name,Status,Identity. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -95,7 +98,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -114,7 +117,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -133,7 +136,7 @@ The Enabled parameter specifies whether the policy is enabled or disabled. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -151,8 +154,8 @@ The ExchangeLocation parameter specifies the mailboxes to include in the policy. To specify a mailbox or distribution group, you can use the following values: - Name -- SMTP address -- Azure AD ObjectId (You can use the [Get-AzureADUser](https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain this value.) +- SMTP address. To specify an inactive mailbox, precede the address with a period (.). +- Microsoft Entra ObjectId. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) or [Get-MgGroup](https://learn.microsoft.com/powershell/module/microsoft.graph.groups/get-mggroup) cmdlets in Microsoft Graph PowerShell to find this value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -162,7 +165,7 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +175,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -194,7 +199,7 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -204,7 +209,7 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online and OneDrive for Business sites to include. You identify a site by its URL value. +The SharePointLocation parameter specifies the SharePoint and OneDrive sites to include. You identify a site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -214,7 +219,7 @@ Sites can't be added to the policy until they have been indexed. If no sites are Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -224,13 +229,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -244,12 +249,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-CaseHoldRule.md b/exchange/exchange-ps/exchange/New-CaseHoldRule.md index 017b7ac8eb..c169c5dfff 100644 --- a/exchange/exchange-ps/exchange/New-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/New-CaseHoldRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-caseholdrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-caseholdrule +applicable: Security & Compliance title: New-CaseHoldRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-CaseHoldRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-CaseHoldRule cmdlet to create new case hold rules in the Microsoft 365 compliance center. +Use the New-CaseHoldRule cmdlet to create new case hold rules in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ New-CaseHoldRule [-Name] -Policy ## DESCRIPTION You need to add the case hold rule to an existing case hold policy using the Policy parameter. Only one rule can be added to each case hold policy. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -46,10 +46,10 @@ This example creates a new case hold rule named 2016 Budget Spreadsheets and add ### Example 2 ```powershell -New-CaseHoldRule -Name "Contoso Case 07172018 Hold 1" -Policy "Contoso Case 07172018" -ContentMatchQuery "received:12/01/2016..12/31/2018" +New-CaseHoldRule -Name "Contoso Case 07172018 Hold 1" -Policy "Contoso Case 07172018" -ContentMatchQuery "received:12/01/2017..12/31/2018" ``` -This example places email messages received by the recipients between December 1, 2016 and December 31, 2018 on hold. +This example places email messages received by the recipients between December 1, 2018 and December 31, 2018 on hold. ## PARAMETERS @@ -60,7 +60,7 @@ The Name parameter specifies a unique name for the case hold rule. If the value Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -80,7 +80,7 @@ The Policy parameter specifies the case hold policy that contains the rule. You Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -96,7 +96,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,7 +115,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -127,13 +127,13 @@ Accept wildcard characters: False ### -ContentMatchQuery The ContentMatchQuery parameter specifies a content search filter. Use this parameter to create a query-based hold so only the content that matches the specified search query is placed on hold. -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -152,7 +152,7 @@ The Disabled parameter specifies whether the case hold rule is enabled or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -162,13 +162,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -182,12 +182,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md index f6beb3e808..2f589a0ceb 100644 --- a/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/New-ClassificationRuleCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-classificationrulecollection +online version: https://learn.microsoft.com/powershell/module/exchange/new-classificationrulecollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-ClassificationRuleCollection schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-ClassificationRuleCollection cmdlet to import new classification rule collections into your organization. -In tSecurity & Compliance Center PowerShell, use the New-DlpSensitiveInformationTypeRulePackage cmdlet. +In tSecurity & Compliance PowerShell, use the New-DlpSensitiveInformationTypeRulePackage cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,13 +31,13 @@ New-ClassificationRuleCollection [-FileData] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-ClassificationRuleCollection -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External Classification Rule Collection.xml" -Encoding Byte -ReadCount 0)) +New-ClassificationRuleCollection -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External Classification Rule Collection.xml')) ``` This example imports the classification rule collection file C:\\My Documents\\External Classification Rule Collection.xml. @@ -47,7 +47,7 @@ This example imports the classification rule collection file C:\\My Documents\\E ### -FileData The FileData parameter specifies the classification rule collection file you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -68,6 +68,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -120,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ClientAccessArray.md b/exchange/exchange-ps/exchange/New-ClientAccessArray.md index 8b2d416ae2..93bc940c38 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessArray.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessArray.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-clientaccessarray +online version: https://learn.microsoft.com/powershell/module/exchange/new-clientaccessarray applicable: Exchange Server 2010 title: New-ClientAccessArray schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the New-ClientAccessArray cmdlet to create an object that represents a load balanced array of Client Access servers within a single Active Directory site. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The New-ClientAccessArray cmdlet creates an object that represents a load balanc Client Access arrays allow Outlook clients in an Active Directory site to access the Client Access servers in the array by using RPC over TCP to a single, unified, fully qualified domain name (FQDN). The RpcClientAccessServer property of new mailbox databases is automatically populated with the FQDN of the Client Access array and this value is used during the creation of Outlook profiles for mailboxes in those databases. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,6 +53,24 @@ This example creates a Client Access array named China CAS Array with the FQDN v ## PARAMETERS +### -Name +The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces, you can't use the Name value to identify the Client Access array for the Get-ClientAccessArray, Remove-ClientAccessArray, or Set-ClientAccessArray cmdlets. + +If you don't use this parameter, the default value is the host part of the Fqdn parameter value. For example, if the Fqdn value is casarray01.contoso.com, the default name value is casarray01. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Fqdn The Fqdn parameter specifies the fully qualified domain name of the Client Access array (for example, casarray01.contoso.com). This is the value that RPC over TCP clients use to connect to the Client Access servers in the array. @@ -70,7 +88,7 @@ Accept wildcard characters: False ``` ### -Site -The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: +The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: - Name - Distinguished name (DN) @@ -126,24 +144,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces, you can't use the Name value to identify the Client Access array for the Get-ClientAccessArray, Remove-ClientAccessArray, or Set-ClientAccessArray cmdlets. - -If you don't use this parameter, the default value is the host part of the Fqdn parameter value. For example, if the Fqdn value is casarray01.contoso.com, the default name value is casarray01. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 - -Required: False -Position: 1 -Default value: None -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. @@ -165,12 +165,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ClientAccessRule.md b/exchange/exchange-ps/exchange/New-ClientAccessRule.md index 54c7d4400f..af5e934438 100644 --- a/exchange/exchange-ps/exchange/New-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/New-ClientAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-clientaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-ClientAccessRule schema: 2.0.0 @@ -12,11 +12,14 @@ ms.reviewer: # New-ClientAccessRule ## SYNOPSIS -This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the New-ClientAccessRule cmdlet to create client access rules. Client access rules help you control access to your organization based on the properties of the connection. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +50,9 @@ New-ClientAccessRule [-Name] -Action ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -**Note**: Currently, not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: +**Note**: Not all protocols support authentication type filters, and even protocols that support authentication type filters don't support all authentication types. The supported combinations are described in the following lists. Use caution when mixing protocols and authentication types in the same rule. + +Protocols that support authentication type filters: - ExchangeActiveSync: BasicAuthentication, OAuthAuthentication, and CertificateBasedAuthentication. - ExchangeAdminCenter: BasicAuthentication and AdfsAuthentication. @@ -56,7 +61,16 @@ Client access rules are like mail flow rules (also known as transport rules) for - POP3: BasicAuthentication and OAuthAuthentication. - RemotePowerShell: BasicAuthentication and NonBasicAuthentication. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +Protocols that don't support authentication type filters: + +- ExchangeWebServices +- OfflineAddressBook +- OutlookAnywhere +- PowerShellWebServices +- REST +- UniversalOutlook + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,40 +90,40 @@ This example creates a new client access rule named Block ActiveSync that blocks ## PARAMETERS -### -Action -The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. +### -Name +The Name parameter specifies a unique name for the client access rule. ```yaml -Type: ClientAccessRulesAction +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the client access rule. +### -Action +The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess. ```yaml -Type: String +Type: ClientAccessRulesAction Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -AnyOfAuthenticationTypes -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The AnyOfAuthenticationTypes parameter specifies a condition for the client access rule that's based on the client's authentication type. @@ -123,6 +137,8 @@ Valid values for this parameter are: You can enter multiple values separated by commas. Don't use quotation marks. +**Note**: Refer to the Description section to see which authentication types can be used with what protocols. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -145,7 +161,7 @@ The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the clien You can enter multiple values separated by commas. -For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://docs.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). +For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://learn.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). ```yaml Type: MultiValuedProperty @@ -217,6 +233,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -265,7 +283,7 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfAuthenticationTypes -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The ExceptAnyOfAuthenticationTypes parameter specifies an exception for the client access rule that's based on the client's authentication type. @@ -279,6 +297,8 @@ Valid values for this parameter are: You can enter multiple values separated by commas. Don't use quotation marks. +**Note**: Refer to the Description section to see which authentication types can be used with what protocols. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -301,7 +321,7 @@ The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for th You can enter multiple values separated by commas. -For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://docs.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). +For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://learn.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). ```yaml Type: MultiValuedProperty @@ -317,7 +337,7 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfProtocols -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The ExceptAnyOfProtocols parameter specifies an exception for the client access rule that's based on the client's protocol. @@ -384,7 +404,7 @@ Accept wildcard characters: False ``` ### -ExceptUsernameMatchesAnyOfPatterns -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -463,7 +483,7 @@ Accept wildcard characters: False ``` ### -UsernameMatchesAnyOfPatterns -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. This parameter does not work with the -AnyOfProtocols UniversalOutlook parameter. @@ -483,24 +503,15 @@ Accept wildcard characters: True ``` ### -UserRecipientFilter -This parameter is available or functional only in the cloud-based service. - -The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPath filter syntax to identify the user. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"City -eq 'Redmond'"`). +This parameter is functional only in the cloud-based service. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter on Exchange cmdlets](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. -You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. - -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - -The filterable properties that you can use with this parameter are: +You can use the following properties with this parameter: - City - Company -- CountryOrRegion +- CountryOrRegion (ISO 3166-1 alpha-2 country code.) - CustomAttribute1 to CustomAttribute15 - Department - Office @@ -508,6 +519,25 @@ The filterable properties that you can use with this parameter are: - StateOrProvince - StreetAddress +The basic syntax for this parameter is `"Property -ComparisonOperator 'Value'"`: + +- Property is one of the filterable properties in the list above (for example `City` or `CustomAttribute1`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. + +For example: + +- `"City -eq 'Redmond'"` +- `"CountryOrRegion -eq 'SG'"`. + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example: + +- `"CustomAttribute1 -eq 'AllowOWA' -and CountryOrRegion -eq AU'"` +- `"(CountryOrRegion -eq 'US' -and Department -eq 'Sales') -or Department -eq 'Research'"`. + +For detailed information about OPATH filter syntax in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + ```yaml Type: String Parameter Sets: (All) @@ -542,12 +572,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ComplianceCase.md b/exchange/exchange-ps/exchange/New-ComplianceCase.md index 057fc9f2f1..6366bff3d0 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/New-ComplianceCase.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancecase -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancecase +applicable: Security & Compliance title: New-ComplianceCase schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-ComplianceCase ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-ComplianceCase cmdlet to create eDiscovery cases in the Microsoft 365 compliance center. You use eDiscovery cases to place content locations on hold, perform Content Searches associated with the case, and export search results. +Use the New-ComplianceCase cmdlet to create eDiscovery cases in the Microsoft Purview compliance portal. You use eDiscovery cases to place content locations on hold, perform Content Searches associated with the case, and export search results. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ New-ComplianceCase [-Name] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -43,14 +43,14 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as New-ComplianceCase -Name "Fabrikam Litigation" ``` -This example creates a new core eDiscovery case named Fabrikam Litigation. +This example creates a new eDiscovery Standard case named Fabrikam Litigation. ### Example 2 ```powershell New-ComplianceCase -Name "Coho Case 03082020" -CaseType AdvancedEdiscovery -ExternalId "SaraDavis v. Coho Winery" ``` -This example creates a new Advanced eDiscovery case named Coho Case 03082020 and specifies an optional case Id of "SaraDavis v. Coho Winery". +This example creates a new eDiscovery Premium case named Coho Case 03082020 and specifies an optional case Id of "SaraDavis v. Coho Winery". ## PARAMETERS @@ -61,7 +61,7 @@ The Name parameter specifies the unique name of the compliance case. The maximum Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -73,13 +73,13 @@ Accept wildcard characters: False ### -CaseType The CaseType parameter specifies the type of compliance case that you want to create. Valid values are: -- AdvancedEdiscovery: Advanced eDiscovery cases are used to manage legal or other types of investigations. +- AdvancedEdiscovery: eDiscovery Premium cases are used to manage legal or other types of investigations. - ComplianceClassifier: This type of case corresponds to a trainable classifier. - ComplianceWorkspace: This value is reserved for internal Microsoft use. - DataInvestigation: Data investigation cases are used to investigate data spillage incidents. - DSR: Data Subject Request (DSR) cases are used to manage General Data Protection Regulation (GDPR) DSR investigations. -- eDiscovery: eDiscovery (also called core eDiscovery) cases are used to manage legal or other types of investigations. This is the default value. -- InsiderRisk: Insider risk cases are use to manage insider risk management cases. Typically, insider risk management cases are manually created in the compliance center to further investigate activity based on an risk alert. +- eDiscovery: eDiscovery (also called eDiscovery Standard) cases are used to manage legal or other types of investigations. This is the default value. +- InsiderRisk: Insider risk cases are use to manage insider risk management cases. Typically, insider risk management cases are manually created in the Microsoft Purview compliance portal to further investigate activity based on a risk alert. - InternalInvestigation: This value is reserved for internal Microsoft use. - SupervisionPolicy: This type of case corresponds to communication compliance policy. @@ -87,7 +87,7 @@ The CaseType parameter specifies the type of compliance case that you want to cr Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -106,7 +106,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -122,7 +122,7 @@ The Description parameter specifies a description for the compliance case. The m Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -138,7 +138,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -154,7 +154,7 @@ The ExternalId parameter specifies an optional ID or external case number that y Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -170,7 +170,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -186,7 +186,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -196,13 +196,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -216,12 +216,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md index 4f9ca1679e..f1f5f46411 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEvent.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEvent -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentionevent +applicable: Security & Compliance title: New-ComplianceRetentionEvent schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-ComplianceRetentionEvent ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-ComplianceRetentionEvent cmdlet to create compliance retention events in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ New-ComplianceRetentionEvent -Name ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,7 +61,7 @@ The Name parameter specifies a unique name for the compliance retention event. T Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -71,7 +71,7 @@ Accept wildcard characters: False ``` ### -AssetId -The AssetId parameter specifies the Property:Value pair found in the properties of SharePoint or OneDrive for Business documents that's used for retention. For example: +The AssetId parameter specifies the Property:Value pair found in the properties of SharePoint or OneDrive documents that's used for retention. For example: - Product codes that you can use to retain content for only a specific product. - Project codes that you can use to retain content for only a specific project. @@ -81,7 +81,7 @@ The AssetId parameter specifies the Property:Value pair found in the properties Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -97,7 +97,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -116,7 +116,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -132,7 +132,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -144,13 +144,13 @@ Accept wildcard characters: False ### -EventDateTime The EventDateTime parameter specifies the date-time of the event. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -160,7 +160,7 @@ Accept wildcard characters: False ``` ### -EventTags -The EventTags parameter specifies the GUID value of the labels tha are associated with the compliance retention event. Run the following command to see the available GUID values: `Get-ComplianceTag | Format-Table Name,GUID`. +The EventTags parameter specifies the GUID value of the labels that are associated with the compliance retention event. Run the following command to see the available GUID values: `Get-ComplianceTag | Format-Table Name,GUID`. You can specify multiple values separated by commas. @@ -168,7 +168,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -184,7 +184,7 @@ The EventType parameter specifies the GUID value of the event that will start th Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -194,13 +194,13 @@ Accept wildcard characters: False ``` ### -ExchangeAssetIdQuery -The ExchangeAssetIdQuery parameter specifies the keywords that are used to scope Exchange content for the compliance retention event. For details, see [Keyword queries and search conditions for Content Search](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). +The ExchangeAssetIdQuery parameter specifies the keywords that are used to scope Exchange content for the compliance retention event. For details, see [Keyword queries and search conditions for Content Search](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -216,7 +216,7 @@ Accept wildcard characters: False Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -226,13 +226,13 @@ Accept wildcard characters: False ``` ### -SharePointAssetIdQuery -The SharePointAssetIdQuery parameter specifies one or more the Property:Value pairs that you've specified in the properties (also known as Columns) of SharePoint and OneDrive for Business documents to scope the compliance retention event. +The SharePointAssetIdQuery parameter specifies one or more the Property:Value pairs that you've specified in the properties (also known as Columns) of SharePoint and OneDrive documents to scope the compliance retention event. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -242,13 +242,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -262,12 +262,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md index c391ea022e..f8097fbf29 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/New-ComplianceRetentionEventType.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/New-ComplianceRetentionEventType -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-complianceretentioneventtype +applicable: Security & Compliance title: New-ComplianceRetentionEventType schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-ComplianceRetentionEventType ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-ComplianceRetentionEventType cmdlet to create retention event types in the Microsoft 365 compliance center. +Use the New-ComplianceRetentionEventType cmdlet to create retention event types in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ New-ComplianceRetentionEventType -Name ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -49,7 +49,7 @@ The Name parameter specifies the unique name of the retention event type. The ma Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -65,7 +65,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -84,7 +84,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +94,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -114,12 +114,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearch.md b/exchange/exchange-ps/exchange/New-ComplianceSearch.md index f0c63f8209..bb3b8def59 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: New-ComplianceSearch schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the New-ComplianceSearch cmdlet to create compliance searches in Exchange Server 2016 or later and in the Microsoft 365 compliance center. You use this cmdlet to define the search criteria. +Use the New-ComplianceSearch cmdlet to create compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. You use this cmdlet to define the search criteria. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,11 +49,11 @@ A compliance search requires at least one location. For example, mailboxes using After you create a compliance search using the New-ComplianceSearch cmdlet, you run the search using the Start-ComplianceSearch cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -89,7 +89,7 @@ Don't use spaces in the value of this parameter if you plan on using the Case pa Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -115,7 +115,7 @@ The mailbox types that are affected by the value of this parameter include: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -127,9 +127,9 @@ Accept wildcard characters: False ### -Case This parameter is available only in the cloud-based service. -The Case parameter specifies the name of a Core eDiscovery case to associate the new compliance search with. If the value contains spaces, enclose the value in quotation marks. +The Case parameter specifies the name of an eDiscovery Standard case to associate the new compliance search with. If the value contains spaces, enclose the value in quotation marks. -You can't use this parameter to create compliance searches associated with Advanced eDiscovery cases. +You can't use this parameter to create compliance searches associated with eDiscovery Premium cases. If the Name parameter contains spaces, the value of the ExchangeLocation parameter is cleared when you use the Case parameter. @@ -137,7 +137,7 @@ If the Name parameter contains spaces, the value of the ExchangeLocation paramet Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -156,7 +156,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -168,13 +168,13 @@ Accept wildcard characters: False ### -ContentMatchQuery The ContentMatchQuery parameter specifies a content search filter. -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -190,7 +190,7 @@ The Description parameter specifies an optional description for the compliance s Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -212,7 +212,7 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -222,7 +222,7 @@ Accept wildcard characters: False ``` ### -ExchangeLocationExclusion -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -235,7 +235,7 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -245,13 +245,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -271,7 +273,7 @@ Also, if a content location was placed on a query-based case hold, only items th Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -287,7 +289,7 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -308,7 +310,7 @@ The IncludeUserAppContent parameter specifies that you want to search the cloud- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -320,13 +322,13 @@ Accept wildcard characters: False ### -Language The Language parameter specifies the language for the compliance search. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -362,7 +364,7 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -380,7 +382,7 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -392,7 +394,7 @@ Accept wildcard characters: False ### -SharePointLocation This parameter is available only in the cloud-based service. -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -400,7 +402,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -418,7 +420,7 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -452,7 +454,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -466,12 +468,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md index b1f868f964..e2b6541d63 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSearchAction.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancesearchaction -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesearchaction +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: New-ComplianceSearchAction schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the New-ComplianceSearchAction cmdlet to create actions for content searches in Exchange Server and in the Microsoft 365 compliance center. +Use the New-ComplianceSearchAction cmdlet to create actions for content searches in Exchange Server and in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -98,11 +98,11 @@ After you create a content search using the New-ComplianceSearch cmdlet and run In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In Microsoft 365, the account that you use to run this cmdlet must have a valid Microsoft 365 license assigned. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -120,6 +120,8 @@ New-ComplianceSearchAction -SearchName "Project X" -Export This example creates an export search action for the content search named Project X. +**Note**: After May 26, 2025, this example no longer works. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + ### Example 3 ```powershell New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDelete @@ -128,12 +130,13 @@ New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeTy This example deletes the search results returned by a content search named Remove Phishing Message. Note that unindexed items aren't deleted when you use the Purge parameter. ### Example 4 - -``` -New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip +```powershell +New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPst -Format FxStream ``` -This example exports the results returned by the content search named "Case 321 All Sites". The search results are compressed and exported to a single ZIP file. If the search included any Exchange locations, the search results are exported as one PST file per mailbox (the default value of the ExchangeArchiveFormat parameter). +This example exports the results returned by the content search named "Case 321 All Sites". The search results are compressed and exported to a single ZIP file. If the search included any Exchange locations, the search results are exported as one PST file per mailbox. + +**Note**: After May 26, 2025, this example no longer works. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). ## PARAMETERS @@ -146,7 +149,7 @@ You can find the content search by running the command Get-ComplianceSearch | Fo Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -164,7 +167,7 @@ The ActionName parameter specifies a name for the content search action. You use Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -182,7 +185,7 @@ To specify the format for Exchange search results, use the ExchangeArchiveFormat Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -197,11 +200,13 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -211,13 +216,15 @@ Accept wildcard characters: False ``` ### -EnableDedupe +This parameter is available only in the cloud-based service. + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: Export Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -227,9 +234,12 @@ Accept wildcard characters: False ``` ### -ExchangeArchiveFormat -This parameter is available or functional only in the cloud-based service. -This parameter requires the Export role in Security & Compliance Center PowerShell. By default, this role is assigned only to the eDiscovery Manager role group. +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This parameter is functional only in the cloud-based service. + +This parameter requires the Export role in Security & Compliance PowerShell. By default, this role is assigned only to the eDiscovery Manager role group. The ExchangeArchiveFormat parameter specifies how to export Exchange search results. Valid values are: @@ -238,7 +248,7 @@ The ExchangeArchiveFormat parameter specifies how to export Exchange search resu - SingleFolderPst: One PST file with a single root folder for the entire export. - IndividualMessage: Export each message as an .msg message file. This is the default value. - PerUserZip: One ZIP file for each mailbox. Each ZIP file contains the exported .msg message files from the mailbox. -- SingleZip: One ZIP file for all mailboxes. The ZIP file contains all exported .msg message files from all mailboxes. This output setting is only available in PowerShell. +- SingleZip: One ZIP file for all mailboxes. The ZIP file contains all exported .msg message files from all mailboxes. This output setting is available only in PowerShell. To specify the format for SharePoint and OneDrive search results, use the SharePointArchiveFormat parameter. @@ -246,7 +256,7 @@ To specify the format for SharePoint and OneDrive search results, use the ShareP Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -256,9 +266,11 @@ Accept wildcard characters: False ``` ### -Export -This parameter is available or functional only in the cloud-based service. +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). -This parameter requires the Export role in Security & Compliance Center PowerShell. By default, this role is assigned only to the eDiscovery Manager role group. +This parameter is functional only in the cloud-based service. + +This parameter requires the Export role in Security & Compliance PowerShell. By default, this role is assigned only to the eDiscovery Manager role group. The Export switch specifies the action for the content search is to export the full set of results that match the search criteria. You don't need to specify a value with this switch. @@ -268,7 +280,7 @@ To only return the information about each detected item in a report, use the Rep Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -278,13 +290,15 @@ Accept wildcard characters: False ``` ### -FileTypeExclusionsForUnindexedItems +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + The FileTypeExclusionsForUnindexedItems specifies the file types to exclude because they can't be indexed. You can specify multiple values separated by commas. ```yaml Type: String[] Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -294,13 +308,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -310,11 +326,11 @@ Accept wildcard characters: False ``` ### -Format -In Security & Compliance Center PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. +In Security & Compliance PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. The Format parameter specifies the format of the search results when you use the Export switch. Valid values are: -- FxStream: Export to PST files. This is the only option that's available when you export search results from the Microsoft 365 compliance center. +- FxStream: Export to PST files. This is the only option that's available when you export search results from the Microsoft Purview compliance portal. - Mime: Export to .eml message files. This the default value when you use cmdlets to export the search results. - Msg: Export to .msg message files. @@ -322,7 +338,7 @@ The Format parameter specifies the format of the search results when you use the Type: ComplianceDataTransferFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -338,7 +354,7 @@ The IncludeCredential switch specifies whether to include the credential in the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -348,6 +364,8 @@ Accept wildcard characters: False ``` ### -IncludeSharePointDocumentVersions +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + This parameter is available only in the cloud-based service. The IncludeSharePointDocumentVersions parameter specifies whether to export previous versions of the document when you use the Export switch. Valid values are: @@ -359,7 +377,7 @@ The IncludeSharePointDocumentVersions parameter specifies whether to export prev Type: Boolean Parameter Sets: Export Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -375,7 +393,7 @@ This parameter is reserved for internal Microsoft use. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -385,7 +403,9 @@ Accept wildcard characters: False ``` ### -NotifyEmail -In Security & Compliance Center PowerShell, this parameter requires the Export role. By default, this is assigned only to the eDiscovery Manager role group. +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +In Security & Compliance PowerShell, this parameter requires the Export role. By default, this is assigned only to the eDiscovery Manager role group. The NotifyEmail parameter specifies the email address target for the search results when you use the Export switch. @@ -395,7 +415,7 @@ The recipient you specify is in the To: field of the message. Type: String Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -405,7 +425,9 @@ Accept wildcard characters: False ``` ### -NotifyEmailCC -In Security & Compliance Center PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +In Security & Compliance PowerShell, this parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. The NotifyEmailCC parameter specifies the email address target for the search results when you use the Export switch. @@ -415,7 +437,7 @@ The recipient you specify is in the Cc: field of the message. Type: String Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -425,7 +447,7 @@ Accept wildcard characters: False ``` ### -Preview -In Security & Compliance Center PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. +In Security & Compliance PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. The Preview switch specifies the action for the content search is to preview the results that match the search criteria. You don't need to specify a value with this switch. @@ -433,7 +455,7 @@ The Preview switch specifies the action for the content search is to preview the Type: SwitchParameter Parameter Sets: Preview Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -443,12 +465,15 @@ Accept wildcard characters: False ``` ### -Purge -The Purge switch specifies the action for the content search is to remove items that match the search criteria. You don't need to specify a value with this switch. +**Note**: In Security & Compliance PowerShell, this switch is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. -**Notes**: +The Purge switch specifies the action for the content search is to remove items that match the search criteria. You don't need to specify a value with this switch. - A maximum of 10 items per mailbox can be removed at one time. Because the capability to search for and remove messages is intended to be an incident-response tool, this limit helps ensure that messages are quickly removed from mailboxes. This action isn't intended to clean up user mailboxes. -- You can remove items from a maximum of 50,000 mailboxes using a single content search. To remove items from more than 50,000 mailboxes, you'll have to create separate content searches. For more information, see [Search for and delete email messages in your Microsoft 365 organization](https://docs.microsoft.com/microsoft-365/compliance/search-for-and-delete-messages-in-your-organization). + + **Tip**: To purge more than 10 items, refer to [ediscoverySearch: purgeData](https://learn.microsoft.com/graph/api/security-ediscoverysearch-purgedata) in the Microsoft Graph API, which allows purging a maximum of 100 items per location. + +- You can remove items from a maximum of 50,000 mailboxes using a single content search. To remove items from more than 50,000 mailboxes, you'll have to create separate content searches. For more information, see [Search for and delete email messages in your Microsoft 365 organization](https://learn.microsoft.com/purview/ediscovery-search-for-and-delete-email-messages). - Unindexed items aren't removed from mailboxes when you use this switch. - The value of the PurgeType parameter controls how the items are removed. @@ -456,7 +481,7 @@ The Purge switch specifies the action for the content search is to remove items Type: SwitchParameter Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -466,6 +491,8 @@ Accept wildcard characters: False ``` ### -PurgeType +**Note**: In Security & Compliance PowerShell, this parameter is available only in the Search and Purge role. By default, this role is assigned only to the Organization Management and Data Investigator role groups. + The PurgeType parameter specifies how to remove items when the action is Purge. Valid values are: - SoftDelete: Purged items are recoverable by users until the deleted item retention period expires. @@ -475,7 +502,7 @@ The PurgeType parameter specifies how to remove items when the action is Purge. Type: ComplianceDestroyType Parameter Sets: Purge Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -491,7 +518,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -507,7 +534,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -517,7 +544,9 @@ Accept wildcard characters: False ``` ### -Report -This parameter is available or functional only in the cloud-based service. +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This parameter is functional only in the cloud-based service. The Report switch specifies the action for the content search is to export a report about the results (information about each item instead of the full set of results) that match the search criteria. You don't need to specify a value with this switch. @@ -525,7 +554,7 @@ The Report switch specifies the action for the content search is to export a rep Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -535,13 +564,15 @@ Accept wildcard characters: False ``` ### -RetentionReport +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + The RetentionReport switch specifies the action for the content search is to export a retention report. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -557,7 +588,7 @@ The RetryOnError switch specifies whether to retry the action on any items that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -567,22 +598,22 @@ Accept wildcard characters: False ``` ### -Scenario -In Security & Compliance Center PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. +In Security & Compliance PowerShell, this parameter requires the Preview role. By default, this role is assigned only to the eDiscovery Manager role group. -The Scenario parameter specifies the scenario type when you use the Export switch. Valid values are: +The Scenario parameter specifies the scenario type. Valid values are: -- AnalyzeWithZoom: Prepare the search results for processing in Microsoft 365 Advanced eDiscovery. -- General: Exports the search results to the local computer. Emails are exported to .pst files. SharePoint and OneDrive for Business documents are exported in their native Office formats. -- GenerateReportsOnly: -- Inventory: -- RetentionReports: -- TriagePreview: +- AnalyzeWithZoom: Prepare the search results for processing in Microsoft Purview eDiscovery Premium. +- General: Exports the search results to the local computer. Emails are exported to .pst files. SharePoint and OneDrive documents are exported in their native Office formats. +- GenerateReportsOnly +- Inventory +- RetentionReports +- TriagePreview ```yaml Type: ComplianceSearchActionScenario Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -592,19 +623,19 @@ Accept wildcard characters: False ``` ### -Scope +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + The Scope parameter specifies the items to include when the action is Export. Valid values are: - IndexedItemsOnly - UnindexedItemsOnly - BothIndexedAndUnindexedItems -This parameter is only meaningful for content searches where the IncludeUnindexedItemsEnabled parameter is set to $true. - ```yaml Type: ComplianceExportScope Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -624,7 +655,7 @@ You can find content search names by running the command Get-ComplianceSearch | Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -634,7 +665,9 @@ Accept wildcard characters: False ``` ### -SharePointArchiveFormat -This parameter is available or functional only in the cloud-based service. +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This parameter is functional only in the cloud-based service. This parameter requires the Export role. By default, this role is assigned only to the eDiscovery Manager role group. @@ -642,7 +675,7 @@ The SharePointArchiveFormat parameter specifies how to export SharePoint and One - IndividualMessage: Export the files uncompressed. This is the default value. - PerUserZip: One ZIP file for each user. Each ZIP file contains the exported files for the user. -- SingleZip: One ZIP file for all users. The ZIP file contains all exported files from all users. This output setting is only available in PowerShell. +- SingleZip: One ZIP file for all users. The ZIP file contains all exported files from all users. This output setting is available only in PowerShell. To specify the format for Exchange search results, use the ExchangeArchiveFormat parameter. @@ -650,7 +683,7 @@ To specify the format for Exchange search results, use the ExchangeArchiveFormat Type: ComplianceExportArchiveFormat Parameter Sets: Export Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -660,6 +693,10 @@ Accept wildcard characters: False ``` ### -ShareRootPath +This parameter is available only in on-premises Exchange. + +**Note**: After May 26, 2025, this parameter is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + {{ Fill ShareRootPath Description }} ```yaml @@ -682,7 +719,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -692,7 +729,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -700,7 +737,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -714,12 +751,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md index 560695c1ad..cf258e62c7 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/New-ComplianceSecurityFilter.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancesecurityfilter -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancesecurityfilter +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: New-ComplianceSecurityFilter schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-ComplianceSecurityFilter ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-ComplianceSecurityFilter cmdlet to create compliance security filters in the Microsoft 365 compliance center. These filters allow specified users to search only a subset of mailboxes and SharePoint Online or OneDrive for Business sites in your Microsoft 365 organization. +Use the New-ComplianceSecurityFilter cmdlet to create compliance security filters in the Microsoft Purview compliance portal. These filters allow specified users to search only a subset of mailboxes and SharePoint or OneDrive sites in your Microsoft 365 organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +31,9 @@ New-ComplianceSecurityFilter -Action -Filte ``` ## DESCRIPTION -Compliance security filters work with compliance searches in the Microsoft 365 compliance center (\*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (\*-MailboxSearch cmdlets). +Compliance security filters work with compliance searches in the Microsoft Purview compliance portal (\*-ComplianceSearch cmdlets), not In-Place eDiscovery searches in Exchange Online (\*-MailboxSearch cmdlets). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -46,60 +46,26 @@ This example allows the user annb to perform all compliance search actions only ### Example 2 ```powershell -New-ComplianceSecurityFilter -FilterName MarketingFilter -Users donh,suzanf -Filters "Mailbox_CustomAttribute1 -eq 'Marketing'" -Action Search -``` - -This example allows the users donh and suzanf to search only the mailboxes that have the value Marketing for the CustomAttribute1 mailbox property. - -### Example 3 -```powershell New-ComplianceSecurityFilter -FilterName USDiscoveryManagers -Users "US Discovery Managers" -Filters "Mailbox_CountryCode -eq '840'" -Action All ``` This example allows members of the US Discovery Managers role group to perform all compliance search actions only on mailboxes in the United States. -### Example 4 -```powershell -$DG = Get-DistributionGroup "Ottawa Users" -New-ComplianceSecurityFilter -FilterName DGFilter -Users eDiscoveryManager -Filters "Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'" -Action Search -``` - -This example assigns allows members of the eDiscovery Manager role group to only search the mailboxes of members of the Ottawa Users distribution group. - -This example requires you to connect to Security & Compliance Center PowerShell and Exchange Online PowerShell in the same remote PowerShell session. For instructions, see [Configure permissions filtering for Compliance Search](https://docs.microsoft.com/microsoft-365/compliance/permissions-filtering-for-content-search). - -### Example 5 -```powershell -$DG = Get-DistributionGroup "Executive Team" -New-ComplianceSecurityFilter -FilterName NoExecutivesPreview -Users all -Filters "Mailbox_MemberOfGroup -ne '$($DG.DistinguishedName)'" -Action Purge -``` - -This example prevents any user from deleting content from the mailboxes of members of the Executive Team distribution group. - -This example requires you to connect to Security & Compliance Center PowerShell and Exchange Online PowerShell in the same remote PowerShell session. For instructions, see [Configure permissions filtering for Compliance Search](https://docs.microsoft.com/microsoft-365/compliance/permissions-filtering-for-content-search). - -### Example 6 +### Example 3 ```powershell New-ComplianceSecurityFilter -FilterName EmailDateRestrictionFilter -Users donh@contoso.com -Filters "MailboxContent_Received -ge '01-01-2018' -and MailboxContent_Received -le '12-31-2018'" -Action All ``` This example restricts the user to performing all compliance search actions only on email messages sent during the calendar year 2018. -### Example 7 -```powershell -New-ComplianceSecurityFilter -FilterName OneDriveOnly -Users "OneDrive eDiscovery Managers" -Filters "Site_Path -like 'https://contoso-my.sharepoint.com/personal*'" -Action Search -``` - -This example allows members of the OneDrive eDiscovery Managers custom role group to only search for content in OneDrive for Business locations in the organization. - -### Example 8 +### Example 4 ```powershell New-ComplianceSecurityFilter -FilterName DocumentDateRestrictionFilter -Users donh@contoso.com -Filters "SiteContent_LastModifiedTime -ge '01-01-2018' -and SiteContent_LastModifiedTime -le '12-31-2018'" -Action All ``` This example restricts the user to performing all compliance search actions on documents that were last changed sometime in the calendar year 2018. -### Example 9 +### Example 5 ```powershell New-ComplianceSecurityFilter -FilterName NoEXO -Users suzanf@contoso.com -Filters "Mailbox_Alias -notlike '*'" -Action All ``` @@ -111,7 +77,7 @@ This example prevents the user from performing any compliance search actions on ### -Action The Action parameter specifies that type of search action that the filter is applied to. Valid values are: -- Export: The filter is applied when exporting search results, or preparing them for analysis in Microsoft 365 Advanced eDiscovery. +- Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. - Preview: The filter is applied when previewing search results. - Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. - Search: The filter is applied when running a search. @@ -121,7 +87,7 @@ The Action parameter specifies that type of search action that the filter is app Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -137,7 +103,7 @@ The FilterName parameter specifies the name for the compliance security filter. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -159,7 +125,7 @@ You can't specify distribution groups with this parameter. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -178,7 +144,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -194,7 +160,7 @@ The Description parameter specifies a description for the compliance security fi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -206,19 +172,19 @@ Accept wildcard characters: False ### -Filters The Filters parameter specifies the search criteria for the compliance security filter. The filters are applied to the users specified by the Users parameter. You can create three different types of filters: -- Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is `MailboxContent_:`, where `` specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, `MailboxContent_recipients:contoso.com` allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable message properties, see [Keyword queries for Compliance Search](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). -- Site and site content filter: There are two SharePoint Online and OneDrive for Business site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://docs.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. +- Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is `MailboxContent_`, where `` specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, `"MailboxContent_Recipients -like 'contoso.com'"` allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable email properties, see [Keyword queries for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions#searchable-email-properties). +- Site and site content filter: There are two SharePoint and OneDrive site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://learn.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. -You have to create a search permissions filter to explicitly prevent users from searching any content location in a specific Microsoft 365 service (such as preventing a user from searching Exchange mailboxes or SharePoint sites). In other words, creating a search permissions filter that allows a user to search all SharePoint sites in the organization doesn't prevent that user from searching mailboxes. For example, to allow a SharePoint admin to only search SharePoint sites, you have to create a create a filter that prevents them from mailboxes (see Example 9). Similarly, to allow an Exchange admin to only search mailboxes, you have to create a create a filter that prevents them from searching sites. +You need to create a search permissions filter to explicitly prevent users from searching any content location in a specific Microsoft 365 service (such as preventing a user from searching Exchange mailboxes or SharePoint sites). In other words, creating a search permissions filter that allows a user to search all SharePoint sites in the organization doesn't prevent that user from searching mailboxes. For example, to allow a SharePoint admin to only search SharePoint sites, you need to create a filter that prevents them from searching mailboxes (as described in Example 5). Similarly, to allow an Exchange admin to only search mailboxes, you need to create a filter that prevents them from searching sites. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -247,7 +213,7 @@ If you don't use this parameter in a multi-geo tenant, eDiscovery searches are p Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -257,13 +223,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -277,12 +243,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ComplianceTag.md b/exchange/exchange-ps/exchange/New-ComplianceTag.md index 9498a8dfb1..9de8c0fca4 100644 --- a/exchange/exchange-ps/exchange/New-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/New-ComplianceTag.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-compliancetag -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-compliancetag +applicable: Security & Compliance title: New-ComplianceTag schema: 2.0.0 author: chrisda @@ -12,23 +12,28 @@ ms.reviewer: # New-ComplianceTag ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-ComplianceTag cmdlet to create retention labels in the Microsoft 365 compliance center. Retention labels apply retention settings to content. +Use the New-ComplianceTag cmdlet to create retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Default ``` New-ComplianceTag [-Name] + [-AutoApprovalPeriod ] [-Comment ] + [-ComplianceTagForNextStage ] [-Confirm] [-EventType ] [-FilePlanProperty ] + [-FlowId ] [-Force] [-IsRecordLabel ] - + [-IsRecordUnlockedAsDefault ] + [-MultiStageReviewProperty ] [-Notes ] [-Regulatory ] [-RetentionAction ] @@ -39,8 +44,20 @@ New-ComplianceTag [-Name] [] ``` +### PriorityCleanup +``` +New-ComplianceTag [-Name] -RetentionAction -RetentionDuration -RetentionType + -MultiStageReviewProperty [-PriorityCleanup] + [-Comment ] + [-Confirm] + [-Force] + [-Notes ] + [-WhatIf] + [] +``` + ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -64,7 +81,7 @@ The Name parameter specifies a unique name for the label. If the value contains Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -73,6 +90,137 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionAction +The RetentionAction parameter specifies the action for the label. Valid values are: + +- Delete +- Keep +- KeepAndDelete + +```yaml +Type: String +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: + +- A positive integer. +- The value unlimited. + +```yaml +Type: Unlimited +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Unlimited +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionType +The RetentionType parameter specifies whether the retention duration is calculated from the content creation date, tagged date, or last modification date. Valid values are: + +- CreationAgeInDays +- EventAgeInDays +- ModificationAgeInDays +- TaggedAgeInDays + +```yaml +Type: String +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoApprovalPeriod +{{ Fill AutoApprovalPeriod Description }} + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Comment The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". @@ -80,7 +228,23 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceTagForNextStage +{{ Fill ComplianceTagForNextStage Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -99,7 +263,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -121,7 +285,7 @@ You can use the Get-RetentionComplianceRule cmdlet to view the available retenti Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -164,7 +328,7 @@ You use the second variable as the value for this parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -173,33 +337,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +### -FlowId +**Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow. -### -IsRecordLabel -The IsRecordLabel parameter specifies whether the label is a record label. Valid values are: +You can find the GUID value of the flow by using either of the following methods: -- $true: The label is a record label. Once the label is applied to content, the label can't be removed. -- $false: The label isn't a record label. This is the default value. +- Navigate to the flow from the Power Automate portal. The GUID value of the flow is in the URL. +- Use the Power Automate action named 'List flows as admin'. ```yaml -Type: Boolean +Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -208,22 +360,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MultiStageReviewProperty -The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: - -`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` - -For example: - -`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'` +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -This syntax is a JSON object that defines each review stage id, review stage name, and list of reviewers. +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -232,14 +378,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Notes -The Notes parameter specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). +### -IsRecordLabel +The IsRecordLabel parameter specifies whether the label is a record label. Valid values are: + +- $true: The label is a record label. Once the label is applied to content, the label can't be removed. +- $false: The label isn't a record label. This is the default value. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -248,14 +397,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Regulatory -{{ Fill Regulatory Description }} +### -IsRecordUnlockedAsDefault +{{ Fill IsRecordUnlockedAsDefault Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -264,18 +413,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RetentionAction -The RetentionAction parameter specifies the action for the label. Valid values are: +### -MultiStageReviewProperty +The MultiStageReviewProperty parameter specifies the multi-stage review properties to include in the label. This parameter uses the following syntax: -- Delete -- Keep -- KeepAndDelete +`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[reviewer1,reviewer2,...reviewerN]},{"StageName":"Stage2","Reviewers":[reviewer1,reviewer2,...reviewerN]},]}'` + +For example: + +`'{"MultiStageReviewSettings":[{"StageName":"Stage1","Reviewers":[jie@contoso.onmicrosoft.com]},{"StageName":"Stage2","Reviewers":[bharath@contoso.onmicrosoft.com,helen@contoso.onmicrosoft.com]},]}'` + +This syntax is a JSON object that defines each review stage id, review stage name, and list of reviewers. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -284,17 +437,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RetentionDuration -The RetentionDuration parameter specifies the number of days to retain the content. Valid values are: - -- A positive integer. -- The value unlimited. +### -Notes +The Notes parameter specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). ```yaml -Type: Unlimited +Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -303,19 +453,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RetentionType -The RetentionType parameter specifies whether the retention duration is calculated from the content creation date, tagged date, or last modification date. Valid values are: - -- CreationAgeInDays -- EventAgeInDays -- ModificationAgeInDays -- TaggedAgeInDays +### -Regulatory +{{ Fill Regulatory Description }} ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -331,7 +476,7 @@ The ReviewerEmail parameter specifies the email address of a reviewer for Delete Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -341,13 +486,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -361,12 +506,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DataClassification.md b/exchange/exchange-ps/exchange/New-DataClassification.md index 3bf6fa63b1..ee21f6fc1a 100644 --- a/exchange/exchange-ps/exchange/New-DataClassification.md +++ b/exchange/exchange-ps/exchange/New-DataClassification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dataclassification +online version: https://learn.microsoft.com/powershell/module/exchange/new-dataclassification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-DataClassification schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # New-DataClassification ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [New-DlpSensitiveInformationType](https://docs.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype) cmdlet in Security & Compliance Center PowerShell. +In Exchange Online, this cmdlet has been replaced by the [New-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the New-DataClassification cmdlet to create data classification rules that use document fingerprints. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,16 +35,20 @@ New-DataClassification [-Name] -Description -Fingerprints -AzureKeyIDs ``` ## DESCRIPTION -Data encryption policy cmdlets are the Exchange Online part of service encryption with Customer Key in Microsoft 365. For more information, see [Controlling your data in Microsoft 365 using Customer Key](https://aka.ms/customerkey). +Data encryption policy cmdlets are the Exchange Online part of Customer Key. For more information, see [Controlling your data in Microsoft 365 using Customer Key](https://aka.ms/customerkey). You can assign a data encryption policy to a mailbox by using the DataEncryptionPolicy parameter on the Set-Mailbox cmdlet in Exchange Online PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,35 +48,35 @@ This example creates a data encryption policy named US Mailboxes with the specif ## PARAMETERS -### -AzureKeyIDs -The AzureKeyIDs parameter specifies the URI values of the Azure Key Vault keys to associate with the data encryption policy. You need to specify at least two Azure Key Vault keys separated by commas. For example, `"https://contosowestusvault01.vault.azure.net/keys/USA_Key_01","https://contosoeastusvault01.vault.azure.net/keys/USA_Key_02"`. - -To find the URI value for an Azure Key Vault, replace `` with the name of the vault, and run this command in Azure Rights Management PowerShell: `Get-AzureKeyVaultKey -VaultName ).id`. For more information, see [About Azure Key Vault](https://docs.microsoft.com/azure/key-vault/general/overview). +### -Name +The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. ```yaml -Type: MultiValuedProperty +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the unique name for the data encryption policy. If the value contains spaces, enclose the value in quotation marks. +### -AzureKeyIDs +The AzureKeyIDs parameter specifies the URI values of the Azure Key Vault keys to associate with the data encryption policy. You need to specify at least two Azure Key Vault keys separated by commas. For example, `"https://contosowestusvault01.vault.azure.net/keys/USA_Key_01","https://contosoeastusvault01.vault.azure.net/keys/USA_Key_02"`. + +To find the URI value for an Azure Key Vault, replace `` with the name of the vault, and run this command in Azure Rights Management PowerShell: `Get-AzureKeyVaultKey -VaultName ).id`. For more information, see [About Azure Key Vault](https://learn.microsoft.com/azure/key-vault/general/overview). ```yaml -Type: String +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -175,12 +173,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md index 9ac9c81efa..8b05d74e98 100644 --- a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroup +online version: https://learn.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-DatabaseAvailabilityGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-DatabaseAvailabilityGroup cmdlet to create a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,7 +53,7 @@ If the witness server that you specify isn't an Exchange server, you need to add In Windows Server 2012 R2 or later, a DAG is created without a cluster administrative access point by default. In this scenario, you don't need to provide any IP addresses to the DAG. However, in all supported versions of Windows, you have the option of assigning static IP addresses to the DAG by using the DatabaseAvailabilityGroupIpAddresses parameter. If you specify Any or 0.0.0.0, the task attempts to use Dynamic Host Configuration Protocol (DHCP) to obtain IP addresses. If you omit this parameter or configure the parameter with a value of None or 255.255.255.255, the DAG will not have a cluster administrative access point. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -267,12 +267,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md index 8759f60a34..cdf95fa60f 100644 --- a/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/exchange/New-DatabaseAvailabilityGroupNetwork.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroupnetwork +online version: https://learn.microsoft.com/powershell/module/exchange/new-databaseavailabilitygroupnetwork applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-DatabaseAvailabilityGroupNetwork schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-DatabaseAvailabilityGroupNetwork cmdlet to create a database availability group (DAG) network. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ New-DatabaseAvailabilityGroupNetwork [-Name] [-DatabaseAvailabilityGrou ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -198,12 +198,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md index 223ccfe733..42534c6c9d 100644 --- a/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/New-DeliveryAgentConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deliveryagentconnector +online version: https://learn.microsoft.com/powershell/module/exchange/new-deliveryagentconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-DeliveryAgentConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. The New-DeliveryAgentConnector cmdlet creates a delivery agent connector in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,9 +36,9 @@ New-DeliveryAgentConnector [-Name] -AddressSpaces ``` ## DESCRIPTION -Delivery agent connectors are used to route messages addressed to foreign systems that don't utilize the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in the Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://docs.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). +Delivery agent connectors are used to route messages addressed to foreign systems that don't utilize the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in the Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://learn.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,27 +61,27 @@ The address space for the connector is c=US;a=Fabrikam;p=Contoso. ## PARAMETERS -### -AddressSpaces -The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. Enclose each address space in quotation marks ("). +### -Name +The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters. ```yaml -Type: MultiValuedProperty +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DeliveryProtocol -The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector. +### -AddressSpaces +The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. Enclose each address space in quotation marks ("). ```yaml -Type: String +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -93,8 +93,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters. +### -DeliveryProtocol +The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector. ```yaml Type: String @@ -103,7 +103,7 @@ Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -290,12 +290,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md index 0c544b51c9..b8386092bb 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deviceconditionalaccesspolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconditionalaccesspolicy +applicable: Security & Compliance title: New-DeviceConditionalAccessPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceConditionalAccessPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-DeviceConditionalAccessPolicy cmdlet to create mobile device conditional access policies in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,9 +38,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -60,7 +60,7 @@ The Name parameter specifies a unique name for the policy. If the value contains Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -76,7 +76,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,7 +95,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -114,7 +114,7 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -124,13 +124,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -140,13 +142,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -160,12 +162,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md index 71db5ee171..102c007035 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceConditionalAccessRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deviceconditionalaccessrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconditionalaccessrule +applicable: Security & Compliance title: New-DeviceConditionalAccessRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceConditionalAccessRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-DeviceConditionalAccessRule cmdlet to create mobile device conditional access rules in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -84,9 +84,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -113,7 +113,7 @@ The Policy parameter specifies the mobile device conditional access policy that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -131,7 +131,7 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -150,7 +150,7 @@ The AccountName parameter specifies the account name. Valid values for this para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -169,7 +169,7 @@ The AccountUserName parameter specifies the account user name. Valid values for Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -194,7 +194,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -216,7 +216,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -238,7 +238,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -264,7 +264,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -289,7 +289,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -314,7 +314,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -339,7 +339,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -364,7 +364,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -386,7 +386,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -411,7 +411,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -437,7 +437,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -459,7 +459,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -481,7 +481,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -503,7 +503,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -524,7 +524,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -545,7 +545,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -570,7 +570,7 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -595,7 +595,7 @@ This setting is available only on Windows 8.1 RT devices. Type: CAAutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -617,7 +617,7 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -643,7 +643,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -662,7 +662,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -678,7 +678,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -697,7 +697,7 @@ The EmailAddress parameter specifies the email address. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -719,7 +719,7 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -738,7 +738,7 @@ The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -759,7 +759,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -781,7 +781,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -806,7 +806,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -832,7 +832,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -852,7 +852,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -862,7 +862,7 @@ Accept wildcard characters: False ``` ### -MoviesRating -The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. +The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: @@ -952,7 +952,7 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -971,7 +971,7 @@ The PasswordComplexity parameter specifies the password complexity. Valid values Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -997,7 +997,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1023,7 +1023,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1042,7 +1042,7 @@ The PasswordMinComplexChars parameter specifies the minimum number of complex ch Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1068,7 +1068,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1091,7 +1091,7 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1117,7 +1117,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1142,7 +1142,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1167,7 +1167,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1177,7 +1177,7 @@ Accept wildcard characters: False ``` ### -RegionRatings -The RegionRatings parameter specifies the rating system (country) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. +The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: @@ -1198,7 +1198,7 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1218,7 +1218,7 @@ The RequireEmailProfile parameter specifies whether an email profile is required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1240,7 +1240,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1262,7 +1262,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1272,7 +1272,7 @@ Accept wildcard characters: False ``` ### -TVShowsRating -The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. +The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: @@ -1351,7 +1351,7 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1375,7 +1375,7 @@ This setting is available only on Windows 8.1 RT devices. Type: CAUserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1385,13 +1385,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1413,7 +1413,7 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1433,7 +1433,7 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1447,12 +1447,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md index 66701d29c1..67e19df788 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceConfigurationPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deviceconfigurationpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconfigurationpolicy +applicable: Security & Compliance title: New-DeviceConfigurationPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceConfigurationPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-DeviceConfigurationPolicy cmdlet to create mobile device configuration policies in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,9 +38,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -60,7 +60,7 @@ The Name parameter specifies a unique name for the policy. If the value contains Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -76,7 +76,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,7 +95,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -114,7 +114,7 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -124,13 +124,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -140,13 +142,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -160,12 +162,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md index 9224157fc6..e4505ceb8f 100644 --- a/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceConfigurationRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-deviceconfigurationrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-deviceconfigurationrule +applicable: Security & Compliance title: New-DeviceConfigurationRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceConfigurationRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-DeviceConfigurationRule cmdlet to create mobile device configuration rules in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -83,9 +83,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -112,7 +112,7 @@ The Policy parameter specifies the mobile device configuration policy that this Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -130,7 +130,7 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -149,7 +149,7 @@ The AccountName parameter specifies the account name. Valid values for this para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -168,7 +168,7 @@ The AccountUserName parameter specifies the account user name. Valid values for Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -193,7 +193,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -215,7 +215,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -237,7 +237,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -263,7 +263,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -288,7 +288,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -313,7 +313,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -338,7 +338,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -360,7 +360,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -385,7 +385,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -411,7 +411,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -433,7 +433,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -455,7 +455,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -477,7 +477,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -498,7 +498,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -519,7 +519,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -544,7 +544,7 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -569,7 +569,7 @@ This setting is available only on Windows 8.1 RT devices. Type: AutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -591,7 +591,7 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -617,7 +617,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -636,7 +636,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -652,7 +652,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -671,7 +671,7 @@ The EmailAddress parameter specifies the email address. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -693,7 +693,7 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -712,7 +712,7 @@ The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -733,7 +733,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -755,7 +755,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -780,7 +780,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -806,7 +806,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -826,7 +826,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -836,7 +836,7 @@ Accept wildcard characters: False ``` ### -MoviesRating -The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. +The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: @@ -926,7 +926,7 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -945,7 +945,7 @@ The PasswordComplexity parameter specifies the password complexity. Valid values Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -971,7 +971,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -997,7 +997,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1016,7 +1016,7 @@ The PasswordMinComplexChars parameter specifies the minimum number of complex ch Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1042,7 +1042,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1065,7 +1065,7 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1091,7 +1091,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1116,7 +1116,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1141,7 +1141,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1151,7 +1151,7 @@ Accept wildcard characters: False ``` ### -RegionRatings -The RegionRatings parameter specifies the rating system (country) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. +The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: @@ -1172,7 +1172,7 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1192,7 +1192,7 @@ The RequireEmailProfile parameter specifies whether an email profile is required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1214,7 +1214,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1236,7 +1236,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1246,7 +1246,7 @@ Accept wildcard characters: False ``` ### -TVShowsRating -The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. +The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: @@ -1325,7 +1325,7 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1349,7 +1349,7 @@ This setting is available only on Windows 8.1 RT devices. Type: UserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1359,13 +1359,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1387,7 +1387,7 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1407,7 +1407,7 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1421,12 +1421,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md index 147bec39ca..13317afc2d 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/New-DeviceTenantPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-devicetenantpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-devicetenantpolicy +applicable: Security & Compliance title: New-DeviceTenantPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceTenantPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-DeviceTenantPolicy cmdlet to create your organization's mobile device tenant policy in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,9 +37,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -59,7 +59,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -78,7 +78,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -97,7 +97,7 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -107,13 +107,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -123,13 +125,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -143,12 +145,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md b/exchange/exchange-ps/exchange/New-DeviceTenantRule.md index 485c06fd44..214a1d7524 100644 --- a/exchange/exchange-ps/exchange/New-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/New-DeviceTenantRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-devicetenantrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-devicetenantrule +applicable: Security & Compliance title: New-DeviceTenantRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DeviceTenantRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-DeviceTenantRule cmdlet to create your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,9 +38,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -66,7 +66,7 @@ The ApplyPolicyTo parameter specifies where to apply the policy in your organiza Type: PolicyResourceScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ The BlockUnsupportedDevices parameter specifies whether to block access to your Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -104,7 +104,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -120,7 +120,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -140,7 +140,7 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -150,13 +150,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -170,12 +170,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DistributionGroup.md b/exchange/exchange-ps/exchange/New-DistributionGroup.md index 6d2510d925..de47db246c 100644 --- a/exchange/exchange-ps/exchange/New-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-distributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/new-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-DistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-DistributionGroup cmdlet to create distribution groups and mail-enabled security groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,6 +28,7 @@ New-DistributionGroup [-Name] [-BypassNestedModerationEnabled ] [-Confirm] [-CopyOwnerToMember] + [-Description ] [-DisplayName ] [-DomainController ] [-HiddenGroupMembershipEnabled] @@ -58,7 +59,9 @@ You can use the New-DistributionGroup cmdlet to create the following types of gr Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Distribution groups aren't security principals, and therefore can't be assigned permissions. However, you can assign permissions to mail-enabled security groups. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. ## EXAMPLES @@ -99,15 +102,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -159,7 +167,10 @@ Accept wildcard characters: False ### -BccBlocked This parameter is available only in the cloud-based service. -{{ Fill BccBlocked Description }} +The BccBlocked parameter specifies whether members of the group don't receive messages if the group is used in the Bcc line. Valid values are: + +- $true: If the group is used in the Bcc line, members of the group don't receive the message, and the sender receives a non-delivery report (also known as an NDR or bounce message). Other recipients of the message aren't blocked. If an external sender uses the group in the Bcc line, members of the group aren't blocked. For nested groups, the message is blocked only for members of the top-level group. +- $false: There are no restrictions for using the group in the Bcc line of messages. This is the default value. ```yaml Type: Boolean @@ -230,6 +241,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +This parameter is available only in the cloud-based service. + +{{ Fill Description Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -271,7 +300,11 @@ Accept wildcard characters: False ### -HiddenGroupMembershipEnabled This parameter is available only in the cloud-based service. -{{ Fill HiddenGroupMembershipEnabled Description }} +The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the distribution group from users who aren't members of the group. You don't need to specify a value with this switch. + +You can use this setting to help comply with regulations that require you to hide group membership from members or outsiders (for example, a distribution group that represents students enrolled in a class). + +**Note**: If you create the group with hidden membership, you can't edit the group later to reveal the membership to the group. ```yaml Type: SwitchParameter @@ -313,7 +346,14 @@ The ManagedBy parameter specifies an owner for the group. A group must have at l - Approve member depart or join requests (if available) - Approve messages sent to the group if moderation is enabled, but no moderators are specified. -The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: +The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). + +Considerations for mail-enabled security groups as group owners: + +- If you specify a mail-enabled security group as a group owner in on-premises Exchange, the mail-enabled security group doesn't sync to the cloud object. +- Group management in Outlook doesn't work if the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. If you specify a mail-enabled security group as the owner of the group, the group isn't visible in **Distribution groups I own** for the group owners (members of the mail-enabled security group). + +You can use any value that uniquely identifies the owner. For example: - Name - Alias @@ -326,11 +366,11 @@ The owner you specify for this parameter must be a mailbox, mail user or mail-en - SamAccountName - User ID or user principal name (UPN) -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple owners, use the following syntax: `Owner1,Owner2,...OwnerN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Owner1","Owner2",..."OwnerN"`. -An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. +Owners that you specify with this parameter are not automatically added as group members. Use the CopyOwnerToMember switch or manually add the owners as members. -Alternatively, you can use the CopyOwnerToMember switch so the owners are automatically made members of the group. +**Note**: Group management in Outlook doesn't work when the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. ```yaml Type: MultiValuedProperty @@ -400,6 +440,8 @@ After you create the group, you use the Get-DistributionGroupMember cmdlet to vi Although it isn't required, it's a good idea to add only security principals (for example, mailboxes and mail users with user accounts or other mail-enabled security groups) to mail-enabled security groups. If you assign permissions to a mail-enabled security group, any members that aren't security principals (for example, mail contacts or distribution groups) won't have the permissions assigned. +The maximum number of entries for this parameter is 10000. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -639,12 +681,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-DkimSigningConfig.md b/exchange/exchange-ps/exchange/New-DkimSigningConfig.md index 3143a89695..5bd296a8ba 100644 --- a/exchange/exchange-ps/exchange/New-DkimSigningConfig.md +++ b/exchange/exchange-ps/exchange/New-DkimSigningConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dkimsigningconfig +online version: https://learn.microsoft.com/powershell/module/exchange/new-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection title: New-DkimSigningConfig schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-DkimSigningConfig cmdlet to create the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +34,7 @@ New-DkimSigningConfig [-DomainName] [-Enabled] [-Comment ] [-Confirm] + [-EndpointDlpAdaptiveScopes ] + [-EndpointDlpAdaptiveScopesException ] + [-EndpointDlpExtendedLocations ] [-EndpointDlpLocation ] [-EndpointDlpLocationException ] + [-EnforcementPlanes ] [-ExceptIfOneDriveSharedBy ] [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] [-ExchangeLocation ] [-ExchangeSenderMemberOf ] [-ExchangeSenderMemberOfException ] [-Force] + [-IsFromSmartInsights ] + [-Locations ] [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] [-OneDriveLocation ] [-OneDriveLocationException ] [-OneDriveSharedBy ] [-OneDriveSharedByMemberOf ] [-OnPremisesScannerDlpLocation ] [-OnPremisesScannerDlpLocationException ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] + [-PowerBIDlpLocation ] + [-PowerBIDlpLocationException ] [-Priority ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] [-SharePointLocation ] [-SharePointLocationException ] - [-SharePointOnPremisesLocationException ] - [-SharePointServerLocation ] + [-TeamsAdaptiveScopes ] + [-TeamsAdaptiveScopesException ] [-TeamsLocation ] [-TeamsLocationException ] [-ThirdPartyAppDlpLocation ] [-ThirdPartyAppDlpLocationException ] + [-ValidatePolicy] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -62,14 +79,76 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as New-DlpCompliancePolicy -Name "GlobalPolicy" -SharePointLocation All ``` -This example creates a DLP policy named GlobalPolicy that will be enforced across all SharePoint Online locations. +This example creates a DLP policy named GlobalPolicy that will be enforced across all SharePoint locations. ### Example 2 ```powershell New-DlpCompliancePolicy -Name "GlobalPolicy" -Comment "Primary policy" -SharePointLocation "https://my.url/","https://my.url2/" -OneDriveLocation "https://my.url3/","https://my.url4/" -Mode Enable ``` -This example creates a DLP policy named GlobalPolicy for the specified SharePoint Online and OneDrive for Business locations. The new policy has a descriptive comment and will be enabled on creation. +This example creates a DLP policy named GlobalPolicy for the specified SharePoint and OneDrive locations. The new policy has a descriptive comment and will be enabled on creation. + +### Example 3 +```powershell +New-DlpCompliancePolicy -Name "PowerBIPolicy" -Comment "Primary policy" -PowerBIDlpLocation "All" -PowerBIDlpLocationException "workspaceID1","workspaceID2","workspaceID3" -Mode Enable +``` + +This example creates a DLP policy named PowerBIPolicy for all qualifying Power BI workspaces (that is, those hosted on Premium Gen2 capacities) except for the specified workspaces. The new policy has a descriptive comment and will be enabled on creation. + +### Example 4 +```powershell +Get-Label | Format-List Priority,ContentType,Name,DisplayName,Identity,Guid + +$guidVar = "e222b65a-b3a8-46ec-ae12-00c2c91b71c0" + +$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","Inclusions":[{Type:"Tenant", Identity:"All"}]}]" + +New-DLPCompliancePolicy -Name "Copilot Policy" -Locations $loc + +$advRule = @{ + "Version" = "1.0" + "Condition" = @{ + "Operator" = "And" + "SubConditions" = @( + @{ + "ConditionName" = "ContentContainsSensitiveInformation" + "Value" = @( + @{ + "groups" = @( + @{ + "Operator" = "Or" + "labels" = @( + @{ + "name" = $guidVar + "type" = "Sensitivity" + } + ) + "name" = "Default" + } + ) + } + ) + } + ) + } +} | ConvertTo-Json -Depth 100 + +New-DLPComplianceRule -Name "Copilot Rule" -Policy "Copilot Policy" -AdvancedRule $advrule -RestrictAccess @(@{setting="ExcludeContentProcessing";value="Block"}) +``` + +This example creates a DLP policy for Microsoft 365 Copilot (Preview) in several steps: + +- The first command returns information about all sensitivity labels. Select the GUID value of the sensitivity label that you want to use. For example, `e222b65a-b3a8-46ec-ae12-00c2c91b71c0`. + +- The second command stores the GUID value of the sensitivity label in the variable named `$guidVar`. + +- The third command stores the Microsoft 365 Copilot location (`470f2276-e011-4e9d-a6ec-20768be3a4b0`) in the variable named `$loc`. Update the `$loc` value based on the Inclusions/Exclusions scoping that you want to provide. + +- The fourth command creates the DLP policy using the `$loc` variable for the value of the Locations parameter, and "Copilot Policy" as the name of the policy (use any unique name). + +- The fifth command creates the variable named `$advRule`. The advanced rule needs to be updated depending on the grouping of labels you want to provide as input. + +- The last command creates the DLP rule with the name "Copilot Rule" (use any unique name). Use the name of the DLP policy from step four as the value of the Policy parameter. ## PARAMETERS @@ -80,7 +159,7 @@ The Name parameter specifies the unique name of the DLP policy. If the value con Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -96,7 +175,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,7 +194,55 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpAdaptiveScopes +{{ Fill EndpointDlpAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpAdaptiveScopesException +{{ Fill EndpointDlpAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpExtendedLocations +{{ Fill EndpointDlpExtendedLocations Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -125,15 +252,19 @@ Accept wildcard characters: False ``` ### -EndpointDlpLocation -The EndpointDLPLocation parameter specifies the user accounts to include in the DLP policy when they are logged on to an onboarded device. You identify the account by name or email address. You can use the value All for this parameter to include all user accounts. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +The EndpointDLPLocation parameter specifies the user accounts to include in the DLP policy for Endpoint DLP when they are logged on to an onboarded device. You identify the account by name or email address. You can use the value All to include all user accounts. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -143,15 +274,39 @@ Accept wildcard characters: False ``` ### -EndpointDlpLocationException -The EndpointDlpLocationException parameter specifies the user accounts to exclude when you use the value All for the EndpointDlpLocation parameter. You identify the account by name or email address. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The EndpointDlpLocationException parameter specifies the user accounts to exclude from Endpoint DLP when you use the value All for the EndpointDlpLocation parameter. You identify the account by name or email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementPlanes +The EnforcementPlanes parameter defines the layer where policy actions are run. This parameter uses the following syntax: + +`-EnforcementPlanes @("")`. + +Currently, the only supported value is Entra, for use with policies applied to an Entra-registered enterprise application in the organization. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -161,16 +316,19 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy -The ExceptIfOneDriveSharedBy parameter specifies the users to exclude in the DLP policy. You identify the user by its email address. +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). -To enter multiple values, use the following syntax: `,,...`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. +You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMemberOf parameters. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -180,15 +338,21 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf -The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups, mail-enabled security groups, or Microsoft 365 groups to exclude in the DLP policy. You identify the group by its email address. +The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive sites of group members are excluded from the policy). You identify the groups by email address. + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. -To enter multiple values, use the following syntax: `,,...`. +You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -197,15 +361,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExchangeAdaptiveScopes +{{ Fill ExchangeAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopesException +{{ Fill ExchangeAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -ExchangeLocation -The ExchangeLocation parameter specifies Exchange Online mailboxes to include in the DLP policy. You can only use the value All for this parameter to include all mailboxes. +The ExchangeLocation parameter specifies whether to include email messages in the DLP policy. The valid value for this parameter is All. If you don't want to include email messages in the policy, don't use this parameter (the default value is blank or $null). + +You can use this parameter in the following procedures: + +- If you use `-ExchangeLocation All` by itself, the policy applies to email for all users. + +- To include email of specific group members in the policy, use `-ExchangeLocation All` with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy. + +- To exclude email of specific group members from the policy, use `-ExchangeLocation All` with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy. + +You can't specify inclusions and exclusions in the same policy. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -215,9 +420,13 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf -The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the DLP policy. You identify the group by its email address. +The ExchangeSenderMemberOf parameter specifies the distribution groups or security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. -You can enter multiple values separated by commas. +You can't use this parameter with the ExchangeSenderMemberOfException parameter. You can't use this parameter to specify Microsoft 365 Groups. @@ -225,7 +434,7 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -235,9 +444,13 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException -The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the DLP policy. You identify the group by its email address. +The ExchangeSenderMemberOfException parameter specifies the distribution groups or security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. -You can enter multiple values separated by commas. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You must use this parameter with the ExchangeLocation parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. You can't use this parameter to specify Microsoft 365 Groups. @@ -245,7 +458,7 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -254,15 +467,69 @@ Accept pipeline input: False Accept wildcard characters: False ``` - ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFromSmartInsights +{{ Fill IsFromSmartInsights Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +The Locations parameter specifies to whom, what, and where the DLP policy applies. This parameter uses the following properties: + +- Workload: What the DLP policy applies to. Use the value `Applications`. +- Location: Where the DLP policy applies. For Microsoft 365 Copilot, (Preview), use the value `470f2276-e011-4e9d-a6ec-20768be3a4b0`. +- Inclusions: Who the DLP policy applies to. For users, use the email address in this syntax: `{Type:IndividualResource,Identity:}`. For security groups or distribution groups, use the ObjectId value of the group from the Microsoft Entra portal in this syntax: `{Type:Group,Identity:}`. For the entire tenant, use this value: `{Type:"Tenant",Identity:"All"}`. +- Exclusions: Exclude security groups, distribution groups, or users from the scope of this DLP policy. For users, use the email address in this syntax: `{Type:IndividualResource,Identity:}`. For groups, use the ObjectId value of the group from the Microsoft Entra portal in this syntax: `{Type:Group, Identity:}`. + +You create and store the properties in a variable as shown in the following examples: + +DLP policy scoped to all users in the tenant: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","Inclusions":[{Type:"Tenant",Identity:"All"}]}]"` + +DLP policy scoped to the specified user and groups: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","Inclusions":[{"Type":"Group","Identity":"fef0dead-5668-4bfb-9fc2-9879a47f9bdb"},{"Type":"Group","Identity":"b4dc1e1d-8193-4525-b59c-6d6e0f1718d2"},{"Type":"IndividualResource","Identity":"yibing@contoso.com"}]}]"` + +DLP policy scoped to all users in the tenant except for members of the specified group: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","Inclusions":[{Type:"Tenant",Identity:"All"}]}],"Exclusions":[{"Type":"Group","Identity":"fef0dead-5668-4bfb-9fc2-9879a47f9bdb"}]}]"` + +After you create the `$loc` variable as shown in the previous examples, use the value `$loc` for this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -276,14 +543,14 @@ The Mode parameter specifies the action and notification level of the DLP policy - Enable: The policy is enabled for actions and notifications. This is the default value. - Disable: The policy is disabled. -- TestWithNotifications: No actions are taken, but notifications are sent. -- TestWithoutNotifications: An audit mode where no actions are taken, and no notifications are sent. +- TestWithNotifications: Simulation mode where no actions are taken, but notifications **are** sent. +- TestWithoutNotifications: Simulation mode where no actions are taken, and no notifications are sent. ```yaml Type: PolicyMode Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -292,16 +559,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveLocation -The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +### -OneDriveAdaptiveScopes +{{ Fill OneDriveAdaptiveScopes Description }} -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopesException +{{ Fill OneDriveAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -310,17 +591,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OneDriveLocationException -This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. +### -OneDriveLocation +The OneDriveLocation parameter specifies whether to include OneDrive sites in the policy. A valid value for this parameter is All, which is also the default value. + +You can use this parameter in the following procedures: + +- To include sites of specific OneDrive accounts in the policy, use the OneDriveSharedBy parameter to specify the users. Only sites of the specified users are included in the policy. + +- To include sites of specific group members in the policy, use the OneDriveSharedByMemberOf parameter to specify the groups. Only sites of members of the specified groups are included in the policy. + +- To exclude sites of specific OneDrive accounts from the policy, use the ExceptIfOneDriveSharedBy parameter to specify the users. Only sites of the specified users are excluded from the policy. + +- To exclude sites of specific group members from the policy, use the ExceptIfOneDriveSharedByMemberOf parameter to specify the groups. Only sites of members of the specified groups are excluded from the policy. + +- If you use `-OneDriveLocation $null`, the policy does not apply to OneDrive sites. + +You can't specify inclusions and exclusions in the same policy. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +**Note**: Although this parameter accepts site URLs, don't specify site URLs values. Use the OneDriveSharedBy, ExceptIfOneDriveShareBy, OneDriveSharedByMemberOf, and ExceptIfOneDriveSharedByMemberOf parameters instead. In the DLP policy settings in the Microsoft Defender portal, you can't identify sites by URL; you specify sites only by users or groups. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveLocationException +Don't use this parameter. See the OneDriveLocation parameter for an explanation. +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named Default value: None @@ -329,16 +638,19 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy -The OneDriveSharedBy parameter specifies the users to include in the DLP policy. You identify the user by email address. +The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). -To enter multiple values, use the following syntax: `,,...`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. +You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDriveSharedByMemberOf parameters. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -348,15 +660,21 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf -The OneDriveSharedByMemberOf parameter specifies the distribution groups, mail-enabled security groups, or Microsoft 365 groups to include in the DLP policy. You identify the group by its email address. +The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive sites of group members are included in the policy). You identify the groups by email address. + +To use this parameter, OneDrive sites need to be included in the policy (the OneDriveLocation parameter value is All, which is the default value). + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. -To enter multiple values, use the following syntax: `,,...`. +You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDriveSharedByMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -366,13 +684,17 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpLocation -{{ Fill OnPremisesScannerDlpLocation Description }} +The OnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to include in the DLP policy. You can use the value All to include all on-premises file shares and SharePoint document libraries and folders. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -382,13 +704,103 @@ Accept wildcard characters: False ``` ### -OnPremisesScannerDlpLocationException -{{ Fill OnPremisesScannerDlpLocationException Description }} +The OnPremisesScannerDlpLocationException parameter specifies the on-premises file shares and SharePoint document libraries and folders to exclude from the DLP policy if you use the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. + +For more information about DLP policy templates, see [What the DLP policy templates include](https://learn.microsoft.com/purview/what-the-dlp-policy-templates-include). + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PowerBIDlpLocation +The PowerBIDlpLocation parameter specifies the Power BI workspace IDs to include in the DLP policy. Only workspaces hosted in Premium Gen2 capacities are permitted. You can use the value All to include all supported workspaces. + +You can find the workspace ID using any of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the **Get-PowerBIWorkspace** cmdlet. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +**Note**: You can't use this parameter if the DLP policy applies to other locations. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PowerBIDlpLocationException +The PowerBIDlpLocationException parameter specifies the Power BI workspace IDs to exclude from the DLP policy when you use the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using any of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the **Get-PowerBIWorkspace** cmdlet. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -400,7 +812,7 @@ Accept wildcard characters: False ### -Priority The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and policies can't have the same priority value. -Valid values and the default value for this parameter depend on the number of existing policies. For example, if there are 5 existing policies: +Valid values and the default value depend on the number of existing policies. For example, if there are 5 existing policies: - Valid priority values for the existing 5 policies are from 0 through 4. - Valid priority values for a new 6th policy are from 0 through 5. @@ -412,7 +824,39 @@ If you modify the priority value of a policy, the position of the policy in the Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopes +{{ Fill SharePointAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopesException +{{ Fill SharePointAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -422,15 +866,17 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +The SharePointLocation parameter specifies the SharePoint sites to include in the DLP policy. You identify the site by its URL value, or you can use the value All to include all sites. + +You can't add SharePoint sites to the policy until they have been indexed. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. SharePoint Online sites can't be added to a policy until they have been indexed. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -440,15 +886,17 @@ Accept wildcard characters: False ``` ### -SharePointLocationException -This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +The SharePointLocationException parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +You can't add SharePoint sites to the policy until they have been indexed. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -457,14 +905,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharePointOnPremisesLocationException -This parameter is reserved for internal Microsoft use. +### -TeamsAdaptiveScopes +{{ Fill TeamsAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -473,14 +921,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SharePointServerLocation -This parameter is reserved for internal Microsoft use. +### -TeamsAdaptiveScopesException +{{ Fill TeamsAdaptiveScopesException Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -490,15 +938,15 @@ Accept wildcard characters: False ``` ### -TeamsLocation -The TeamsLocation parameter specifies the Teams accounts to include in the DLP policy. You identify the account by its name or email address, or you can use the value All to include all accounts. +The TeamsLocation parameter specifies the Teams chat and channel messages to include in the DLP policy. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. You can use the value All to include all accounts, distribution groups, and mail-enabled security groups. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -508,15 +956,15 @@ Accept wildcard characters: False ``` ### -TeamsLocationException -The TeamsLocation parameter specifies the Teams accounts to exclude form the DLP policy when you use the value All for the TeamsLocation parameter. You identify the account by its name or email address. +The TeamsLocation parameter specifies the Teams chat and channel messages to exclude from the DLP policy when you use the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -526,13 +974,19 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpLocation -This parameter is reserved for internal Microsoft use. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The ThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to include in the DLP policy. You can use the value All to include all connected apps. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -542,13 +996,35 @@ Accept wildcard characters: False ``` ### -ThirdPartyAppDlpLocationException -This parameter is reserved for internal Microsoft use. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The ThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps to exclude from the DLP policy when you use the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidatePolicy +{{ Fill ValidatePolicy Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -558,13 +1034,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -578,12 +1054,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md index 0eda84deed..177d38fa19 100644 --- a/exchange/exchange-ps/exchange/New-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-DlpComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpcompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpcompliancerule +applicable: Security & Compliance title: New-DlpComplianceRule schema: 2.0.0 author: chrisda @@ -12,66 +12,84 @@ ms.reviewer: # New-DlpComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-DlpComplianceRule to create Data Loss Prevention (DLP) rules in the Microsoft 365 compliance center. DLP rules define sensitive information to be protected and the actions to take on rule matches. +Use the New-DlpComplianceRule to create data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules define sensitive information to be protected and the actions to take on rule matches. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` New-DlpComplianceRule [-Name] -Policy - [-AccessScope ] - [-ActivationDate ] + [-AccessScope ] + [-ActivationDate ] [-AddRecipients ] + [-AdvancedRule ] [-AlertProperties ] [-AnyOfRecipientAddressContainsWords ] [-AnyOfRecipientAddressMatchesPatterns ] + [-ApplyBrandingTemplate ] [-ApplyHtmlDisclaimer ] + [-AttachmentIsNotLabeled ] [-BlockAccess ] - [-BlockAccessScope ] + [-BlockAccessScope ] [-Comment ] [-Confirm] [-ContentCharacterSetContainsWords ] [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] + [-ContentFileTypeMatches ] + [-ContentIsNotLabeled ] + [-ContentIsShared ] [-ContentPropertyContainsWords ] [-Disabled ] [-DocumentContainsWords ] - [-DocumentIsPasswordProtected + [-DocumentCreatedBy ] + [-DocumentCreatedByMemberOf ] + [-DocumentIsPasswordProtected ] [-DocumentIsUnsupported ] [-DocumentMatchesPatterns ] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] - [-DocumentSizeOver ] + [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] - [-ExceptIfAccessScope ] + [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] + [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentCharacterSetContainsWords ] [-ExceptIfContentContainsSensitiveInformation ] [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentFileTypeMatches ] + [-ExceptIfContentIsShared ] [-ExceptIfContentPropertyContainsWords ] [-ExceptIfDocumentContainsWords ] + [-ExceptIfDocumentCreatedBy ] + [-ExceptIfDocumentCreatedByMemberOf ] [-ExceptIfDocumentIsPasswordProtected ] [-ExceptIfDocumentIsUnsupported ] [-ExceptIfDocumentMatchesPatterns ] [-ExceptIfDocumentNameMatchesPatterns ] [-ExceptIfDocumentNameMatchesWords ] - [-ExceptIfDocumentSizeOver ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] [-ExceptIfFromAddressMatchesPatterns ] [-ExceptIfFromMemberOf ] - [-ExceptIfFromScope ] + [-ExceptIfFromScope ] [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesPatterns ] - [-ExceptIfMessageSizeOver ] - [-ExceptIfMessageTypeMatches ] + [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageTypeMatches ] [-ExceptIfProcessingLimitExceeded ] + [-ExceptIfRecipientADAttributeContainsWords ] + [-ExceptIfRecipientADAttributeMatchesPatterns ] [-ExceptIfRecipientDomainIs ] [-ExceptIfSenderADAttributeContainsWords ] [-ExceptIfSenderADAttributeMatchesPatterns ] @@ -84,62 +102,85 @@ New-DlpComplianceRule [-Name] -Policy [-ExceptIfSubjectOrBodyContainsWords ] [-ExceptIfSubjectOrBodyMatchesPatterns ] [-ExceptIfUnscannableDocumentExtensionIs ] - [-ExceptIfWithImportance ] - [-ExpiryDate ] + [-ExceptIfWithImportance ] + [-ExpiryDate ] [-From ] [-FromAddressContainsWords ] [-FromAddressMatchesPatterns ] [-FromMemberOf ] - [-FromScope ] + [-FromScope ] [-GenerateAlert ] [-GenerateIncidentReport ] [-HasSenderOverride ] [-HeaderContainsWords ] [-HeaderMatchesPatterns ] - [-ImmutableId ] + [-ImmutableId ] [-IncidentReportContent ] - [-MessageSizeOver ] + [-MessageIsNotLabeled ] + [-MessageSizeOver ] [-MessageTypeMatches ] + [-MipRestrictAccess ] [-Moderate ] + [-ModifySubject ] + [-NonBifurcatingAccessScope ] [-NotifyAllowOverride ] + [-NotifyEmailCustomSenderDisplayName ] [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] + [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] + [-NotifyEndpointUser ] + [-NotifyOverrideRequirements ] + [-NotifyPolicyTipCustomDialog ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] + [-NotifyPolicyTipDisplayOption ] + [-NotifyPolicyTipUrl ] [-NotifyUser ] + [-NotifyUserType ] [-OnPremisesScannerDlpRestrictions ] [-PrependSubject ] - [-Priority ] + [-Priority ] [-ProcessingLimitExceeded ] + [-Quarantine ] + [-RecipientADAttributeContainsWords ] + [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] [-RecipientDomainIs ] [-RedirectMessageTo ] [-RemoveHeader ] [-RemoveRMSTemplate ] [-ReportSeverityLevel ] - [-RuleErrorAction ] + [-RestrictAccess ] + [-RestrictBrowserAccess ] + [-RuleErrorAction ] [-SenderADAttributeContainsWords ] [-SenderADAttributeMatchesPatterns ] + [-SenderAddressLocation ] [-SenderDomainIs ] [-SenderIPRanges ] [-SentTo ] [-SentToMemberOf ] [-SetHeader ] + [-SharedByIRMUserRisk ] [-StopPolicyProcessing ] [-SubjectContainsWords ] [-SubjectMatchesPatterns ] [-SubjectOrBodyContainsWords ] [-SubjectOrBodyMatchesPatterns ] [-ThirdPartyAppDlpRestrictions ] + [-TriggerPowerAutomateFlow ] [-UnscannableDocumentExtensionIs ] + [-ValidateRule] [-WhatIf] - [-WithImportance ] + [-WithImportance ] [] ``` ## DESCRIPTION Each new rule must contain one condition filter or test, and one associated action. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -148,7 +189,139 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as New-DlpComplianceRule -Name "SocialSecurityRule" -Policy "USFinancialChecks" -ContentContainsSensitiveInformation @{Name="U.S. Social Security Number (SSN)"} -BlockAccess $True ``` -This example create a new DLP compliance rule named "SocialSecurityRule" that is assigned to the "USFinancialChecks" policy. The rule checks for social security numbers and blocks access if it finds them. +This example creates a new DLP compliance rule named "SocialSecurityRule" that is assigned to the "USFinancialChecks" policy. The rule checks for social security numbers and blocks access if it finds them. + +### Example 2 +```powershell +$contains_complex_types = @{ + operator = "And" + groups = @( + @{ + operator = "Or" + name = "PII Identifiers" + sensitivetypes = @( + @{ + name = "Drug Enforcement Agency (DEA) Number" + maxconfidence = 100 + minconfidence = 75 + mincount = 1 + maxcount = -1 + } + ) + } + @{ + operator = "Or" + name = "Medical Terms" + sensitivetypes = @( + @{ + name = "International Classification of Diseases (ICD-9-CM)" + maxconfidence = 100 + minconfidence = 75 + mincount = 1 + maxcount = -1 + } + @{ + name = "International Classification of Diseases (ICD-10-CM)" + maxconfidence = 100 + minconfidence = 75 + mincount = 1 + maxcount = -1 + } + ) + } + + ) +} + +New-DLPComplianceRule -Name "Contoso Medical Information" -Policy "Contoso Medical Checks" -ContentContainsSensitiveInformation $contains_complex_types +``` + +This example creates a new DLP compliance rule named "Contoso Medical Information". The rule is assigned to the "Contoso Medical Checks" policy. It uses advanced syntax to search for the specified content. + +### Example 3 +```powershell +Contents of the file named C:\Data\Sensitive Type.txt: + +{ +"Version": "1.0", +"Condition": { + "Operator": "And", + "SubConditions": [ + { + "ConditionName": "ContentContainsSensitiveInformation", + "Value": [ + { + "groups": [ + { + "Operator": "Or", + "labels": [ + { + "name": "defa4170-0d19-0005-000a-bc88714345d2", + "type": "Sensitivity" + } + ], + "name": "Default", + "sensitivetypes": [ + { + "confidencelevel": "Low", + "name": "Credit Card Number" + } + ] + } + ] + } + ] + }, + { + "Operator": "Not", + "SubConditions": [ + { + "Operator": "OR", + "SubConditions": [ + { + "ConditionName": "FromMemberOf", + "Value": [ + "janesteam@contoso.com" + ] + }, + { + "ConditionName": "SentTo", + "Value": [ + "adele@contoso.com" + ] + } + ], + } + ] + } + ] + } +} + +$data = Get-Content -Path "C:\Data\Sensitive Type.txt" -ReadCount 0 -encoding Byte + +$string = [System.Text.Encoding]::UTF8.GetString($data) + +New-DLPComplianceRule -Name "Contoso Rule 1" -Policy "Contoso Policy 1" -AdvancedRule $string -NotifyUser +``` + +This example uses the AdvancedRule parameter to read the following complex condition from a file: "Content contains sensitive information: "Credit card number OR Highly confidential" AND (NOT (Sender is a member of "Jane's Team" OR Recipient is "adele@contoso.com")). + +### Example 4 +```powershell + +$myEntraAppId = "" + +$myEntraAppName = "" + +$locations = "[{`"Workload`":`"Applications`",`"Location`":`"$myEntraAppId`",`"LocationDisplayName`":`"$myEntraAppName`",`"LocationSource`":`"Entra`",`"LocationType`":`"Individual`",`"Inclusions`":[{`"Type`":`"Tenant`",`"Identity`":`"All`"}]}]" + +New-DlpCompliancePolicy -Name "Test Entra DLP" -Mode Enable -Locations $locations -EnforcementPlanes @("Entra") + +New-DlpComplianceRule -Name "Test Entra Rule" -Policy "Test Entra DLP" -ContentContainsSensitiveInformation @{Name = "credit card number"} -GenerateAlert $true -GenerateIncidentReport @("siteadmin") -NotifyUser @("admin@contonso.onmicrosoft.com") -RestrictAccess @(@{setting="UploadText";value="Block"}) +``` + +This is an example of applying a CCSI-based DLP rule that should be handled by an entra-registered enterprise application in the organization. ## PARAMETERS @@ -159,7 +332,7 @@ The Name parameter specifies the unique name of the new DLP rule. If the value c Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -169,7 +342,7 @@ Accept wildcard characters: False ``` ### -Policy -The Policy parameter specifies the existing DLP policy that will contain the DLP rule. You can use any value that uniquely identifies the policy. For example: +The Policy parameter specifies the existing DLP policy that will contain the new DLP rule. You can use any value that uniquely identifies the policy. For example: - Name - Distinguished name (DN) @@ -180,7 +353,7 @@ The Policy parameter specifies the existing DLP policy that will contain the DLP Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -192,15 +365,15 @@ Accept wildcard characters: False ### -AccessScope The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: -- InOrganization: The rule is applied to content that's accessible inside the organization. -- NotInOrganization: The rule is applied to content that's accessible outside the organization. +- InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. +- NotInOrganization: The rule is applied to content that's accessible or delivered to a recipient outside the organization. - None: The condition isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -213,10 +386,10 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -237,7 +410,27 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedRule +The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. + +This parameter uses JSON syntax that's similar to the traditional advanced syntax in Example 2, but read from a file that contains additional operators and combinations that aren't traditionally supported. + +For syntax details, see Example 3. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -253,7 +446,7 @@ Accept wildcard characters: False Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -269,7 +462,7 @@ The AnyOfRecipientAddressContainsWords parameter specifies a condition for the D - Multiple words: `no_reply,urgent,...` - Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` -The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. You can use this condition in DLP policies that are scoped only to Exchange. @@ -277,7 +470,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -289,7 +482,7 @@ Accept wildcard characters: False ### -AnyOfRecipientAddressMatchesPatterns The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this condition in DLP policies that are scoped only to Exchange. @@ -297,7 +490,25 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyBrandingTemplate +The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). + +Use the EnforcePortalAccess parameter to control whether external users are required to use the encrypted message portal to view encrypted messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -319,7 +530,23 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentIsNotLabeled +{{ Fill AttachmentIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -338,7 +565,7 @@ The BlockAccess parameter specifies an action for the DLP rule that blocks acces Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -350,15 +577,15 @@ Accept wildcard characters: False ### -BlockAccessScope The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: -- All: Block access to everyone except the owner and the last modifier. -- PerUser: Block access to external users. -- PerAnonymousUser: Block access to people through the "Anyone with the link" option in SharePoint and OneDrive. +- All: Blocks access to everyone except the owner and the last modifier. +- PerUser: Blocks access to external users. +- PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive. ```yaml -Type: BlockAccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -374,7 +601,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -393,7 +620,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -411,7 +638,7 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -423,15 +650,17 @@ Accept wildcard characters: False ### -ContentContainsSensitiveInformation The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. -This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `labels = @(@{name ="Confidential"; type ="Sensitivity";})` +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). +For an example of advanced syntax, see Example 2 in this topic. ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -441,13 +670,71 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords -The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. +The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFileTypeMatches +{{ Fill ContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIsNotLabeled +The ContentIsNotLabeled parameter specifies a condition for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: + +- $true: Look for attachments or documents that aren't labeled. +- $false: Don't look for unlabeled attachments or documents. + +In Exchange, this condition is matched only if both the attachment and the message body aren't labeled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIsShared +The ContentIsNotLabeled parameter specifies a condition for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: + +- $true: Look for attachments or documents that aren't labeled. +- $false: Don't look for unlabeled attachments or documents. + +In Exchange, this condition is matched only if both the attachment and the message body aren't labeled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -465,7 +752,26 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disabled +The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: + +- $true: The rule is disabled. +- $false: The rule is enabled. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -485,7 +791,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -494,17 +800,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Disabled -The Disabled parameter specifies whether the DLP rule is disabled. Valid values are: +### -DocumentCreatedBy +The DocumentCreatedBy parameter specifies a condition for the DLP rule that looks for documents that are created by the specificed identity. You can specify multiple values separated by commas. -- $true: The rule is disabled. -- $false: The rule is enabled. This is the default value. +This parameter applies to Sharepoint and Onedrive workloads. ```yaml -Type: Boolean +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedByMemberOf +The DocumentCreatedByMemberOf parameter specifies a condition for the DLP rule that looks for documents that are created by a member of the specificed group. You can specify multiple values separated by commas. + +This parameter applies to Sharepoint and Onedrive workloads. + +```yaml +Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -514,7 +837,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -523,7 +846,7 @@ The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -542,7 +865,7 @@ The DocumentIsUnsupported parameter specifies a condition for the DLP rule that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -560,9 +883,9 @@ You can use this condition in DLP policies that are scoped only to Exchange. ```yaml Type: MultiValuedProperty -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -572,15 +895,15 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesPatterns -The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. +The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -590,7 +913,7 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords -The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the file name of message attachments. You can specify multiple words or phrases separated by commas. +The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` - Multiple words: `no_reply,urgent,...` @@ -602,7 +925,7 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -627,10 +950,10 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -638,7 +961,23 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -DomainCountOver +The DomainCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipient domains is greater than the specified value. + +You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -EncryptRMSTemplate The EncryptRMSTemplate parameter specifies an action for the DLP rule that applies rights management service (RMS) templates to files. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). @@ -648,7 +987,23 @@ Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpBrowserRestrictions +{{ Fill EndpointDlpBrowserRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -658,11 +1013,13 @@ Accept wildcard characters: False ``` ### -EndpointDlpRestrictions -The EndpointDlpRestrictions parameter specifies the restricted endpoints. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. -The value of `` is one of the supported values. +The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. -The value of `` is Audit, Block, Ignore, or Warn. +The `` value is one of the supported values. + +The available values for `` are: Audit, Block, Ignore, or Warn. Example values: @@ -678,11 +1035,60 @@ When you use the values Block or Warn in this parameter, you also need to use th You can view and configure the available restrictions with the Get-PolicyConfig and Set-PolicyConfig cmdlets. +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcePortalAccess +The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: + +- $true: External recipients are required to use the encrypted message portal to view encrypted messages. +- $false: External recipients aren't required to use the encrypted message portal. Outlook can decrypt messages inline. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvaluateRulePerComponent +The EvaluateRulePerComponent parameter specifies whether a match for conditions and exceptions in the rule is contained within the same message component. Valid values are: + +- $true: A DLP rule match for conditions and exceptions must be in the same message component (for example, in the message body or in a single attachment). +- $false: A DLP rule match for conditions and exceptions can be anywhere in the message. + +For example, say a DLP rule is configured to block messages that contain three or more Social Security numbers (SSNs). When the value of this parameter is $true, a message is blocked only if there are three or more SSNs in the message body, or there are three or more SSNs in a specific attachment. The DLP rule doesn't match and the message isn't blocked if there are two SSNs in the message body, one SSN in an attachment, and two SSNs in another attachment in the same email message. + +This parameter works with the following conditions or exceptions only: + +- Content contains +- Attachment contains +- Attachment is not labeled +- File extension is + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -694,15 +1100,15 @@ Accept wildcard characters: False ### -ExceptIfAccessScope The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: -- InOrganization: The rule isn't applied to content that's accessible inside the organization. -- NotInOrganization: The rule isn't applied to content that's accessible outside the organization. +- InOrganization: The rule isn't applied to content that's accessible or delivered to a recipient inside the organization. +- NotInOrganization: The rule isn't applied to content that's accessible or delivered to a recipient outside the organization. - None: The exception isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -718,7 +1124,7 @@ The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception - Multiple words: `no_reply,urgent,...` - Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` -The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. You can use this exception in DLP policies that are scoped only to Exchange. @@ -726,7 +1132,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -738,7 +1144,7 @@ Accept wildcard characters: False ### -ExceptIfAnyOfRecipientAddressMatchesPatterns The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this exception in DLP policies that are scoped only to Exchange. @@ -746,7 +1152,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -766,7 +1172,7 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -778,15 +1184,15 @@ Accept wildcard characters: False ### -ExceptIfContentContainsSensitiveInformation The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. -This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `labels = @(@{name ="Confidential"; type ="Sensitivity";})` +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -796,13 +1202,13 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords -The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. +The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -811,16 +1217,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfContentPropertyContainsWords -The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. - -This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. +### -ExceptIfContentFileTypeMatches +{{ Fill ExceptIfContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -829,18 +1233,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentContainsWords -The DocumentContainsWords parameter specifies an exception for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. +### -ExceptIfContentIsShared +The ContentIsNotLabeled parameter specifies an exception for the DLP rule that looks for attachments or documents that aren't labeled. Valid values are: -To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. +- $true: Look for attachments or documents that aren't labeled. +- $false: Don't look for unlabeled attachments or documents. -You can use this exception in DLP policies that are scoped only to Exchange. +In Exchange, this condition is matched only if both the attachment and the message body aren't labeled. ```yaml -Type: MultiValuedProperty +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -849,17 +1254,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +### -ExceptIfContentPropertyContainsWords +The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. -- $true: Look for password protected files. -- $false: Don't look for password protected files. +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. ```yaml -Type: Boolean +Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -868,17 +1272,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentIsUnsupported -The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: +### -ExceptIfDocumentContainsWords +The ExceptIfDocumentContainsWords parameter specifies an exception for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. -- $true: Look for unsupported files that can't be scanned. -- $false: Don't look for unsupported files that can't be scanned. +To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: Boolean +Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -887,16 +1292,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentNameMatchesPatterns -The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. +### -ExceptIfDocumentCreatedBy +The DocumentCreatedBy parameter specifies an exception for the DLP rule that looks for documents that are created by the specificed identity. You can specify multiple values separated by commas. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +This parameter applies to Sharepoint and Onedrive workloads. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -905,18 +1310,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentMatchesPatterns -The DocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. - -You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. +### -ExceptIfDocumentCreatedByMemberOf +The DocumentCreatedByMemberOf parameter specifies an exception for the DLP rule that looks for documents that are created by a member of the specificed group. You can specify multiple values separated by commas. -You can use this exception in DLP policies that are scoped only to Exchange. +This parameter applies to Sharepoint and Onedrive workloads. ```yaml -Type: MultiValuedProperty -Parameter Sets: Default +Type: RecipientIdParameter[] +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -925,20 +1328,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentNameMatchesWords -The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the file name of message attachments. You can specify multiple words or phrases separated by commas. - -- Single word: `"no_reply"` -- Multiple words: `no_reply,urgent,...` -- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` +### -ExceptIfDocumentIsPasswordProtected +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: -The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. +- $true: Look for password protected files. +- $false: Don't look for password protected files. ```yaml -Type: MultiValuedProperty +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -947,13 +1347,92 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentSizeOver -The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. +### -ExceptIfDocumentIsUnsupported +The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: -When you enter a value, qualify the value with one of the following units: +- $true: Look for unsupported files that can't be scanned. +- $false: Don't look for unsupported files that can't be scanned. -- B (bytes) -- KB (kilobytes) +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesPatterns +The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentMatchesPatterns +The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesWords +The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentSizeOver +The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) - MB (megabytes) - GB (gigabytes) - TB (terabytes) @@ -963,10 +1442,10 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -984,7 +1463,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1008,7 +1487,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1020,7 +1499,7 @@ Accept wildcard characters: False ### -ExceptIfFromAddressMatchesPatterns The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1028,7 +1507,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1038,13 +1517,15 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf -This parameter is reserved for internal Microsoft use. +The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1056,16 +1537,16 @@ Accept wildcard characters: False ### -ExceptIfFromScope The ExceptIfFromScope parameter specifies an exception for the rule that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: FromScope +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1086,7 +1567,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1106,7 +1587,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1124,7 +1605,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1149,10 +1630,10 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize -Parameter Sets: Default +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1168,18 +1649,18 @@ The ExceptIfMessageTypeMatches parameter specifies an exception for the rule tha - AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). - AutomaticReply: Out of office (OOF) messages configured by the user. - Calendaring: Meeting requests and responses. -- Encrypted: Encrypted messages. -- PermissionControlled: Messages that have specific permissions configured. +- Encrypted: S/MIME encrypted messages. +- PermissionControlled: Messages protected with Rights Management, Office 365 Message Encryption (OME), and sensitivity labels (with encryption). - ReadReceipt: Read receipts. - Signed: Digitally signed messages. You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: MessageTypes +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1198,7 +1679,107 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeContainsWords +The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeMatchesPatterns +The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1208,13 +1789,13 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1228,33 +1809,33 @@ The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -1262,9 +1843,9 @@ You can use this exception in DLP policies that are scoped only to Exchange. ```yaml Type: PswsHashtable -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1278,33 +1859,33 @@ The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception fo - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -1312,9 +1893,9 @@ You can use this exception in DLP policies that are scoped only to Exchange. ```yaml Type: PswsHashtable -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1332,7 +1913,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1354,7 +1935,7 @@ You can specify values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1372,7 +1953,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1390,7 +1971,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1414,7 +1995,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1426,7 +2007,7 @@ Accept wildcard characters: False ### -ExceptIfSubjectMatchesPatterns The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1434,7 +2015,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1454,7 +2035,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1472,7 +2053,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1482,7 +2063,7 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs -The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. +The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -1490,7 +2071,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1509,10 +2090,10 @@ The ExceptIfWithImportance parameter specifies an exception for the rule that lo You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: WithImportance +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1525,10 +2106,10 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1546,7 +2127,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1570,7 +2151,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1582,7 +2163,7 @@ Accept wildcard characters: False ### -FromAddressMatchesPatterns The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this condition in DLP policies that are scoped only to Exchange. @@ -1590,7 +2171,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1600,13 +2181,15 @@ Accept wildcard characters: False ``` ### -FromMemberOf -This parameter is reserved for internal Microsoft use. +The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1618,16 +2201,16 @@ Accept wildcard characters: False ### -FromScope The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: FromScope +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1644,13 +2227,13 @@ The GenerateAlert parameter specifies an action for the DLP rule that notifies t You can specify multiple values separated by commas. -The email message that's generated by this action contains a link to detailed information in the Microsoft 365 compliance center (the details aren't in the email message itself). +The email message that's generated by this action contains a link to detailed information in the Microsoft Purview compliance portal (the details aren't in the email message itself). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1671,7 +2254,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1692,7 +2275,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1712,7 +2295,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1730,7 +2313,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1743,10 +2326,10 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1771,7 +2354,7 @@ The IncidentReportContent parameter specifies the content to include in the repo - Severity - Title -You can specify multiple values separated by commas. You can only use the value All by itself. If you use the value Default, the report includes the following content: +You can specify multiple values separated by commas. You can only use the value "All" by itself. If you use the value "Default", the report includes the following content: - DocumentAuthor - MatchedItem @@ -1779,13 +2362,29 @@ You can specify multiple values separated by commas. You can only use the value - Service - Title -Therefore, if you use any of these redundant values with the value Default, they will be ignored. +Therefore, any additional values that you use with the value "Default" are ignored. ```yaml Type: ReportContentOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageIsNotLabeled +{{ Fill MessageIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1810,10 +2409,10 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize -Parameter Sets: Default +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1829,8 +2428,8 @@ The MessageTypeMatches parameter specifies a condition for the rule that looks f - AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). - AutomaticReply: Out of office (OOF) messages configured by the user. - Calendaring: Meeting requests and responses. -- Encrypted: Encrypted messages. -- PermissionControlled: Messages that have specific permissions configured. +- Encrypted: S/MIME encrypted messages. +- PermissionControlled: Messages protected with Rights Management, Office 365 Message Encryption (OME), and sensitivity labels (with encryption). - ReadReceipt: Read receipts. - Signed: Digitally signed messages. @@ -1840,7 +2439,23 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MipRestrictAccess +{{ Fill MipRestrictAccess Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1850,7 +2465,7 @@ Accept wildcard characters: False ``` ### -Moderate -The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = @("emailaddress1","emailaddress2",..."emailaddressN")}`. +The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = "emailaddress1,emailaddress2,...emailaddressN"}`. You can use this action in DLP policies that are scoped only to Exchange. @@ -1858,7 +2473,7 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1867,20 +2482,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotifyAllowOverride -The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: +### -ModifySubject +The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. -- FalsePositive: Allows overrides in the case of false positives. -- WithoutJustification: Allows overrides without justification. -- WithJustification: Allows overrides with justification. +The `ReplaceStrategy=` property uses one of the following values: -You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. +- Replace: Replaces all regular expression matches (the `Patterns=` value) in the subject with the `SubjectText=` value. +- Append: Removes all regular expression matches (the `Patterns=` value) in the subject and inserts the `SubjectText=` value at the end of the subject. +- Prepend: Removes all regular expression matches (the `Patterns=` value) and inserts the `SubjectText=` value at the beginning of the subject. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. ```yaml -Type: OverrideOption[] -Parameter Sets: (All) +Type: PswsHashtable +Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1889,14 +2506,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotifyEmailCustomSubject -{{ Fill NotifyEmailCustomSubject Description }} +### -NonBifurcatingAccessScope +The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: + +- HasInternal: At least one recipient is inside the organization. +- HasExternal: At least one recipient is outside the organization. +- None: The condition isn't used. + +You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: String +Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1905,20 +2528,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotifyEmailCustomText -The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. +### -NotifyAllowOverride +The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: -This parameter has a 5000 character limit, and supports plain text, HTML tags and the following tokens (variables): +- FalsePositive: Allows overrides in the case of false positives. +- WithAcknowledgement: Allows overrides with explicit user acknowledgement. (Exchange only) +- WithoutJustification: Allows overrides without justification. +- WithJustification: Allows overrides with justification. -- %%AppliedActions%%: The actions applied to the content. -- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive for Business site. -- %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. +You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. ```yaml -Type: String +Type: OverrideOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1927,14 +2551,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotifyPolicyTipCustomText -The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. +### -NotifyEmailCustomSenderDisplayName +{{ Fill NotifyEmailCustomSenderDisplayName Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1943,14 +2567,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotifyPolicyTipCustomTextTranslations -This parameter is reserved for internal Microsoft use. +### -NotifyEmailCustomSubject +The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. ```yaml -Type: MultiValuedProperty +Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1959,21 +2583,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotifyUser -The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: +### -NotifyEmailCustomText +The NotifyEmailCustomText parameter specifies the custom text in the email notification message that's sent to recipients when the conditions of the rule are met. -- An email address. -- LastModifier -- Owner -- SiteAdmin +This parameter has a 5000 character limit, and supports plain text, HTML tags, and the following tokens (variables): -You can specify multiple values separated by commas. +- %%AppliedActions%%: The actions applied to the content. +- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive site. +- %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. +- %%BlockedMessageInfo%%: The details of the message that was blocked. Use this token to inform people of the details of the message that was blocked. ```yaml -Type: MultiValuedProperty +Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1982,14 +2606,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnPremisesScannerDlpRestrictions -{{ Fill OnPremisesScannerDlpRestrictions Description }} +### -NotifyEmailExchangeIncludeAttachment +{{ Fill NotifyEmailExchangeIncludeAttachment Description }} ```yaml -Type: PswsHashtable[] +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1998,18 +2622,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrependSubject -The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). - -Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. - -You can use this condition in DLP policies that are scoped only to Exchange. +### -NotifyEmailOnedriveRemediationActions +{{ Fill NotifyEmailOnedriveRemediationActions Description }} ```yaml -Type: String +Type: NotifyEmailRemediationActions Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2018,22 +2638,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. - -Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: +### -NotifyEndpointUser +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. -- Valid priority values for the existing 8 rules are from 0 through 7. -- Valid priority values for a new 9th rule that you add to the policy are from 0 through 8. -- The default value for a new 9th rule that you add to the policy is 8. +{{ Fill NotifyEndpointUser Description }} -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). ```yaml -Type: Int32 -Parameter Sets: (All) +Type: PswsHashtable +Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2042,17 +2658,363 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProcessingLimitExceeded -The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: +### -NotifyOverrideRequirements +{{ Fill NotifyOverrideRequirements Description }} -- $true: Look for files where scanning couldn't complete. +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomDialog +{{ Fill NotifyPolicyTipCustomDialog Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomText +The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Tip notification message that's shown to recipients when the conditions of the rule are met. The maximum length is 256 characters. HTML tags and tokens (variables) aren't supported. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomTextTranslations +The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. + +Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. For example: `"en:PolicyTipInEnglish","zh:警告：这个文件含有非法内容","th:คำแนะนำนโยบายในไทย"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipDisplayOption +The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: + +- Tip: Displays policy tip at the top of the mail. This is the default value. +- Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only) + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipUrl +The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUser +The NotifyUser parameter specifies an action for the DLP rule that notifies the specified users when the conditions of the rule are met. Valid values are: + +- An email address. +- LastModifier +- Owner +- SiteAdmin + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUserType +The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: + +- NotSet +- Email +- PolicyTip +- Email,PolicyTip + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnPremisesScannerDlpRestrictions +{{ Fill OnPremisesScannerDlpRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrependSubject +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is text that you specify. If the text contains spaces, enclose the value in quotation marks ("). + +Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing within the policy. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +Valid values and the default value for this parameter depend on the number of existing rules in the policy. For example, if there are 8 existing rules: + +- Valid priority values for the existing 8 rules are from 0 through 7. +- Valid priority values for a new 9th rule that you add to the policy are from 0 through 8. +- The default value for a new 9th rule that you add to the policy is 8. + +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProcessingLimitExceeded +The ProcessingLimitExceeded parameter specifies a condition for the DLP rule that looks for files where scanning couldn't complete. You can use this condition to create rules that work together to identify and process messages where the content couldn't be fully scanned. Valid values are: + +- $true: Look for files where scanning couldn't complete. - $false: Don't look for files where scanning couldn't complete. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quarantine +This parameter specifies an action or part of an action for the rule. + +The Quarantine parameter specifies an action that quarantines messages. Valid values are: + +- $true: The message is delivered to the hosted quarantine. +- $false: The message is not quarantined. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeContainsWords +The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeMatchesPatterns +The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientCountOver +The RecipientCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipients is greater than the specified value. Groups are counted as one recipient. + +You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -2062,13 +3024,13 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2086,7 +3048,7 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2106,7 +3068,7 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2116,7 +3078,7 @@ Accept wildcard characters: False ``` ### -RemoveRMSTemplate -The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Office 365 Message Encryption from messages and their attachments. Valid values are: +The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: - $true: The message and attachments are decrypted. - $False: The messages and attachments are not decrypted. @@ -2125,9 +3087,9 @@ You can use this action in DLP policies that are scoped only to Exchange. ```yaml Type: Boolean -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2148,7 +3110,39 @@ The ReportSeverityLevel parameter specifies the severity level of the incident r Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictAccess +{{ Fill RestrictAccess Description }} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictBrowserAccess +{{ Fill RestrictBrowserAccess Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -2165,10 +3159,10 @@ The RuleErrorAction parameter specifies what to do if an error is encountered du - Blank (the value $null): This is the default value. ```yaml -Type: PolicyRuleErrorAction +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2182,33 +3176,33 @@ The SenderADAttributeContainsWords parameter specifies a condition for the DLP r - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code -This parameter uses the syntax: `@{AttributeName:"Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"Word1";AttributeName2:"Word2";...AttributeNameN:"WordN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. When you specify multiple attributes, the OR operator is used. @@ -2216,9 +3210,9 @@ You can use this condition in DLP policies that are scoped only to Exchange. ```yaml Type: PswsHashtable -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2232,43 +3226,71 @@ The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP - City - Company -- Country +- Country or Region - CustomAttribute1 to CustomAttribute15 - Department - DisplayName -- Email -- FaxNumber +- Email Addresses +- Fax - FirstName - HomePhoneNumber - Initials - LastName - Manager -- MobileNumber +- Mobile Phone - Notes - Office -- OtherFaxNumber -- OtherHomePhoneNumber -- OtherPhoneNumber -- PagerNumber -- PhoneNumber -- POBox -- State -- Street +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address - Title - UserLogonName -- ZipCode +- Postal Code -This parameter uses the syntax: `@{AttributeName:"RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1:"RegularExpression1";AttributeName2:"RegularExpression2";...AttributeNameN:"RegularExpressionN"}`. Don't use words with leading or trailing spaces. +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. -When you specify multiple attributes, the or operator is used. +When you specify multiple attributes, the OR operator is used. You can use this condition in DLP policies that are scoped only to Exchange. ```yaml Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddressLocation +The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: + +- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. +- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). +- HeaderOrEnvelope: Examine senders in the message header and the message envelope. + +Note that message envelope searching is available only for the following conditions and exceptions: + +- From and ExceptIfFrom +- FromAddressContainsWords and ExceptIfFromAddressContainsWords +- FromAddressMatchesPatterns and ExceptIfFromAddressMatchesPatterns +- FromMemberOf and ExceptIfFromMemberOf +- SenderDomainIs and ExceptIfSenderDomainIs + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2286,7 +3308,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2296,7 +3318,7 @@ Accept wildcard characters: False ``` ### -SenderIPRanges -The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: +The SenderIpRanges parameter specifies a condition for the DLP rule that looks for senders whose IP addresses matches the specified value or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. - IP address range: For example, 192.168.0.1-192.168.0.254. @@ -2308,7 +3330,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2326,7 +3348,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2344,7 +3366,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2364,7 +3386,29 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedByIRMUserRisk +The SharedByIRMUserRisk parameter specifies the risk category of the user performing the violating action. Valid values are: + +- FCB9FA93-6269-4ACF-A756-832E79B36A2A (Elevated Risk Level) +- 797C4446-5C73-484F-8E58-0CCA08D6DF6C (Moderate Risk Level) +- 75A4318B-94A2-4323-BA42-2CA6DB29AAFE (Minor Risk Level) + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -2383,7 +3427,7 @@ The StopPolicyProcessing parameter specifies an action that stops processing mor Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2407,7 +3451,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2419,7 +3463,7 @@ Accept wildcard characters: False ### -SubjectMatchesPatterns The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2427,7 +3471,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2447,7 +3491,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2465,7 +3509,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2481,7 +3525,23 @@ Accept wildcard characters: False Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerPowerAutomateFlow +{{ Fill TriggerPowerAutomateFlow Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -2491,7 +3551,7 @@ Accept wildcard characters: False ``` ### -UnscannableDocumentExtensionIs -The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. +The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files aren't scannable. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -2499,7 +3559,23 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ValidateRule +{{ Fill ValidateRule Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -2509,13 +3585,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2534,10 +3610,10 @@ The WithImportance parameter specifies a condition for the rule that looks for m You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: WithImportance +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2551,12 +3627,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md index 1581023595..27c440830a 100644 --- a/exchange/exchange-ps/exchange/New-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/New-DlpEdmSchema.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpedmschema -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpedmschema +applicable: Security & Compliance title: New-DlpEdmSchema schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DlpEdmSchema ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-DlpEdmSchema cmdlet to create exact data match (EDM)-based classification schemas in the Microsoft 365 compliance center. Such schemas can be used with data loss prevention (DLP) policies. +Use the New-DlpEdmSchema cmdlet to create exact data match (EDM)-based classification schemas in the Microsoft Purview compliance portal. Such schemas can be used with data loss prevention (DLP) policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,32 +28,31 @@ New-DlpEdmSchema [-FileData] ``` ## DESCRIPTION -For an explanation and example of the EDM schema, see [Define the schema for your database of sensitive information](https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification#define-the-schema-for-your-database-of-sensitive-information). +For an explanation and example of the EDM schema, see [Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell -$edmSchemaXml = Get-Content "C:\My Documents\edm.xml" -Encoding Byte -ReadCount 0 -New-DlpEdmSchema -FileData $edmSchemaXml -Confirm:$true +New-DlpEdmSchema -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\edm.xml')) -Confirm:$true ``` -This example creates a new DLP EDM schema. The first command reads the schema in the XML file to a variable, and the second command uses that information to create the DLP EDM schema. +This example creates a new DLP EDM schema using the file named edm.xml in the folder C:\\My Documents. ## PARAMETERS ### -FileData The FileData parameter specifies the DLP EDM schema that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -72,7 +71,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +81,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -102,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DlpFingerprint.md b/exchange/exchange-ps/exchange/New-DlpFingerprint.md index e4ae0425c9..cbd457cd29 100644 --- a/exchange/exchange-ps/exchange/New-DlpFingerprint.md +++ b/exchange/exchange-ps/exchange/New-DlpFingerprint.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpfingerprint -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpfingerprint +applicable: Security & Compliance title: New-DlpFingerprint schema: 2.0.0 author: chrisda @@ -12,17 +12,19 @@ ms.reviewer: # New-DlpFingerprint ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-DlpFingerprint cmdlet to create document fingerprints that are used with data loss prevention (DLP) sensitive information types in the Microsoft 365 compliance center. Because the results of New-DlpFingerprint aren't stored outside of the sensitive information type, you always run New-DlpFingerprint and New-DlpSensitiveInformationType or Set-DlpSensitiveInformationType in the same PowerShell session. +Use the New-DlpFingerprint cmdlet to create document fingerprints that are used with data loss prevention (DLP) sensitive information types in the Microsoft Purview compliance portal. Because the results of New-DlpFingerprint aren't stored outside of the sensitive information type, you always run New-DlpFingerprint and New-DlpSensitiveInformationType or Set-DlpSensitiveInformationType in the same PowerShell session. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` New-DlpFingerprint [[-FileData] ] -Description + [-IsExact ] [-Confirm] + [-ThresholdConfig ] [-WhatIf] [] ``` @@ -30,13 +32,14 @@ New-DlpFingerprint [[-FileData] ] -Description ## DESCRIPTION Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell -$Patent_Template = Get-Content "C:\My Documents\Contoso Patent Template.docx" -Encoding byte +$Patent_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Patent Template.docx)' + $Patent_Fingerprint = New-DlpFingerprint -FileData $Patent_Template -Description "Contoso Patent Template" ``` @@ -44,6 +47,24 @@ This example creates a new document fingerprint based on the file C:\\My Documen ## PARAMETERS +### -FileData +The FileData parameter specifies the file to use as a document fingerprint. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description The Description parameter specifies a description for the document fingerprint. @@ -51,7 +72,7 @@ The Description parameter specifies a description for the document fingerprint. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -70,7 +91,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -79,32 +100,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileData -The FileData parameter specifies the file to use as a document fingerprint. +### -IsExact +{{ Fill IsExact Description }} -You need to read the file to a byte-encoded object using the Get-Content cmdlet. For details, see the Examples section in this topic. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} ```yaml -Type: Byte[] +Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -118,12 +153,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md index 2c80317dc6..10ac021e60 100644 --- a/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/New-DlpKeywordDictionary.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpkeyworddictionary -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpkeyworddictionary +applicable: Security & Compliance title: New-DlpKeywordDictionary schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DlpKeywordDictionary ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-DlpKeywordDictionary cmdlet to create data loss prevention (DLP) keyword dictionaries in the Microsoft 365 compliance center. +Use the New-DlpKeywordDictionary cmdlet to create data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,7 +24,9 @@ For information about the parameter sets in the Syntax section below, see [Excha New-DlpKeywordDictionary -Name [-Confirm] [-Description ] + [-DoNotPersistKeywords] [-FileData ] + [-Organization ] [-WhatIf] [] ``` @@ -32,14 +34,16 @@ New-DlpKeywordDictionary -Name ## DESCRIPTION After you create a custom sensitive information type that specifies the identity (GUID value) of the DLP keyword dictionary, the dictionary will appear in your list of sensitive information types, and you can use it in policies. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell $Keywords = @("Aarskog's syndrome","Abandonment","Abasia","Abderhalden-Kaufmann-Lignac","Abdominalgia","Abduction contracture","Abetalipo proteinemia","Abiotrophy","Ablatio","ablation","Ablepharia","Abocclusion","Abolition","Aborter","Abortion","Abortus","Aboulomania","Abrami's disease","Abramo") + $EncodedKeywords = $Keywords | ForEach-Object {[System.Text.Encoding]::Unicode.GetBytes($_+"`r`n")} + New-DlpKeywordDictionary -Name "Diseases" -Description "Names of diseases and injuries from ICD-10-CM lexicon" -FileData $EncodedKeywords ``` @@ -48,7 +52,9 @@ This example creates a DLP keyword dictionary named Diseases by using the specif ### Example 2 ```powershell $Keywords = Get-Content "C:\My Documents\InappropriateTerms.txt" -$EncodedKeywords = $Keywords | ForEach-Object{[System.Text.Encoding]::Unicode.GetBytes($_+"`r`n")} + +$EncodedKeywords = $Keywords | ForEach-Object {[System.Text.Encoding]::Unicode.GetBytes($_+"`r`n")} + New-DlpKeywordDictionary -Name "Inappropriate Language" -Description "Unprofessional and inappropriate terminology" -FileData $EncodedKeywords ``` @@ -63,7 +69,7 @@ The Name parameter specifies a unique name for the DLP keyword dictionary. If th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -82,7 +88,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -98,7 +104,23 @@ The Description parameter specifies descriptive text for the DLP keyword diction Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotPersistKeywords +{{ Fill DoNotPersistKeywords Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -114,7 +136,23 @@ The FileData parameter specifies the terms that are used in the DLP keyword dict Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +{{ Fill Organization Description }} + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -124,13 +162,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -144,12 +182,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DlpPolicy.md b/exchange/exchange-ps/exchange/New-DlpPolicy.md index 11c751c257..705a5e5e46 100644 --- a/exchange/exchange-ps/exchange/New-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/New-DlpPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlppolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlppolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-DlpPolicy schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # New-DlpPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: This cmdlet has been retired from the cloud-based service. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/exchange-online-etrs-to-stop-supporting-dlp-policies/ba-p/3886713). Use the New-DlpCompliancePolicy and New-DlpComplianceRule cmdlets instead. -Use the New-DlpPolicy cmdlet to create data loss prevention (DLP) policies in your Exchange organization. +This cmdlet is functional only in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the New-DlpPolicy cmdlet to create data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +37,7 @@ New-DlpPolicy [[-Name] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,6 +53,22 @@ This example creates a new DLP policy named Contoso PII with the following value ## PARAMETERS +### -Name +The Name parameter specifies a descriptive name for the DLP policy. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: 1 +Default value: None +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. @@ -87,8 +105,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -126,22 +142,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a descriptive name for the DLP policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Parameters The Parameters parameter specifies the parameter values that are required by the DLP policy template that you specify using the Template or TemplateData parameters. DLP policy templates may contain parameters that need to be populated with values from your organization. For example, a DLP policy template may include an exception group that defines users who are exempt from the DLP policy. @@ -195,7 +195,7 @@ Accept wildcard characters: False ### -TemplateData The TemplateData parameter specifies an external DLP policy template file from which you can create a new DLP policy. You can't use the TemplateData and Template parameters in the same command. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -231,12 +231,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md index 89d847105e..961c0d2e48 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationType.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtype +applicable: Security & Compliance title: New-DlpSensitiveInformationType schema: 2.0.0 author: chrisda @@ -12,18 +12,23 @@ ms.reviewer: # New-DlpSensitiveInformationType ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-DlpSensitiveInformationType cmdlet to create sensitive information type rules that use document fingerprints. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -New-DlpSensitiveInformationType [-Name] -Description -Fingerprints +New-DlpSensitiveInformationType [[-Name] ] + [-Fingerprints ] [-Confirm] + [-Description ] + [-FileData ] + [-IsExact ] [-Locale ] + [-ThresholdConfig ] [-WhatIf] [] ``` @@ -31,16 +36,20 @@ New-DlpSensitiveInformationType [-Name] -Description -Fingerpr ## DESCRIPTION Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell -$Employee_Template = Get-Content "C:\My Documents\Contoso Employee Template.docx" -Encoding byte -ReadCount 0 +$Employee_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Employee Template.docx') + $Employee_Fingerprint = New-DlpFingerprint -FileData $Employee_Template -Description "Contoso Employee Template" -$Customer_Template = Get-Content "D:\Data\Contoso Customer Template.docx" -Encoding byte + +$Customer_Template = [System.IO.File]::ReadAllBytes('D:\Data\Contoso Customer Template.docx') + $Customer_Fingerprint = New-DlpFingerprint -FileData $Customer_Template -Description "Contoso Customer Template" + New-DlpSensitiveInformationType -Name "Contoso Employee-Customer Confidential" -Fingerprints $Employee_Fingerprint[0],$Customer_Fingerprint[0] -Description "Message contains Contoso employee or customer information." ``` @@ -48,30 +57,32 @@ This example creates a new sensitive information type rule named "Contoso Employ ## PARAMETERS -### -Description -The Description parameter specifies a description for the sensitive information type rule. +### -Name +The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. + +The value of this parameter is used in the Policy Tip that's presented to users in Outlook on the web. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://docs.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. +The Fingerprints parameter specifies the byte-encoded files to use as document fingerprints. You can use multiple document fingerprints separated by commas. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -80,19 +91,33 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a name for the sensitive information type rule. The value must be less than 256 characters. - -The value of this parameter is used in the Policy Tip that's presented to users in Outlook on the web. +### -Description +The Description parameter specifies a description for the sensitive information type rule. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance -Required: True -Position: 1 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileData +{{ Fill FileData Description }} + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -108,7 +133,23 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsExact +{{ Fill IsExact Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -120,7 +161,7 @@ Accept wildcard characters: False ### -Locale The Locale parameter specifies the language that's associated with the sensitive information type rule. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). You can add additional language translations to the sensitive information type rule by using the Set-DlpSensitiveInformationType cmdlet. @@ -128,7 +169,23 @@ You can add additional language translations to the sensitive information type r Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThresholdConfig +{{ Fill ThresholdConfig Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -138,13 +195,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -158,12 +215,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md index 985c520b81..ff65bcc045 100644 --- a/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/New-DlpSensitiveInformationTypeRulePackage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/New-DlpSensitiveInformationTypeRulePackage -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-dlpsensitiveinformationtyperulepackage +applicable: Security & Compliance title: New-DlpSensitiveInformationTypeRulePackage schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-DlpSensitiveInformationTypeRulePackage ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-DlpSensitiveInformationTypeConfig cmdlet to import data loss prevention (DLP) sensitive information type rule packages in the Microsoft 365 compliance center. +Use the New-DlpSensitiveInformationTypeConfig cmdlet to import data loss prevention (DLP) sensitive information type rule packages in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,14 +31,13 @@ New-DlpSensitiveInformationTypeRulePackage [-FileData] ## DESCRIPTION Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell - -New-DlpSensitiveInformationTypeRulePackage -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External Sensitive Info Type Rule Collection.xml" -Encoding Byte -ReadCount 0)) +New-DlpSensitiveInformationTypeRulePackage -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External Sensitive Info Type Rule Collection.xml')) ``` This example imports the sensitive information type rule package C:\\My Documents\\External Sensitive Info Type Rule Collection.xml. @@ -48,13 +47,13 @@ This example imports the sensitive information type rule package C:\\My Document ### -FileData The FileData parameter specifies the sensitive information type rule package that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -73,7 +72,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -89,7 +88,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -99,13 +98,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -119,14 +118,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Create custom sensitive information types with Exact Data Match based classification](https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification) +[Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits) diff --git a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md index 9126432eff..548bcc5965 100644 --- a/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/New-DynamicDistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-dynamicdistributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/new-dynamicdistributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-DynamicDistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-DynamicDistributionGroup cmdlet to create dynamic distribution groups. A dynamic distribution group queries mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an email message is sent to the group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -83,9 +83,9 @@ The Conditional parameters that are used with the IncludedRecipients parameter a - The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPath filter. +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -98,7 +98,7 @@ This example creates a dynamic distribution group named Marketing Group that con ### Example 2 ```powershell -New-DynamicDistributionGroup -Name "Washington Management Team" -RecipientFilter "(RecipientType -eq 'UserMailbox') -and (Title -like 'Director*' -or Title -like 'Manager*') -and (StateOrProvince -eq 'WA')" -RecipientContainer "North America" +New-DynamicDistributionGroup -Name "Washington Management Team" -RecipientFilter "(RecipientTypeDetails -eq 'UserMailbox') -and (Title -like 'Director*' -or Title -like 'Manager*') -and (StateOrProvince -eq 'WA')" -RecipientContainer "North America" ``` This example creates a dynamic distribution group named Washington Management Team that contains all users in the organizational unit named North America from Washington State whose titles start with "Director" or "Manager". @@ -135,7 +135,7 @@ The IncludedRecipients parameter specifies a precanned filter that's based on th You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. -You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: WellKnownRecipientType @@ -151,16 +151,16 @@ Accept wildcard characters: False ``` ### -RecipientFilter -The RecipientFilter parameter specifies a custom OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). @@ -180,15 +180,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -242,7 +247,7 @@ The ConditionalCompany parameter specifies a precanned filter that's based on th When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -262,7 +267,7 @@ The ConditionalCustomAttribute1 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -282,7 +287,7 @@ The ConditionalCustomAttribute10 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -302,7 +307,7 @@ The ConditionalCustomAttribute11 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -322,7 +327,7 @@ The ConditionalCustomAttribute12 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -342,7 +347,7 @@ The ConditionalCustomAttribute13 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -362,7 +367,7 @@ The ConditionalCustomAttribute14 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -382,7 +387,7 @@ The ConditionalCustomAttribute15 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -402,7 +407,7 @@ The ConditionalCustomAttribute2 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -422,7 +427,7 @@ The ConditionalCustomAttribute3 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -442,7 +447,7 @@ The ConditionalCustomAttribute4 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -462,7 +467,7 @@ The ConditionalCustomAttribute5 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -482,7 +487,7 @@ The ConditionalCustomAttribute6 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -502,7 +507,7 @@ The ConditionalCustomAttribute7 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -522,7 +527,7 @@ The ConditionalCustomAttribute8 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -542,7 +547,7 @@ The ConditionalCustomAttribute9 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -562,7 +567,7 @@ The ConditionalDepartment parameter specifies a precanned filter that's based on When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -582,7 +587,7 @@ The ConditionalStateOrProvince parameter specifies a precanned filter that's bas When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -833,12 +838,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md deleted file mode 100644 index 197e9a57ae..0000000000 --- a/exchange/exchange-ps/exchange/New-EOPDistributionGroup.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-eopdistributiongroup -applicable: Exchange Online Protection -title: New-EOPDistributionGroup -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the New-EOPDistributionGroup cmdlet to create distribution groups or mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the New-DistributionGroup cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -New-EOPDistributionGroup -Name -ManagedBy - [-Alias ] - [-DisplayName ] - [-Members ] - [-Notes ] - [-PrimarySmtpAddress ] - [-Type ] - [] -``` - -## DESCRIPTION -You can use the New-EOPDistributionGroup cmdlet to create the following types of groups: - -- Mail-enabled universal security group (USG) -- Universal distribution group - -Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Security groups are used to grant permissions to multiple users. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -New-EOPDistributionGroup -Name Managers -Type Security -ManagedBy "Kitty Petersen" -``` - -This example creates a mail-enabled universal security group named Managers that's managed by Kitty Petersen. - -### Example 2 -```powershell -New-EOPDistributionGroup -Name "Security Team" -ManagedBy "Tyson Fawcett" -Alias SecurityTeamThree -DisplayName "Security Team" -Notes "Security leads from each division" -PrimarySmtpAddress SecTeamThree@contoso.com -Type Distribution -Members @("Tyson Fawcett","Kitty Petersen") -``` - -This example creates a distribution group named "Security Team" and adds two users to the group. - -## PARAMETERS - -### -Name -The Name parameter specifies the name of the distribution group object. The value specified in the Name parameter is also used for the DisplayName parameter if the DisplayName parameter isn't specified. - -The Name parameter value can't exceed 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies a user who owns the group. You need to use this parameter to specify at least one group owner. You can use any value that uniquely identifies the user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -You can specify multiple owners by using the following syntax: `@("User1","User2",..."UserN")`. - -The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the email alias of the distribution group. The Alias parameter value is used to generate the primary SMTP email address if you don't use the PrimarySmtpAddress parameter. - -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -If you don't use the Alias parameter when you create a group, the value of the Name parameter is used for the alias. This value is also used in the primary SMTP email address. Spaces are removed and unsupported characters are converted to question marks (?). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). If the DisplayName parameter isn't specified, the value of the Name parameter is used for the DisplayName parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Members -The Members parameter specifies the initial list of recipients (mail-enabled objects) in the distribution group. In Exchange Online Protection, the valid recipient types are: - -- Mail users -- Distribution groups -- Mail-enabled security groups - -You can use any value that uniquely identifies the recipient. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -You can specify multiple recipients by using the following syntax: `@("Recipient1","Recipient2",..."RecipientN")`. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The Type parameter specifies the group type. Valid values are: - -- Distribution (This is the default value). -- Security - -```yaml -Type: GroupType -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-EOPMailUser.md b/exchange/exchange-ps/exchange/New-EOPMailUser.md deleted file mode 100644 index 97e5115767..0000000000 --- a/exchange/exchange-ps/exchange/New-EOPMailUser.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-eopmailuser -applicable: Exchange Online Protection -title: New-EOPMailUser -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the New-EOPMailUser cmdlet to create mail users, also known as mail-enabled users, in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the New-MailUser cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -New-EOPMailUser -MicrosoftOnlineServicesID -Name -Password - [-Alias ] - [-DisplayName ] - [-ExternalEmailAddress ] - [-FirstName ] - [-Initials ] - [-LastName ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -New-EOPMailUser -Name EdMeadows -MicrosoftOnlineServicesID EdMeadows@Contoso.onmicrosoft.com -ExternalEmailAddress EdMeadows@tailspintoys.com -Password (ConvertTo-SecureString -String 'Pa$$w0rd' -AsPlainText -Force) -FirstName Ed -LastName Meadows -DisplayName "Ed Meadows" -Alias edm -``` - -This example creates a mail user object for Ed Meadows while specifying several additional optional parameters and using an in-line method of password encryption. - -## PARAMETERS - -### -MicrosoftOnlineServicesID -The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments. - -```yaml -Type: WindowsLiveId -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the mail user object. The value specified in the Name parameter is also used for the DisplayName parameter if the DisplayName parameter isn't specified. - -The Name parameter value can't exceed 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The Password parameter specifies the password for the user's account. - -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the alias of the mail user. - -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -If you don't use the Alias parameter when you create a mail user, the left side of the MicrosoftOnlineServicesID parameter value is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias value helpdesk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the mail user in the Exchange admin center (EAC). - -If you don't use this parameter, the value of the Name parameter is used for the display name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalEmailAddress -The ExternalEmailAddress parameter specifies the user's email address that's outside of the Exchange Online Protection organization. Email messages sent to the mail user are relayed to this external address. - -If you don't use this parameter, the value of the MicrosoftOnlineServicesID parameter is used for the external email address. - -```yaml -Type: ProxyAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Initials -The Initials parameter specifies the user's middle initials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -The LastName parameter specifies the user's last name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..0f0e180485 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-EOPProtectionPolicyRule.md @@ -0,0 +1,386 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: New-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-EOPProtectionPolicyRule cmdlet to create rules for Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. + +**Note**: Unless you manually removed a rule using the Remove-EOPProtectionPolicyRule cmdlet, we don't recommend using this cmdlet to create rules. To create the rule, you need to specify the existing individual security policies that are associated with the preset security policy. We never recommend creating these required individual security policies manually. Turning on the preset security policy for the first time in the Microsoft Defender portal automatically creates the required individual security policies, but also creates the associated rules using this cmdlet. So, if the rules already exist, you don't need to use this cmdlet to create them. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-EOPProtectionPolicyRule [-Name] [-Priority ] -AntiPhishPolicy -HostedContentFilterPolicy -MalwareFilterPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-EOPProtectionPolicyRule -Name "Standard Preset Security Policy" -AntiPhishPolicy "Standard Preset Security Policy1622650005393" -HostedContentFilterPolicy "Standard Preset Security Policy1622650006407" -MalwareFilterPolicy "Standard Preset Security Policy1622650007658" Priority 1 +``` + +This example creates the rule for the Standard preset security policy. No restrictions are placed on who the Defender for Office 365 protections apply to. If the rule already exists, the command will fail. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. Since you don't need to create rules other than those used by the Standard preset security policy or the Strict preset security policy, we highly recommend that you use the default rule names for clarity and consistency. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AntiPhishPolicy +The AntiPhishPolicy parameter specifies the existing anti-phishing policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-phishing policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650005393`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034844713`. + +You can find the anti-phishing policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-AntiPhishPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `AntiPhishPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: AntiPhishPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostedContentFilterPolicy +The HostedContentFilterPolicy parameter specifies the existing anti-spam policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-spam policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650006407`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034847393`. + +You can find the anti-spam policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-HostedContentFilterPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `Get-HostedContentFilterPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: HostedContentFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareFilterPolicy +The HostedContentFilterPolicy parameter specifies the existing anti-malware policy that's associated with the preset security policy. + +If you ever turned on the preset security policy in the Microsoft Defender portal, the name of the anti-malware policy will be one of the following values: + +- Standard Preset Security Policy\<13-digit number\>. For example, `Standard Preset Security Policy1622650007658`. +- Strict Preset Security Policy\<13-digit number\>. For example, `Strict Preset Security Policy1642034871908`. + +You can find the anti-malware policy that's used by the Standard or Strict preset security policies by running the following commands: `Get-MalwareFilterPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Standard"` or `Get-MalwareFilterPolicy | Where-Object -Property RecommendedPolicyType -eq -Value "Strict"`. + +```yaml +Type: MalwareFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled. Valid values are: + +- $true: The rule is enabled. The State value of the rule is Enabled. This is the default value. +- $false: The rule is disabled. The State value of the rule is Disabled. + +After you create the rule, you turn on or turn off the preset security policy using one of the following commands: + +- Turn off: Disable-EOPProtectionPolicyRule. +- Turn on: Enable-EOPProtectionPolicyRule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. + +When you create the policy, you must use the default value. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md index 591ba91d9c..d888a64122 100644 --- a/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-EcpVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-ecpvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/new-ecpvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-EcpVirtualDirectory schema: 2.0.0 @@ -18,7 +18,7 @@ Use the New-EcpVirtualDirectory cmdlet to create Exchange Control Panel (ECP) vi The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013, and Exchange 2016 servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ New-EcpVirtualDirectory [-AppPoolId ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -300,12 +300,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-EdgeSubscription.md b/exchange/exchange-ps/exchange/New-EdgeSubscription.md index 1d5da0f89e..e7c67b1d70 100644 --- a/exchange/exchange-ps/exchange/New-EdgeSubscription.md +++ b/exchange/exchange-ps/exchange/New-EdgeSubscription.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-edgesubscription +online version: https://learn.microsoft.com/powershell/module/exchange/new-edgesubscription applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-EdgeSubscription schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-EdgeSubscription cmdlet to export an Edge Subscription file from an Edge Transport server and to import the Edge Subscription file to a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,20 +37,21 @@ New-EdgeSubscription [-AccountExpiryDuration ] ## DESCRIPTION The Edge Transport server doesn't have access to Active Directory. All configuration and recipient information is stored in the Active Directory Lightweight Directory Services (AD LDS) instance. The New-EdgeSubscription cmdlet creates the Edge Subscription file that will be imported on a Mailbox server in the Active Directory site to which you want to subscribe this Edge Transport server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-EdgeSubscription -FileName "c:\EdgeServerSubscription.xml" +New-EdgeSubscription -FileName "C:\Data\EdgeSubscription.xml" ``` This example creates the Edge Subscription file. It should be run on your Edge Transport server. ### Example 2 ```powershell -[byte[]]$Temp = Get-Content -Path "C:\EdgeServerSubscription.xml" -Encoding Byte -ReadCount 0 +$Temp = [System.IO.File]::ReadAllBytes('C:\Data\EdgeSubscription.xml') + New-EdgeSubscription -FileData $Temp -Site "Default-First-Site-Name" ``` @@ -60,7 +61,7 @@ The first command reads the data from the Edge Subscription file and stores it i ### Example 3 ```powershell -New-EdgeSubscription -FileData ([byte[]]$(Get-Content -Path "C:\EdgeServerSubscription.xml" -Encoding Byte -ReadCount 0)) -Site "Default-First-Site-Name" +New-EdgeSubscription -FileData ([System.IO.File]::ReadAllBytes('C:\Data\EdgeSubscription.xml')) -Site "Default-First-Site-Name" ``` This example also imports the Edge Subscription file generated in Example 1 to the Active Directory site Default-First-Site-Name; however, the end result is accomplished using one command. You must run this command on the Mailbox server. @@ -159,9 +160,9 @@ Accept wildcard characters: False ### -FileData The FileData parameter specifies the byte-encoded data object that contains the Edge Subscription file information. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). -You can only use this parameter when you're running this command on a Mailbox server. +You can only use this parameter when you're running the command on a Mailbox server. ```yaml Type: Byte[] @@ -195,9 +196,12 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +This switch is useful in the following scenarios: -This switch is useful when you use a script with the Edge Subscription command because it bypasses confirmation. Another scenario in which this switch is useful is when you have to subscribe an Edge Transport server again and you want to overwrite the existing configuration information. +- Bypassing confirmation when you script the Edge Subscription command. +- Recreating an Edge Transport server subscription and overwriting the existing configuration information. ```yaml Type: SwitchParameter @@ -249,12 +253,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md index f5a9ef41ed..f961f43a6f 100644 --- a/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/exchange/New-EdgeSyncServiceConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-edgesyncserviceconfig +online version: https://learn.microsoft.com/powershell/module/exchange/new-edgesyncserviceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-EdgeSyncServiceConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-EdgeSyncServiceConfig cmdlet to create edge synchronization service settings that control the general synchronization behavior shared by all EdgeSync services. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +42,7 @@ New-EdgeSyncServiceConfig [-ConfigurationSyncInterval ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -385,12 +385,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md index b9415377e5..966babe33d 100644 --- a/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/New-EmailAddressPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-emailaddresspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-EmailAddressPolicy schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the New-EmailAddressPolicy cmdlet to create email address policies. In Exchange Online, email address policies are only available for Microsoft 365 Groups. +Use the New-EmailAddressPolicy cmdlet to create email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -138,9 +138,9 @@ The Conditional parameters that are used with the IncludedRecipients parameter a - The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -159,7 +159,7 @@ This example creates an email address policy in an on-premises Exchange organiza ### Example 2 ```powershell -New-EmailAddressPolicy -Name "Northwest Executives" -RecipientFilter "(RecipientType -eq 'UserMailbox') -and (Title -like '*Director*' -or Title -like '*Manager*') -and (StateOrProvince -eq 'WA' -or StateOrProvince -eq 'OR' -or StateOrProvince -eq 'ID')" -EnabledEmailAddressTemplates "SMTP:%2g%s@contoso.com" -Priority 2 +New-EmailAddressPolicy -Name "Northwest Executives" -RecipientFilter "(RecipientTypeDetails -eq 'UserMailbox') -and (Title -like '*Director*' -or Title -like '*Manager*') -and (StateOrProvince -eq 'WA' -or StateOrProvince -eq 'OR' -or StateOrProvince -eq 'ID')" -EnabledEmailAddressTemplates "SMTP:%2g%s@contoso.com" -Priority 2 ``` This example creates an email address policy in an on-premises Exchange organization that uses a custom recipient filter: @@ -193,8 +193,8 @@ The EnabledEmailAddressTemplates parameter specifies the rules in the email addr Valid syntax for this parameter is `Type:AddressFormat`: -- Type: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. -- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. +- Type: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. This parameter requires at least one template with the Type value SMTP (to define the primary SMTP email address). After that, if you don't include a Type prefix for a template, the value smtp (an SMTP proxy address) is assumed. @@ -218,9 +218,9 @@ Accept wildcard characters: False ``` ### -EnabledPrimarySMTPAddressTemplate -The EnabledPrimarySMTPAddressTemplate parameter specifies the specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. +The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. -Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. +Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. You can't use this parameter with the EnabledEmailAddressTemplates parameter. @@ -253,7 +253,7 @@ The IncludedRecipients parameter specifies a precanned filter that's based on th You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. -You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: WellKnownRecipientType @@ -291,16 +291,16 @@ Accept wildcard characters: False ### -RecipientFilter This parameter is available only in on-premises Exchange. -The RecipientFilter parameter specifies a custom OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). @@ -324,7 +324,7 @@ The ConditionalCompany parameter specifies a precanned filter that's based on th When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -346,7 +346,7 @@ The ConditionalCustomAttribute1 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -368,7 +368,7 @@ The ConditionalCustomAttribute10 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -390,7 +390,7 @@ The ConditionalCustomAttribute11 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -412,7 +412,7 @@ The ConditionalCustomAttribute12 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -434,7 +434,7 @@ The ConditionalCustomAttribute13 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -456,7 +456,7 @@ The ConditionalCustomAttribute14 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -478,7 +478,7 @@ The ConditionalCustomAttribute15 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -500,7 +500,7 @@ The ConditionalCustomAttribute2 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -522,7 +522,7 @@ The ConditionalCustomAttribute3 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -544,7 +544,7 @@ The ConditionalCustomAttribute4 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -566,7 +566,7 @@ The ConditionalCustomAttribute5 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -588,7 +588,7 @@ The ConditionalCustomAttribute6 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -610,7 +610,7 @@ The ConditionalCustomAttribute7 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -632,7 +632,7 @@ The ConditionalCustomAttribute8 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -654,7 +654,7 @@ The ConditionalCustomAttribute9 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -676,7 +676,7 @@ The ConditionalDepartment parameter specifies a precanned filter that's based on When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -698,7 +698,7 @@ The ConditionalStateOrProvince parameter specifies a precanned filter that's bas When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -739,8 +739,8 @@ The DisabledEmailAddressTemplates parameter specifies the proxy email addresses Valid syntax for this parameter is `Type:AddressFormat`: -- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. -- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. +- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. You can specify multiple disabled email address templates separated by commas: `"[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. @@ -780,17 +780,17 @@ This parameter is available only in the cloud-based service. The ManagedByFilter parameter specifies the email address policies to apply to Microsoft 365 Groups based on the properties of the users who create the Microsoft 365 Groups. -This parameter is an OPath filter that's based on the value of any available recipient property (for example, `"Department -eq 'Sales'"`). You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +This parameter is an OPATH filter that's based on the value of any available recipient property (for example, `"Department -eq 'Sales'"`). You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). - You can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. -For more information, see [Choose the domain to use when creating Microsoft 365 Groups](https://docs.microsoft.com/microsoft-365/admin/create-groups/choose-domain-to-create-groups). +For more information, see [Choose the domain to use when creating Microsoft 365 Groups](https://learn.microsoft.com/microsoft-365/admin/create-groups/choose-domain-to-create-groups). -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can only use this parameter in Exchange Online PowerShell with the IncludeUnifiedGroupRecipients switch. @@ -873,12 +873,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md index c33b193d73..5d957d9ce7 100644 --- a/exchange/exchange-ps/exchange/New-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/New-ExchangeCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-exchangecertificate +online version: https://learn.microsoft.com/powershell/module/exchange/new-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-ExchangeCertificate schema: 2.0.0 @@ -16,15 +16,13 @@ This cmdlet is available only in on-premises Exchange. Use the New-ExchangeCertificate cmdlet to create and renew self-signed certificates, and to create certificate requests (also known as certificate signing requests or CSRs) for new certificates and certificate renewals from a certification authority (CA). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Request ``` -New-ExchangeCertificate [-BinaryEncoded] - [-GenerateRequest] - [-RequestFile ] +New-ExchangeCertificate [-BinaryEncoded] [-GenerateRequest] [-RequestFile ] [-Confirm] [-DomainController ] [-DomainName ] @@ -69,11 +67,11 @@ New-ExchangeCertificate [-Services ] ## DESCRIPTION Exchange uses certificates for SSL and TLS encryption. -There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://docs.microsoft.com/Exchange/architecture/client-access/certificates). +There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/certificates). Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center, and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out [Protecting you against the SSL 3.0 vulnerability](https://azure.microsoft.com/blog/protecting-against-the-ssl-3-0-vulnerability/). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -84,69 +82,100 @@ New-ExchangeCertificate This example creates a self-signed certificate with the following settings: -The Subject value is `CN=` (for example, CN=Mailbox01). - -The Domains (subject alternative names) value is `,` (for example, `Mailbox01,Mailbox01.contoso.com`). - -The Services value is IMAP,POP,SMTP - -The Services value SMTP grants the Network Services local security group read access to the certificate's private key. - -The Services value SMTP and the Subject value that contains the server name publishes the certificate to Active Directory so that Exchange direct trust can validate the authenticity of the server for mutual TLS. +- The Subject value is `CN=` (for example, CN=Mailbox01). +- The Domains (subject alternative names) value is `,` (for example, `Mailbox01,Mailbox01.contoso.com`). +- The Services value is `IMAP,POP,SMTP`. +- The Services value SMTP grants the Network Services local security group read access to the certificate's private key. +- The Services value SMTP and the Subject value that contains the server name publishes the certificate to Active Directory so that Exchange direct trust can validate the authenticity of the server for mutual TLS. If you don't want this certificate to replace the existing self-signed certificate that was created during Exchange setup, be sure to select "No" in the prompt that asks you overwrite the existing default SMTP certificate. ### Example 2 ```powershell -New-ExchangeCertificate -GenerateRequest -RequestFile "C:\Cert Requests\woodgrovebank.req" -SubjectName "c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com" -DomainName autodiscover.woodgrovebank.com,mail.fabrikam.com,autodiscover.fabrikam.com +Get-ExchangeCertificate -Thumbprint c4248cd7065c87cb942d60f7293feb7d533a4afc | New-ExchangeCertificate -PrivateKeyExportable $true ``` -This example creates a new certificate request for a certification authority that has the following settings: +This example shows how to renew a certificate with a specific thumbprint value. You can find the thumbprint value in one of two ways: + +- Select the certificate in the Exchange admin center and then select Edit to view properties of the certificate. The thumbprint value is shown in the Exchange Certificate window. +- Run the Get-ExchangeCertificate cmdlet to return a list of all certificates installed on the server with their thumbprint values. -The request is Base64 encoded. +Setting the PrivateKeyExportable parameter to the value $true allows the renewed certificate to be exported from the server (and imported on other servers). + +### Example 3 +```powershell +New-ExchangeCertificate -GenerateRequest -SubjectName "c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com" -DomainName autodiscover.woodgrovebank.com,mail.fabrikam.com,autodiscover.fabrikam.com -RequestFile "C:\Cert Requests\woodgrovebank.req" +``` -The output is displayed onscreen and is also written to the text file C:\\Cert Requests\\woodgrovebank.req. +In **Exchange 2013**, this example creates a new certificate request for a certification authority that has the following settings: -The Subject value is c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com +- The request is Base64 encoded. +- The Subject value is `c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com`. +- The Domains (subject alternative names) value contains the additional valuesautodiscover.woodgrovebank.com, mail.fabrikam.com, and autodiscover.fabrikam.com. +- The command output is displayed onscreen and is also written to the text file C:\\Cert Requests\\woodgrovebank.req. -The Domains (subject alternative names) value contains the additional valuesautodiscover.woodgrovebank.com,mail.fabrikam.com, and autodiscover.fabrikam.com. +**Note**: The RequestFile parameter is available only in Exchange 2013. To create a new certificate request file in Exchange 2016 or Exchange 2019, see Example 4 and Example 5. After you create the certificate request, you send the output to the CA. After you receive the certificate from the CA, you install the certificate by using the Import-ExchangeCertificate cmdlet, and you assign the certificate to Exchange services by using the Enable-ExchangeCertificate cmdlet. -If the CA requires the certificate request in a file that's encoded by DER, use the BinaryEncoding switch. +If the CA requires the certificate request in a file that's encoded by DER, use the BinaryEncoding switch and save the file with the .pfx extension. -### Example 3 +### Example 4 ```powershell -Get-ExchangeCertificate -Thumbprint c4248cd7065c87cb942d60f7293feb7d533a4afc | New-ExchangeCertificate -PrivateKeyExportable $true +$txtrequest = New-ExchangeCertificate -GenerateRequest -SubjectName "c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com" -DomainName autodiscover.woodgrovebank.com,mail.fabrikam.com,autodiscover.fabrikam.com + +[System.IO.File]::WriteAllBytes('\\FileServer01\Data\woodgrovebank.req', [System.Text.Encoding]::Unicode.GetBytes($txtrequest)) ``` -This example renewsthe existing self-signed certificate that has the thumbprint value c4248cd7065c87cb942d60f7293feb7d533a4afc. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. Setting the PrivateKeyExportable parameter to the value $true allows the renewed self-signed certificate to be exported from the server (and imported on other servers). +This example creates a new Base64 encoded certificate request for a certification authority using the same certificate settings as Example 3. -### Example 4 +This method is required in Exchange 2016 and Exchange 2019 because the RequestFile parameter is not available. + +### Example 5 +```PowerShell +$binrequest = New-ExchangeCertificate -GenerateRequest -BinaryEncoded -SubjectName "c=US,o=Woodgrove Bank,cn=mail.woodgrovebank.com" -DomainName autodiscover.woodgrovebank.com,mail.fabrikam.com,autodiscover.fabrikam.com + +[System.IO.File]::WriteAllBytes('\\FileServer01\Data\woodgrovebank.pfx', $binrequest.FileData) +``` + +This example creates a new DER encoded (binary) certificate request for a certification authority using the same certificate settings as Example 4. + +This method is required in Exchange 2016 and Exchange 2019 because the RequestFile parameter is not available. + +### Example 6 ```powershell Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest -RequestFile "C:\Cert Requests\fabrikam_renewal.req" ``` -This example creates a request to renew an existing certificate that was issued by a certification authority. The certificate request has the following settings: +In **Exchange 2013**, this example creates a request to renew an existing certificate that was issued by a certification authority. The certificate request has the following settings: -The thumbprint value of the existing certificate is 8A141F7F2BBA8041973399723BD2598D2ED2D831. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. +- The thumbprint value of the existing certificate is 8A141F7F2BBA8041973399723BD2598D2ED2D831. You can find the thumbprint value by using the Get-ExchangeCertificate cmdlet. +- The request is Base64 encoded. +- The output is displayed onscreen and is also written to the text file C:\\Cert Requests\\fabrikam\_renewal.req. -The request is Base64 encoded. - -The output is displayed onscreen and is also written to the text file C:\\Cert Requests\\fabrikam\_renewal.req. +**Note**: The RequestFile parameter is available only in Exchange 2013. To create a certificate renewal request for a certification authority in Exchange 2016 or Exchange 2019, see Example 7 and Example 8. After you create the certificate renewal request, you send the output to the CA. After you receive the renewed certificate from the CA, you install the certificate by using the Import-ExchangeCertificate cmdlet. -### Example 5 +### Example 7 ```powershell -Get-ExchangeCertificate -Thumbprint c4248cd7065c87cb942d60f7293feb7d533a4afc | New-ExchangeCertificate +$txtrequest = Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest + +[System.IO.File]::WriteAllBytes('C:\Cert Requests\fabrikam_renewal.req', [System.Text.Encoding]::Unicode.GetBytes($txtrequest)) ``` -This example shows how to renew a self-signed certificate with a specific thumbprint value. You can obtain the thumbprint value in one of two ways. +This example create a Base64 encoded certificate renewal request file for a certification authority using the same certificate settings as Example 6. + +This method is required in Exchange 2016 and Exchange 2019 because the RequestFile parameter is not available. + +### Example 8 +```powershell +$binrequest = Get-ExchangeCertificate -Thumbprint 8A141F7F2BBA8041973399723BD2598D2ED2D831 | New-ExchangeCertificate -GenerateRequest -Select the certificate in the Exchange Administration Center and then select Edit to view properties of the certificate. The thumbprint value is shown in the Exchange Certificate window. +[System.IO.File]::WriteAllBytes('C:\Cert Requests\fabrikam_renewal.pfx', $binrequest.FileData) +``` -Run the Get-ExchangeCertificate cmdlet to return a list of all certificates installed on the server with their thumbprint values. +This example creates a new DER encoded (binary) certificate renewal request file for a certification authority using the same certificate settings as Example 7. ## PARAMETERS @@ -210,7 +239,7 @@ Accept wildcard characters: False ``` ### -DomainName -The DomainName parameter specifies one or more FQDNs or server names for theSubject Alternative Namefield (also known as the Subject Alt Name or SAN field) of the certificate request or self-signed certificate. +The DomainName parameter specifies one or more FQDNs or server names for theSubject Alternative Name field (also known as the Subject Alt Name or SAN field) of the certificate request or self-signed certificate. If the value in the certificate's Subject field doesn't match the destination server name or FQDN, the requestor looks for a match in the Subject Alternative Name field. @@ -235,7 +264,7 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. By default, when you create a self-signed certificate that's enabled for SMTP (no Services parameter, or the Services parameter contains the value SMTP), you're prompted to replace the existing default SMTP certificate with the new one that you're creating. If you use the Force switch, the new SMTP certificate automatically replaces the existing SMTP certificate without asking. @@ -273,11 +302,11 @@ Accept wildcard characters: False ### -GenerateRequest The GenerateRequest switch specifies that you're creating a certificate request for a certification authority (CA). You don't need to specify a value with this switch. -This switch, together with the RequestFile parameter, generates a PKCS #10 certificate request that you send to the CA. How you send the information depends on the CA, but typically, for Base64 encoded requests, you paste the contents in an email message or in the request form on the CA's web site. +Using this switch and exporting the output to a file generates a PKCS #10 certificate request that you send to the CA. How you send the information depends on the CA, but typically, for Base64 encoded requests, you paste the contents in an email message or in the request form on the CA's web site. After you install the certificate from the certification authority by using the Import-ExchangeCertificate cmdlet, you use the Enable-ExchangeCertficate cmdlet to enable the certificate for Exchange services. -If you don't use this switch,thecommand creates a new self-signed certificate on the Exchange server. +If you don't use this switch, the command creates a new self-signed certificate on the Exchange server. ```yaml Type: SwitchParameter @@ -412,13 +441,11 @@ Accept wildcard characters: False ``` ### -PrivateKeyExportable -The PrivateKeyExportable parameter specifies whether the new self-signed certificate has an exportable private key, and controls whether you can export the certificate from the server (and import the certificate on other servers). Valid values are: +The PrivateKeyExportable parameter specifies whether the certificate has an exportable private key, and controls whether you can export the certificate from the server (and import the certificate on other servers). Valid values are: - $true: The private key is exportable, so you can export the certificate from the server. - $false: The private key isn't exportable, so you can't export the certificate. This is the default value. -This parameter is only meaningful for new self-signed certificates. - ```yaml Type: Boolean Parameter Sets: (All) @@ -433,6 +460,10 @@ Accept wildcard characters: False ``` ### -RequestFile +**Note**: This parameter was removed from Exchange 2016 and Exchange 2019 by the [2022 H1 Cumulative Updates](https://techcommunity.microsoft.com/t5/exchange-team-blog/released-2022-h1-cumulative-updates-for-exchange-server/ba-p/3285026) because it accepts UNC path values. To export the certificate request to a file without using the RequestFile parameter, see Example 4 and Example 5 (new) or Example 7 and Example 8 (renew). + +This parameter is available only in Exchange 2013. + The RequestFile parameter specifies the name and path of the certificate request file. The file contains the same information that's displayed on-screen when you generate a Base64 encoded certificate request (you don't use the BinaryEncoded switch). You can use a local path if the certificate or certificate request is located on the same Exchange server where you're running the command. Otherwise, use a UNC path (`\\Server\Share`). If the value contains spaces, enclose the value in quotation marks ("). @@ -443,7 +474,7 @@ You can use this parameter only when you use the GenerateRequest switch. Type: String Parameter Sets: Request Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013 Required: False Position: Named @@ -487,7 +518,7 @@ The Services parameter specifies the Exchange services that the new self-signed - UM: This value requires that the UMStartupMode parameter on the Set-UMService cmdlet is set to TLS or Dual. If the UMStartupMode parameter is set to the default value of TCP, you can't enable the certificate for the UM service. - UMCallRouter: This value requires that the UMStartupMode parameter on the Set-UMCallRouterService cmdlet is set to TLS or Dual. If the UMStartupMode parameter is set to the default value TCP, you can't enable the certificate for the UM Call Router service. -You can specify multiple values separated by commas. The default values are IMAP,POP, and SMTP. +You can specify multiple values separated by commas. The default values are IMAP, POP, and SMTP. You can't use this parameter with the GenerateRequest switch. @@ -575,12 +606,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ExchangeSettings.md b/exchange/exchange-ps/exchange/New-ExchangeSettings.md index 3d4f58f3f7..abedc962ae 100644 --- a/exchange/exchange-ps/exchange/New-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/New-ExchangeSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-exchangesettings +online version: https://learn.microsoft.com/powershell/module/exchange/new-exchangesettings applicable: Exchange Server 2016, Exchange Server 2019 title: New-ExchangeSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-ExchangeSettings cmdlet to create customized Exchange setting objects that are stored in Active Directory. Use the Set-ExchangeSettings cmdlet to configure the actual settings. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ New-ExchangeSettings [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -105,7 +105,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -141,12 +143,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md new file mode 100644 index 0000000000..cc46098b0a --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ExoPhishSimOverrideRule.md @@ -0,0 +1,209 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-exophishsimoverriderule +applicable: Exchange Online +title: New-ExoPhishSimOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ExoPhishSimOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ExoPhishSimOverrideRule cmdlet to create third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-ExoPhishSimOverrideRule -Policy -SenderIpRanges + [-Comment ] + [-Confirm] + [-DomainController ] + [-Domains ] + [-Name ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ExoPhishSimOverrideRule -Policy PhishSimOverridePolicy -Domains fabrikam.com,wingtiptoys.com -SenderIpRanges 192.168.1.55 +``` + +This example creates a new phishing simulation override rule with the specified settings. Regardless of the Name value specified, the rule name will be `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +## PARAMETERS + +### -Policy +The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderIpRanges +The SenderIpRanges parameter specifies the source IP address that's used by the third-party phishing simulation. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify up to 10 entries separated by commas. + +A phishing simulation entry requires at least one IP address in this parameter and at least one domain in the Domains parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domains +The Domains parameter specifies the email domain that's used by the third-party phishing simulation. You can use either of the following values: + +- The `5321.MailFrom` address (also known as the MAIL FROM address, P1 sender, or envelope sender). +- The DKIM domain. + +You can specify up to 20 values separated by commas. + +A phishing simulation requires at least one domain from this parameter and at least one IP address in the SenderIPRanges parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md new file mode 100644 index 0000000000..7abc967735 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ExoSecOpsOverrideRule.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-exosecopsoverriderule +applicable: Exchange Online +title: New-ExoSecOpsOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ExoSecOpsOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ExoSecOpsOverrideRule cmdlet to create SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +New-ExoSecOpsOverrideRule -Policy + [-Comment ] + [-Confirm] + [-DomainController ] + [-Name ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ExoSecOpsOverrideRule -Name SecOpsOverrideRule -Policy SecOpsOverridePolicy +``` + +This example creates the SecOps mailbox override rule with the specified settings. Regardless of the Name value specified, the rule name will be `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). + +## PARAMETERS + +### -Policy +The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977ef). + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FeatureConfiguration.md b/exchange/exchange-ps/exchange/New-FeatureConfiguration.md new file mode 100644 index 0000000000..2f093ab5f4 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-FeatureConfiguration.md @@ -0,0 +1,218 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-featureconfiguration +applicable: Security & Compliance +title: New-FeatureConfiguration +schema: 2.0.0 +--- + +# New-FeatureConfiguration + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. + +Use the New-FeatureConfiguration cmdlet to create Microsoft Purview feature configurations within your organization, including: + +- Collection policies. +- Advanced label based protection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-FeatureConfiguration [-Name] -Mode -FeatureScenario -ScenarioConfig + [-Comment ] + [-Confirm] + [-Locations ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +New-FeatureConfiguration -Name "Collection policy for supported Copilots" -FeatureScenario KnowYourData -Mode Enable -ScenarioConfig '{"Activities":["UploadText","DownloadText"],"EnforcementPlanes":["CopilotExperiences","Browser"],"SensitiveTypeIds":["All"],"IsIngestionEnabled":true}' –Locations '[{"Workload":"Applications","Location":"52655","LocationSource":"SaaS","LocationType":"Individual","Inclusions":[{"Type":"Tenant","Identity":"All","DisplayName":"All","Name":"All"}]},{"Workload":"Applications","Location":"49baeafd-1a6b-4c58-be55-75ae6d1dff6a","LocationSource":"PurviewConfig","LocationType":"Group","Inclusions":[{"Type":"Tenant","Identity":"All","DisplayName":"All","Name":"All"}]}]' +``` + +This example creates an enabled collection policy named "Collection policy for supported Copilots" that: +- Includes UploadText & DownloadText activity for all supported classifiers +- Captures all AI prompts +- Includes Microsoft Copilot & Copilot Experiences locations, both scoped to all users & groups + +### Example 2 +```powershell +New-FeatureConfiguration -Name "Scoped browser collection policy for Microsoft Copilot" -FeatureScenario KnowYourData -Mode Enable -ScenarioConfig '{"Activities":["UploadText"],"EnforcementPlanes":["Browser"],"SensitiveTypeIds":["All"],"ExcludedSensitiveTypeIds":["50b8b56b-4ef8-44c2-a924-03374f5831ce","8548332d-6d71-41f8-97db-cc3b5fa544e6"],"IsIngestionEnabled":false}' –Locations '[{"Workload":"Applications","Location":"52655","LocationDisplayName":null,"LocationSource":"SaaS","LocationType":"Individual","Inclusions":[{"Type":"Tenant","Identity":"All","DisplayName":"All","Name":"All"}],"Exclusions":[{"Type":"Group","Identity":"db458ddb-4f56-4d88-a4f7-e29545560839","DisplayName":"Contoso Executives","Name":"Executives@contoso.com"}]}]' +``` + +This example creates an enabled collection policy named "Scoped browser collection policy for Microsoft Copilot" that: +- Includes UploadText activity for all supported classifiers except "All Full Names" and "All Physical Addresses" +- Includes Microsoft Copilot location, for all users & groups except the "Contoso Executives Group" + +### Example 3 +```powershell +New-FeatureConfiguration -Name "Scoped collection policies for browser and devices" -FeatureScenario KnowYourData -Mode Disable -ScenarioConfig '{"Activities":["UploadText","filecreated","filedeleted","filemodified"],"EnforcementPlanes":["Devices","Browser"],"SensitiveTypeIds":["a44669fe-0d48-453d-a9b1-2cc83f2cba77","cb353f78-2b72-4c3c-8827-92ebe4f69fdf"],"FileExtensions":["pdf"],"IsIngestionEnabled":false}' –Locations '[{"Workload":"EndpointDevices","Location":"","Inclusions":[{"Type":"Group","Identity":"db458ddb-4f56-4d88-a4f7-e29545560839","DisplayName":"All Company","Name":"allcompany@contoso.com"}],"Exclusions":[{"Type":"IndividualResource","Identity":"a828f25a-cede-4d0e-97e6-b0b0c913732a","DisplayName":"Alex Wilber","Name":"alex@contoso.com"}]},{"Workload":"Applications","Location":"52655","LocationSource":"SaaS","LocationType":"Individual","Inclusions":[{"Type":"IndividualResource","Identity":"84f9af2e-b224-4cb8-b9cd-bc531bb07a48","DisplayName":"Adele Vance","Name":"adele@contoso.com"}]}]' +``` + +This example creates a disabled collection policy named "Scoped collection policies for browser and devices" that: +- Includes UploadText (for browser) and filecreated, filedeleted, and filemodified activities (for devices) +- Includes "U.S. Social Security Number (SSN)" and "ABA Routing Number" classifiers only +- Detects files on devices with "pdf" file extension only +- Includes devices location, scoped to the "All company" group, excluding the user "Alex Wilber" +- Includes Microsoft Copilot location, scoped only to the user "Adele Vance" + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name for the feature configuration. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureScenario +The FeatureScenario parameter specifies the scenario for the feature configuration. Currently, the only valid values are: +- `KnowYourData` for collection policies +- `TrustContainer` for Endpoint DLP trust container + +```yaml +Type: PolicyScenario +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies feature configuration mode. Valid values are: + +- Enable: The feature configuration is enabled. +- Disable: The feature configuration is disabled. + +```yaml +Type: PolicyMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScenarioConfig +The ScenarioConfig parameter specifies additional information about the feature configuration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +The locations parameter specifies where the feature configuration applies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FederationTrust.md b/exchange/exchange-ps/exchange/New-FederationTrust.md index 940ae7c37a..b1f50c5c62 100644 --- a/exchange/exchange-ps/exchange/New-FederationTrust.md +++ b/exchange/exchange-ps/exchange/New-FederationTrust.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-federationtrust +online version: https://learn.microsoft.com/powershell/module/exchange/new-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-FederationTrust schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-FederationTrust cmdlet to set up a federation trust between your Exchange organization and the Microsoft Federation Gateway. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,9 +48,9 @@ New-FederationTrust [-Name] -Thumbprint ## DESCRIPTION Federation trusts are trusts created between an Exchange organization and the Microsoft Federation Gateway. A federation trust is required to configure a federated organization identifier for federated sharing. -For more information, see [Federation](https://docs.microsoft.com/exchange/federation-exchange-2013-help). +For more information, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -98,7 +98,7 @@ Accept wildcard characters: False ``` ### -SkipNamespaceProviderProvisioning -The SkipNamespaceProviderProvisioning switch specifies that the trust and federated organization identifier are provisioned externally without using federation functionality in Microsoft Exchange. +The SkipNamespaceProviderProvisioning switch specifies that the trust and federated organization identifier are provisioned externally without using federation functionality in Microsoft Exchange. You don't need to specify a value with this switch. If you use this switch, you must specify the ApplicationIdentifier, ApplicationUri and AdministratorProvisioningId parameters. @@ -116,7 +116,7 @@ Accept wildcard characters: False ``` ### -Thumbprint -The Thumbprint parameter specifies the thumbprint of a certificate issued by a public certification authority (CA) trusted by the Microsoft Federation Gateway. For more details, see [Federation](https://docs.microsoft.com/exchange/federation-exchange-2013-help). +The Thumbprint parameter specifies the thumbprint of a certificate issued by a public certification authority (CA) trusted by the Microsoft Federation Gateway. For more details, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). ```yaml Type: String @@ -221,7 +221,9 @@ Accept wildcard characters: False ### -SuppressDnsWarning This parameter is available only in Exchange Server 2010. -The SuppressDNSWarning parameter specifies whether to display the DNS warning message for creating TXT records in your public DNS when running the New-FederationTrust cmdlet. Valid values are $true or $false. The default value is $false. However, this parameter is automatically set to $true when used by the Hybrid Configuration wizard. It's not recommended that you use this parameter when using the New-FederationTrust cmdlet. +The SuppressDNSWarning switch specifies whether to display the DNS warning message for creating TXT records in your public DNS when running the New-FederationTrust cmdlet. You don't need to specify a value with this switch. + +This switch is used automatically by the Hybrid Configuration wizard. We don't recommend manually using this switch. ```yaml Type: SwitchParameter @@ -237,7 +239,9 @@ Accept wildcard characters: False ``` ### -UseLegacyProvisioningService -The UseLegacyProvisioningService parameter specifies if the legacy interface on the Microsoft Federation Gateway will be used for managing the federation trust, including federated domains, certificates, and federation metadata. Valid input for this parameter is $true or $false. The default value is $false. When using a self-signed certificate for configuring a federation trust with the Microsoft Federation Gateway, the trust needs to be created with the parameter set to $true. After the federation trust is created, this behavior can't be changed and requires the deletion and re-creation of the federation trust. We recommend you always use the default value of $false. +The UseLegacyProvisioningService switch specifies that the legacy interface on the Microsoft Federation Gateway is used for managing the federation trust, including federated domains, certificates, and federation metadata. You don't need to specify a value with this switch. + +When using a self-signed certificate for configuring a federation trust with the Microsoft Federation Gateway, the trust needs to be created using this switch. After the federation trust is created, this behavior can't be changed and requires the deletion and re-creation of the federation trust. ```yaml Type: SwitchParameter @@ -273,12 +277,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md index 00990de7a6..4d11d7b876 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyAuthority.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertyauthority -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertyauthority +applicable: Security & Compliance title: New-FilePlanPropertyAuthority schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # New-FilePlanPropertyAuthority ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-FilePlanPropertyAuthority cmdlet to create file plan property authorities. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ New-FilePlanPropertyAuthority [-Name] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -45,7 +45,7 @@ The Name parameter specifies a unique name for the file plan property authority. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -64,7 +64,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +74,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -94,12 +94,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md index ff1677bcbb..acdefd1244 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertycategor -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertycategor +applicable: Security & Compliance title: New-FilePlanPropertyCategory schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # New-FilePlanPropertyCategory ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-FilePlanPropertyCategory cmdlet to create file plan property categories. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ New-FilePlanPropertyCategory [-Name] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -45,7 +45,7 @@ The Name parameter specifies a unique name for the file plan property category. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -64,7 +64,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +74,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -94,12 +94,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md index f2f4af3e4c..80625e0af9 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyCitation.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertycitation -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertycitation +applicable: Security & Compliance title: New-FilePlanPropertyCitation schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # New-FilePlanPropertyCitation ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-FilePlanPropertyCitation cmdlet to create file plan property citations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ New-FilePlanPropertyCitation [-Name] [[-CitationUrl] ] [[-Citat ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -45,7 +45,7 @@ The Name parameter specifies a unique name for the file plan property citation. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -61,7 +61,7 @@ The CitationJurisdiction parameter specifies the jurisdiction for the file plan Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 1 @@ -77,7 +77,7 @@ The CitationJurisdiction parameter specifies the URL for the file plan property Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 2 @@ -96,7 +96,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -106,13 +106,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -126,12 +126,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md index e6d8b08af7..8d084f8c09 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyDepartment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertydepartment -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertydepartment +applicable: Security & Compliance title: New-FilePlanPropertyDepartment schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # New-FilePlanPropertyDepartment ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-FilePlanPropertyDepartment cmdlet to create file plan property departments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ New-FilePlanPropertyDepartment [-Name] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -45,7 +45,7 @@ The Name parameter specifies a unique name for the file plan property department Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -64,7 +64,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +74,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -94,12 +94,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md index 6636059a5c..f32d9f3ac4 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertyReferenceId.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertyreferenceid -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertyreferenceid +applicable: Security & Compliance title: New-FilePlanPropertyReferenceId schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # New-FilePlanPropertyReferenceId ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-FilePlanPropertyReferenceId cmdlet to create file plan property reference IDs. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ New-FilePlanPropertyReferenceId [-Name] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -45,7 +45,7 @@ The Name parameter specifies a unique name for the file plan property reference Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -64,7 +64,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -74,13 +74,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -94,12 +94,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md index 56aa0eb15d..ceff1b7f3e 100644 --- a/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/New-FilePlanPropertySubCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-fileplanpropertysubcategory -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-fileplanpropertysubcategory +applicable: Security & Compliance title: New-FilePlanPropertySubCategory schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # New-FilePlanPropertySubCategory ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-FilePlanPropertySubCategory cmdlet to create file plan property subcategories. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ New-FilePlanPropertySubCategory [-Name] -ParentId ] -Description ## DESCRIPTION Classification rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -$Patent_Template = Get-Content "C:\My Documents\Contoso Patent Template.docx" -Encoding byte +$Patent_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Patent Template.docx') + $Patent_Fingerprint = New-Fingerprint -FileData $Patent_Template -Description "Contoso Patent Template" ``` @@ -49,7 +50,7 @@ This example creates a new document fingerprint based on the file C:\\My Documen ### -FileData The FileData parameter specifies the file to use as a document fingerprint. -You need to read the file to a byte-encoded object using the Get-Content cmdlet. For details, see the section. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -120,12 +121,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ForeignConnector.md b/exchange/exchange-ps/exchange/New-ForeignConnector.md index 4fe7fbc9e7..07676050af 100644 --- a/exchange/exchange-ps/exchange/New-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/New-ForeignConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-foreignconnector +online version: https://learn.microsoft.com/powershell/module/exchange/new-foreignconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-ForeignConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-ForeignConnector cmdlet to create a new Foreign connector in the Transport service of a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ New-ForeignConnector [-Name] -AddressSpaces ## DESCRIPTION A Foreign connector uses a Drop directory in the Transport service of a Mailbox server to send messages to a local messaging server that doesn't use SMTP as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Third-party fax gateway servers are examples of foreign gateway servers. The address spaces assigned to a Foreign connector can be SMTP or non-SMTP. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,6 +52,22 @@ This example creates a Foreign connector with the following properties: ## PARAMETERS +### -Name +The Name parameter specifies the name for the Foreign connector. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AddressSpaces The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. @@ -81,22 +97,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the name for the Foreign connector. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: True -Position: 1 -Default value: None -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. @@ -189,12 +189,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-GlobalAddressList.md b/exchange/exchange-ps/exchange/New-GlobalAddressList.md index 79586c960c..990ae4ba24 100644 --- a/exchange/exchange-ps/exchange/New-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/New-GlobalAddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-globaladdresslist +online version: https://learn.microsoft.com/powershell/module/exchange/new-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-GlobalAddressList schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-GlobalAddressList cmdlet to create a global address list (GAL). -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -67,9 +67,9 @@ The Conditional parameters that are used with the IncludedRecipients parameter a - The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPath filter. +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create an OPATH filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,7 +82,7 @@ This example creates the GAL named NewGAL. ### Example 2 ```powershell -New-GlobalAddressList -Name GAL_AgencyB -RecipientFilter "(RecipientType -eq 'UserMailbox') -and (CustomAttribute15 -eq 'AgencyB')" +New-GlobalAddressList -Name GAL_AgencyB -RecipientFilter "(RecipientTypeDetails -eq 'UserMailbox') -and (CustomAttribute15 -eq 'AgencyB')" ``` This example creates the GAL named GAL\_AgencyB by using the RecipientFilter parameter to include all mailbox users whose custom attribute 15 equals AgencyB. @@ -117,7 +117,7 @@ The IncludedRecipients parameter specifies a precanned filter that's based on th You can specify multiple values separated by commas. When you use multiple values, the OR Boolean operator is applied. -You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You need to use this parameter when you use any Conditional parameters as part of a precanned filter. You can't use this parameter in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: WellKnownRecipientType @@ -133,16 +133,16 @@ Accept wildcard characters: False ``` ### -RecipientFilter -The RecipientFilter parameter specifies a custom OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter in combination with the IncludedRecipients parameter or any Conditional parameters (which are used to create precanned filters). @@ -164,7 +164,7 @@ The ConditionalCompany parameter specifies a precanned filter that's based on th When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -184,7 +184,7 @@ The ConditionalCustomAttribute1 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -204,7 +204,7 @@ The ConditionalCustomAttribute10 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -224,7 +224,7 @@ The ConditionalCustomAttribute11 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -244,7 +244,7 @@ The ConditionalCustomAttribute12 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -264,7 +264,7 @@ The ConditionalCustomAttribute13 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -284,7 +284,7 @@ The ConditionalCustomAttribute14 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -304,7 +304,7 @@ The ConditionalCustomAttribute15 parameter specifies a precanned filter that's b When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -324,7 +324,7 @@ The ConditionalCustomAttribute2 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -344,7 +344,7 @@ The ConditionalCustomAttribute3 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -364,7 +364,7 @@ The ConditionalCustomAttribute4 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -384,7 +384,7 @@ The ConditionalCustomAttribute5 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -404,7 +404,7 @@ The ConditionalCustomAttribute6 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -424,7 +424,7 @@ The ConditionalCustomAttribute7 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -444,7 +444,7 @@ The ConditionalCustomAttribute8 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -464,7 +464,7 @@ The ConditionalCustomAttribute9 parameter specifies a precanned filter that's ba When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -484,7 +484,7 @@ The ConditionalDepartment parameter specifies a precanned filter that's based on When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -504,7 +504,7 @@ The ConditionalStateOrProvince parameter specifies a precanned filter that's bas When you use multiple values for this parameter, the OR Boolean operator is applied. For more information about how Conditional parameters work, see the Detailed Description section of this topic. -You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPath filters). +You use this parameter in combination with the IncludedRecipients parameter as part of a precanned filter. You can't use any Conditional parameters in combination with the RecipientFilter parameter (which is used to create custom OPATH filters). ```yaml Type: MultiValuedProperty @@ -602,12 +602,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md index 560a0d894d..68a8cdeb6a 100644 --- a/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-HoldCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-holdcompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-holdcompliancepolicy +applicable: Security & Compliance title: New-HoldCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # New-HoldCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-HoldCompliancePolicy cmdlet to create new preservation policies in the Microsoft 365 compliance center. +Use the New-HoldCompliancePolicy cmdlet to create new preservation policies in the Microsoft Purview compliance portal. **Note**: The New-HoldCompliancePolicy cmdlet has been replaced by the New-RetentionCompliancePolicy cmdlet. If you have scripts that use New-HoldCompliancePolicy, update them to use New-RetentionCompliancePolicy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ New-HoldCompliancePolicy [-Name] ## DESCRIPTION New policies are not valid and will not be applied until a preservation rule is added to the policy. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -47,7 +47,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as New-HoldCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" ``` -This example creates a preservation policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site. +This example creates a preservation policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint site. ## PARAMETERS @@ -58,7 +58,7 @@ The Name parameter specifies the unique name of the preservation policy. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -74,7 +74,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -93,7 +93,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -112,7 +112,7 @@ The Enabled parameter specifies whether the policy is enabled or disabled. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -142,7 +142,7 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -152,13 +152,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -174,7 +176,7 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -184,17 +186,17 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. +SharePoint sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -204,13 +206,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -224,12 +226,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md index dc9fa5705a..9ebebdb7c5 100644 --- a/exchange/exchange-ps/exchange/New-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-HoldComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-holdcompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-holdcompliancerule +applicable: Security & Compliance title: New-HoldComplianceRule schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # New-HoldComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-HoldComplianceRule cmdlet to create new preservation rules in the Microsoft 365 compliance center. +Use the New-HoldComplianceRule cmdlet to create new preservation rules in the Microsoft Purview compliance portal. **Note**: The New-HoldComplianceRule cmdlet has been replaced by the New-RetentionComplianceRule cmdlet. If you have scripts that use New-HoldComplianceRule, update them to use New-RetentionComplianceRule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ New-HoldComplianceRule [-Name] -Policy ## DESCRIPTION The preservation rule must be added to an existing preservation policy using the Policy parameter. Only one rule can be added to each preservation policy. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -59,7 +59,7 @@ The Name parameter specifies a unique name for the preservation rule. If the val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -75,7 +75,7 @@ The Policy parameter specifies the policy to contain the rule. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -91,7 +91,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -110,7 +110,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -122,13 +122,13 @@ Accept wildcard characters: False ### -ContentDateFrom The ContentDateFrom parameter specifies the start date of the date range for content to include. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -140,13 +140,13 @@ Accept wildcard characters: False ### -ContentDateTo The ContentDateTo parameter specifies the end date of the date range for content to include. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -158,13 +158,13 @@ Accept wildcard characters: False ### -ContentMatchQuery The ContentMatchQuery parameter specifies a content search filter. -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -180,7 +180,7 @@ The Disabled parameter specifies whether the preservation rule is enabled or dis Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -199,7 +199,7 @@ The HoldContent parameter specifies the hold duration for the preservation rule. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -209,19 +209,19 @@ Accept wildcard characters: False ``` ### -HoldDurationDisplayHint -The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Microsoft 365 compliance center. Valid values are: +The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Microsoft Purview compliance portal. Valid values are: - Days - Months - Years -For example, if this parameter is set to the value Years, and the HoldContent parameter is set to the value 365, the Microsoft 365 compliance center will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the HoldContent parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. ```yaml Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -231,13 +231,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -251,12 +251,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md index 565e65b5e8..ef6356928d 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-hostedcontentfilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection title: New-HostedContentFilterPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-HostedContentFilterPolicy cmdlet to create spam filter policies (content filter policies) in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,6 +28,7 @@ New-HostedContentFilterPolicy [-Name] [-AllowedSenders ] [-BlockedSenderDomains ] [-BlockedSenders ] + [-BulkQuarantineTag ] [-BulkSpamAction ] [-BulkThreshold ] [-Confirm] @@ -44,12 +43,15 @@ New-HostedContentFilterPolicy [-Name] [-EndUserSpamNotificationLanguage ] [-EndUserSpamNotificationLimit ] [-HighConfidencePhishAction ] + [-HighConfidencePhishQuarantineTag ] [-HighConfidenceSpamAction ] + [-HighConfidenceSpamQuarantineTag ] [-IncreaseScoreWithBizOrInfoUrls ] [-IncreaseScoreWithImageLinks ] [-IncreaseScoreWithNumericIps ] [-IncreaseScoreWithRedirectToOtherPort ] [-InlineSafetyTipsEnabled ] + [-IntraOrgFilterState ] [-LanguageBlockList ] [-MarkAsSpamBulkMail ] [-MarkAsSpamEmbedTagsInHtml ] @@ -64,13 +66,15 @@ New-HostedContentFilterPolicy [-Name] [-MarkAsSpamSpfRecordHardFail ] [-MarkAsSpamWebBugsInHtml ] [-ModifySubjectValue ] + [-PhishQuarantineTag ] [-PhishSpamAction ] - [-PhishZapEnabled + [-PhishZapEnabled ] [-QuarantineRetentionPeriod ] [-RecommendedPolicyType ] [-RedirectToRecipients ] [-RegionBlockList ] [-SpamAction ] + [-SpamQuarantineTag ] [-SpamZapEnabled ] [-TestModeAction ] [-TestModeBccToRecipients ] @@ -79,9 +83,9 @@ New-HostedContentFilterPolicy [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -For more information about the limits for allowed and blocked senders, see [Exchange Online Protection Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). +For more information about the limits for allowed and blocked senders, see [Exchange Online Protection Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). ## EXAMPLES @@ -163,7 +167,7 @@ Accept wildcard characters: False ### -AllowedSenderDomains The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. -**Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). +**Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -185,7 +189,7 @@ Accept wildcard characters: False ### -AllowedSenders The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. -**Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). +**Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -205,9 +209,9 @@ Accept wildcard characters: False ``` ### -BlockedSenderDomains -The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with `SFV:SKB` value in the `X-Forefront-Antispam-Report` header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP domains. +The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with `SFV:SKB` value in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP domains. -**Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). +**Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -227,9 +231,9 @@ Accept wildcard characters: False ``` ### -BlockedSenders -The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with `SFV:SKB` in the `X-Forefront-Antispam-Report` header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP email addresses. +The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with `SFV:SKB` in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP email addresses. -**Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). +**Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -248,15 +252,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BulkQuarantineTag +The BulkQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as bulk email (the BulkSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as bulk as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BulkSpamAction The BulkSpamAction parameter specifies the action to take on messages that are marked as bulk email (also known as gray mail) based on the bulk complaint level (BCL) of the message, and the BCL threshold you configure in the BulkThreshold parameter. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). +- MoveToJmf: This is the default value. Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). - NoAction -- Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as bulk email are available to the intended recipients and admins. Or, you can use the BulkQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. ```yaml @@ -273,9 +303,9 @@ Accept wildcard characters: False ``` ### -BulkThreshold -The BulkThreshold parameter specifies the BCL on messages that triggers the action specified by the BulkSpamAction parameter (greater than the specified BCL value, not greater than or equal to). A valid value is an integer from 1 to 9. The default value is 7, which means a BCL of 8 or 9 on messages will trigger the action that's specified by the BulkSpamAction parameter. +The BulkThreshold parameter specifies the BCL on messages that triggers the action specified by the BulkSpamAction parameter (greater than or equal to the specified BCL value). A valid value is an integer from 1 to 9. The default value is 7, which means a BCL of 7, 8, or 9 on messages will trigger the action that's specified by the BulkSpamAction parameter. -A higher BCL indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see [Bulk complaint level (BCL) in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/bulk-complaint-level-values). +A higher BCL indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see [Bulk complaint level (BCL) in EOP](https://learn.microsoft.com/defender-office-365/anti-spam-bulk-complaint-level-bcl-about). ```yaml Type: Int32 @@ -310,12 +340,7 @@ Accept wildcard characters: False ``` ### -DownloadLink -The DownloadLink parameter shows or hides a link in end-user spam quarantine notifications to download the Junk Email Reporting Tool for Outlook. Valid values are: - -- $true: end-user spam quarantine notifications contain a link to download the Junk Email Reporting Tool for Outlook. -- $false: end-user spam quarantine notifications don't contain the link. This is the default value. - -This parameter is only meaningful only when the EnableEndUserSpamNotifications parameter value is $true. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean @@ -331,10 +356,7 @@ Accept wildcard characters: False ``` ### -EnableEndUserSpamNotifications -The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notifications. Valid values are: - -- $true: End-users periodically receive notifications when a messages that was supposed to be delivered to them was quarantined as spam. When you use this value, you can also use the EndUserSpamNotificationCustomSubject, EndUserSpamNotificationFrequency, and EndUserSpamNotificationLanguage parameters. -- $false: end-user spam quarantine notifications are disabled. This is the default value. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean @@ -388,7 +410,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress -This parameter has been deprecated and is no longer used. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: SmtpAddress @@ -404,7 +426,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromName -This parameter has been deprecated and is no longer used. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String @@ -420,9 +442,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomSubject -The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - -This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String @@ -438,9 +458,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency -The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam quarantine notifications are sent. A valid value is an integer between 1 and 15. The default value is 3. - -This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 @@ -456,13 +474,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage -The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam quarantine notifications. Valid values are: - -Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. - -The default value is Default, which means English. - -This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: EsnLanguage @@ -478,7 +490,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLimit -This parameter is reserved for internal Microsoft use. +This parameter is reserved for internal Microsoft use. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 @@ -496,9 +508,8 @@ Accept wildcard characters: False ### -HighConfidencePhishAction The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. -- Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is only available to admins. +- Quarantine: Move the message to quarantine. By default, messages that are quarantined as high confidence phishing are available only to admins. Or, you can use the HighConfidencePhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. ```yaml Type: PhishFilteringAction @@ -513,14 +524,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HighConfidencePhishQuarantineTag +The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence phishing (the HighConfidencePhishAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named AdminOnlyAccessPolicy is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence phishing as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HighConfidenceSpamAction The HighConfidenceSpamAction parameter specifies the action to take on messages that are marked as high confidence spam (not spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). -- Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is available to the intended recipients and admins. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as high confidence spam are available to the intended recipients and admins. Or, you can use the HighConfidenceSpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. ```yaml @@ -536,13 +573,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncreaseScoreWithBizOrInfoUrls -**Note**: This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. +### -HighConfidenceSpamQuarantineTag +The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence spam (the HighConfidenceSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence spam as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncreaseScoreWithBizOrInfoUrls The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to .biz or .info domains are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -559,12 +620,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithImageLinks -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain image links to remote websites are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. +- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Not all messages that match this setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -581,12 +640,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithNumericIps -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to IP addresses are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. +- On: The setting is enabled. Messages that contain links to IP addresses are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Numeric IP in URL` is added to the message. Note that not all messages which matches the setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -603,12 +660,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithRedirectToOtherPort -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. +- On: The setting is enabled. Messages that contain links that redirect to other TCP ports are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL redirect to other port` is added to the message. Note that not all messages which matches the setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -643,18 +698,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LanguageBlockList -The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported ISO 639-1 two-letter language code: +### -IntraOrgFilterState +The IntraOrgFilterState parameter specifies whether to enable anti-spam filtering for messages sent between internal users (users in the same organization). The action that's configured in the policy for the specified spam filter verdicts is taken on messages sent between internal users. Valid values are: -af, ar, az, be, bg, bn, br, bs, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, fy, ga, gl, gu, ha, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kl, kn, ko, ku, ky, la, lb, lt, lv, mi, mk, ml, mn, mr, ms, mt, nb, nl, nn, pa, pl, ps, pt, rm, ro, ru, se, sk, sl, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, uz, vi, wen, yi, zh-cn, zh-tw, and zu. +- Default: This is the default value. Currently, this value is the same as HighConfidencePhish. +- HighConfidencePhish +- Phish: Includes phishing and high confidence phishing. +- HighConfidenceSpam: Includes high confidence spam, phishing, and high confidence phishing. +- Spam: Includes spam, high confidence spam, phishing, and high confidence phishing. +- Disabled -A reference for two-letter language codes is available at [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter. +```yaml +Type: IntraOrgFilterState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +### -LanguageBlockList +The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported uppercase ISO 639-1 two-letter language code: -To empty the list, use the value $null. +AF, AR, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, EL, EN, EO, ES, ET, EU, FA, FI, FO, FR, FY, GA, GL, GU, HA, HE, HI, HR, HU, HY, ID, IS, IT, JA, KA, KK, KL, KN, KO, KU, KY, LA, LB, LT, LV, MI, MK, ML, MN, MR, MS, MT, NB, NL, NN, PA, PL, PS, PT, RM, RO, RU, SE, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TL, TR, UK, UR, UZ, VI, WEN, YI, ZH-CN, ZH-TW, and ZU. + +A reference for two-letter language codes is available at [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php). Not all possible language codes are available as input for this parameter. + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -690,8 +764,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmbedTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -712,8 +784,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmptyMessages -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -734,8 +804,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFormTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -756,8 +824,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFramesInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML \ or \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -778,8 +844,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFromAddressAuthFail -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -799,8 +863,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamJavaScriptInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -821,8 +883,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamNdrBackscatter -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as *backscatter*). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -842,8 +902,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamObjectTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -864,8 +922,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSensitiveWordList -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -886,8 +942,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSpfRecordHardFail -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -907,8 +961,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamWebBugsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -951,14 +1003,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PhishQuarantineTag +The PhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as phishing (the PhishSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as phishing as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PhishSpamAction The PhishSpamAction parameter specifies the action to take on messages that are marked as phishing (not high confidence phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. - Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is available to the intended recipients (as of April, 2020) and admins. +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as phishing are available to admins and (as of April 2020) the intended recipients. Or, you can use the PhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. ```yaml @@ -1022,13 +1101,12 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType -The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this parameter yourself. +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Accepted values: Custom, Standard, Strict Applicable: Exchange Online, Exchange Online Protection Required: False @@ -1093,8 +1171,8 @@ The SpamAction parameter specifies the action to take on messages that are marke - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete : Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the k Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). -- Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. +- MoveToJmf: This is the default value. Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as spam are available to the intended recipients and admins. Or, you can use the SpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. ```yaml @@ -1110,6 +1188,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SpamQuarantineTag +The SpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as spam (the SpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization) is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as spam as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SpamZapEnabled The SpamZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect spam in already delivered messages in Exchange Online mailboxes. Valid values are: @@ -1132,8 +1236,6 @@ Accept wildcard characters: False ``` ### -TestModeAction -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\* or MarkAsSpam\* ASF parameters are set to the value Test. Valid values are: - None: This is the default value, and we recommend that you don't change it. @@ -1154,7 +1256,6 @@ Accept wildcard characters: False ``` ### -TestModeBccToRecipients -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. @@ -1196,12 +1297,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md index c80384a8d0..427202c583 100644 --- a/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/New-HostedContentFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-hostedcontentfilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection title: New-HostedContentFilterRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-HostedContentFilterRule cmdlet to create spam filter rules (content filter rules) in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +37,10 @@ New-HostedContentFilterRule [-Name] -HostedContentFilterPolicy [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Use the Microsoft Defender portal to create anti-spam policies](https://learn.microsoft.com/defender-office-365/anti-spam-policies-configure#use-the-microsoft-defender-portal-to-create-anti-spam-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,43 +53,43 @@ This example creates a new spam filter rule named Contoso Recipients with the fo ## PARAMETERS -### -HostedContentFilterPolicy -The HostedContentFilterPolicy parameter specifies the spam filter policy (content filter policy) that's associated with the rule. - -You can use any value that uniquely identifies the policy. For example: - -- Name -- Distinguished name (DN) -- GUID +### -Name +The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). -You can't specify the default spam filter policy, and you can't specify a spam filter policy that's already associated with another spam filter rule. +Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. ```yaml -Type: HostedContentFilterPolicyIdParameter +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the spam filter rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +### -HostedContentFilterPolicy +The HostedContentFilterPolicy parameter specifies the spam filter policy (content filter policy) that's associated with the rule. -Don't use the following characters in the name value: `\ % & * + / = ? { } | < > ( ) ; : [ ] , "`. +You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can't specify the default spam filter policy, and you can't specify a spam filter policy that's already associated with another spam filter rule. ```yaml -Type: String +Type: HostedContentFilterPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -146,7 +147,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -187,7 +188,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -238,7 +239,7 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -279,7 +280,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition for the rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -326,12 +327,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md index 41a7ebf683..6f78d93176 100644 --- a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection title: New-HostedOutboundSpamFilterPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-HostedOutboundSpamFilterPolicy cmdlet to create outbound spam filter policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +39,7 @@ New-HostedOutboundSpamFilterPolicy [-Name] ## DESCRIPTION New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the HostedOutboundSpamFilterPolicy parameter on the New-HostedOutboundSpamFilterRule or Set-HostedOutboundSpamFilterRule cmdlets to associate the policy with a rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -111,15 +109,13 @@ Accept wildcard characters: False ``` ### -AutoForwardingMode -**Note**: Before September 2020, this setting is available but not enforced. - -The AutoForwardingMode specifies how the policy controls automatic email forwarding to outbound recipients. Valid values are: +The AutoForwardingMode specifies how the policy controls automatic email forwarding to external recipients. Valid values are: -- Automatic: Automatic external email forwarding is blocked by the system. This is the default value. -- On: Automatic external email forwarding is not restricted. -- Off: Automatic external email forwarding is disabled and will result in a non-delivery report (also known as an NDR or bounce message) to the sender. +- Automatic: This is the default value. This value is now the same as Off. When this value was originally introduced, it was equivalent to On. Over time, thanks to the principles of [secure by default](https://learn.microsoft.com/defender-office-365/secure-by-default), the effect of this value was eventually changed to Off for all customers. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/all-you-need-to-know-about-automatic-email-forwarding-in/ba-p/2074888). +- On: Automatic external email forwarding isn't disabled by the policy. +- Off: Automatic external email forwarding is disabled by the policy and results in a non-delivery report (also known as an NDR or bounce message) to the sender. -This setting applies only to cloud-based mailboxes, and automatic forwarding to internal recipients is not affected by this setting. +This setting applies to cloud-based mailboxes only. Automatic forwarding to internal recipients isn't affected by this setting. ```yaml Type: AutoForwardingMode @@ -173,7 +169,7 @@ Accept wildcard characters: False ``` ### -NotifyOutboundSpam -**Note**: This setting has been replaced by the default alert policy named **User restricted from sending email**, which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see [Verify the alert settings for restricted users](https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). +**Note**: This setting has been replaced by the default alert policy named **User restricted from sending email**, which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see [Verify the alert settings for restricted users](https://learn.microsoft.com/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). The NotifyOutboundSpam parameter specify whether to notify admins when outgoing spam is detected. Valid values are: @@ -194,7 +190,7 @@ Accept wildcard characters: False ``` ### -NotifyOutboundSpamRecipients -**Note**: This setting has been replaced by the default alert policy named **User restricted from sending email**, which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see [Verify the alert settings for restricted users](https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). +**Note**: This setting has been replaced by the default alert policy named **User restricted from sending email**, which sends notification messages to admins. We recommend that you use the alert policy rather than this setting to notify admins and other users. For instructions, see [Verify the alert settings for restricted users](https://learn.microsoft.com/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). The NotifyOutboundSpamRecipients parameter specifies the email addresses of admins to notify when an outgoing spam is detected. You can specify multiple email addresses separated by commas. @@ -214,7 +210,7 @@ Accept wildcard characters: False ``` ### -RecipientLimitExternalPerHour -The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://docs.microsoft.com/microsoft-365/security/office-365-security/removing-user-from-restricted-users-portal-after-spam#verify-the-alert-settings-for-restricted-users). +The RecipientLimitExternalPerHour parameter specifies the maximum number of external recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/defender-office-365/outbound-spam-restore-restricted-users#verify-the-alert-settings-for-restricted-users). ```yaml Type: UInt32 @@ -230,7 +226,7 @@ Accept wildcard characters: False ``` ### -RecipientLimitInternalPerHour -The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). +The RecipientLimitInternalPerHour parameter specifies the maximum number of internal recipients that a user can send to within an hour. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). ```yaml Type: UInt32 @@ -246,7 +242,7 @@ Accept wildcard characters: False ``` ### -RecipientLimitPerDay -The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). +The RecipientLimitInternalPerHour parameter specifies the maximum number of recipients that a user can send to within a day. A valid value is 0 to 10000. The default value is 0, which means the service defaults are used. For more information, see [Sending limits across Microsoft 365 options](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-across-office-365-options). ```yaml Type: UInt32 @@ -262,13 +258,12 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType -The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this parameter yourself. +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Accepted values: Custom, Standard, Strict Applicable: Exchange Online, Exchange Online Protection Required: False @@ -283,12 +278,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md index 277872db1f..721a9bd38a 100644 --- a/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md +++ b/exchange/exchange-ps/exchange/New-HostedOutboundSpamFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-hostedoutboundspamfilterrule applicable: Exchange Online, Exchange Online Protection title: New-HostedOutboundSpamFilterRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-HostedOutboundSpamFilterRule cmdlet to create outbound spam filter rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +37,7 @@ New-HostedOutboundSpamFilterRule [-Name] -HostedOutboundSpamFilterPolic ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -327,12 +325,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-HybridConfiguration.md b/exchange/exchange-ps/exchange/New-HybridConfiguration.md index 585d4558a5..7d9e42ecac 100644 --- a/exchange/exchange-ps/exchange/New-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/New-HybridConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-hybridconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/new-hybridconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-HybridConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-HybridConfiguration cmdlet to create the HybridConfiguration object and set up a hybrid deployment between your on-premises Exchange organization and a Microsoft 365 for enterprises organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,9 +43,9 @@ New-HybridConfiguration ## DESCRIPTION A hybrid deployment offers organizations the ability to extend the feature-rich experience and administrative control they have with their existing on-premises Microsoft Exchange organization to the cloud. The New-HybridConfiguration cmdlet is used with the Hybrid Configuration wizard and is typically configured when the hybrid deployment is initially created by the wizard. We strongly recommend that you use the Hybrid Configuration wizard to create the HybridConfiguration object and configure your hybrid deployment with the Exchange Online organization. -For more information, see [Exchange Server hybrid deployments](https://docs.microsoft.com/exchange/exchange-hybrid). +For more information, see [Exchange Server hybrid deployments](https://learn.microsoft.com/exchange/exchange-hybrid). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,7 +54,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi New-HybridConfiguration ``` -This example creates the hybrid configuration Hybrid Configuration with the default hybrid configuration settings. +This example creates the hybrid configuration named Hybrid Configuration with the default hybrid configuration settings. ## PARAMETERS @@ -331,12 +331,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-InboundConnector.md b/exchange/exchange-ps/exchange/New-InboundConnector.md index e3cf6d928d..ab3f7a8b2d 100644 --- a/exchange/exchange-ps/exchange/New-InboundConnector.md +++ b/exchange/exchange-ps/exchange/New-InboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-inboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/new-inboundconnector applicable: Exchange Online, Exchange Online Protection title: New-InboundConnector schema: 2.0.0 @@ -16,15 +16,16 @@ This cmdlet is available only in the cloud-based service. Use the New-InboundConnector cmdlet to create a new Inbound connector in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: Creation of inbound connectors is restricted in [Microsoft 365 E5 developer subscriptions](https://learn.microsoft.com/office/developer-program/microsoft-365-developer-program-faq#does-the-microsoft-365-e5-developer-subscription-include-the-same-capabilities-that-the-regular-microsoft-365-e5-subscription-includes-). Opening a support ticket in affected organizations won't help. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` New-InboundConnector [-Name] -SenderDomains [-AssociatedAcceptedDomains ] + [-ClientHostNames ] [-CloudServicesMailEnabled ] [-Comment ] [-Confirm] @@ -43,6 +44,7 @@ New-InboundConnector [-Name] -SenderDomains [-SenderIPAddresses ] [-TlsSenderCertificateName ] [-TreatMessagesAsInternal ] + [-TrustedOrganizations ] [-WhatIf] [] ``` @@ -50,7 +52,7 @@ New-InboundConnector [-Name] -SenderDomains ## DESCRIPTION Inbound connectors accept email messages from remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,7 +92,9 @@ Accept wildcard characters: False ``` ### -SenderDomains -The SenderDomains parameter specifies the remote domains from which this connector accepts messages, thereby limiting its scope. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. You can specify multiple domains separated by commas. +The SenderDomains parameter specifies the source domains that a Partner type connector accepts messages for (limits the scope of a Partner type connector). A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, `*.contoso.com`). However, you can't embed the wildcard character (for example, `domain.*.contoso.com` isn't valid). + +You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty @@ -106,7 +110,25 @@ Accept wildcard characters: False ``` ### -AssociatedAcceptedDomains -The AssociatedAcceptedDomains parameter specifies the accepted domains that the connector applies to, thereby limiting its scope. For example, you can apply the connector to a specific accepted domain in your organization, such as contoso.com. +The AssociatedAcceptedDomains parameter restricts the source domains that use the connector to the specified accepted domains. A valid value is an SMTP domain that's configured as an accepted domain in your Microsoft 365 organization. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientHostNames +{{ Fill ClientHostNames Description }} ```yaml Type: MultiValuedProperty @@ -122,7 +144,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -182,11 +204,11 @@ Accept wildcard characters: False ### -ConnectorSource The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: -- Default: The connector is manually created. +- Default: The connector is manually created. This is the default value. - HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. -The default value for connectors you create yourself is Default. It isn't recommended that you change this value. +We recommended that you don't change this value. ```yaml Type: TenantConnectorSource @@ -202,10 +224,10 @@ Accept wildcard characters: False ``` ### -ConnectorType -The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid input for this parameter includes the following values: +The ConnectorType parameter specifies the category for the source domains that the connector accepts messages for. Valid values are: -- Partner: The connector services domains that are external to your organization. -- OnPremises: The connector services domains that are used by your on-premises organization. Use this value for accepted domains in your cloud-based organization that are also specified by the SenderDomains parameter. +- Partner: External partners or services. +- OnPremises: The connector services domains that are used by your on-premises organization. OnPremises connectors grant special rights to an email that matches the connector and additional requirements. For example: allowing relay through the tenant to internet destinations, promoting emails from on-premises or other environments as internal (in a hybrid configuration), or enabling other more complex mail flows. ```yaml Type: TenantConnectorType @@ -312,7 +334,10 @@ Accept wildcard characters: False ``` ### -Enabled -The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true. +The Enabled parameter enables or disables the connector. Valid values are: + +- $true: The connector is enabled. This is the default value. +- $false: The connector is disabled. ```yaml Type: Boolean @@ -328,7 +353,12 @@ Accept wildcard characters: False ``` ### -RequireTls -The RequireTLS parameter specifies that all messages received by this connector require TLS transmission. Valid values for this parameter are $true or $false. The default value is $false. +The RequireTLS parameter specifies whether to require TLS transmission for all messages that are received by a Partner type connector. Valid values are: + +- $true: Reject messages if they aren't sent over TLS. This is the default value +- $false: Allow messages if they aren't sent over TLS. + +**Note**: This parameter applies only to Partner type connectors. ```yaml Type: Boolean @@ -344,7 +374,12 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToCertificate -The RestrictDomainsToCertificate parameter specifies that Microsoft 365 should identify incoming messages that are eligible for this connector by verifying that the remote server authenticates using a TLS certificate that has the TlsSenderCertificateName in the Subject. Valid values are $true or $false. +The RestrictDomainsToCertificate parameter specifies whether the Subject value of the TLS certificate is checked before messages can use the Partner type connector. Valid values are: + +- $true: Mail is allowed to use the connector only if the Subject value of the TLS certificate that the source email server uses to authenticate matches the TlsSenderCertificateName parameter value. +- $false: The Subject value of the TLS certificate that the source email server uses to authenticate doesn't control whether mail from that source uses the connector. This is the default value. + +**Note**: This parameter applies only to Partner type connectors. ```yaml Type: Boolean @@ -360,9 +395,12 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToIPAddresses -The RestrictDomainsToIPAddresses parameter, when set to $true, automatically rejects mail from the domains specified by the SenderDomains parameter if the mail originates from an IP address that isn't specified by the SenderIPAddresses parameter. +The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that comes from unknown source IP addresses for Partner type connectors. Valid values are: + +- $true: Automatically reject mail from domains that are specified by the SenderDomains parameter if the source IP address isn't also specified by the SenderIPAddress parameter. +- $false: Don't automatically reject mail from domains that are specified by the SenderDomains parameter based on the source IP address. This is the default value. -Valid input for this parameter is $true or $false. The default value is $false. +**Note**: This parameter applies only to Partner type connectors. ```yaml Type: Boolean @@ -394,7 +432,7 @@ Accept wildcard characters: False ``` ### -SenderIPAddresses -The SenderIPAddresses parameter specifies the remote IPV4 IP addresses from which this connector accepts messages. Valid values are: +The SenderIPAddresses parameter specifies the source IPV4 IP addresses that the Partner type connector accepts messages from when the value of the RestrictDomainsToIPAddresses parameter is $true. Valid values are: - Single IP address: For example, 192.168.1.1. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. Valid subnet mask values are /24 through /32. @@ -403,6 +441,8 @@ You can specify multiple IP addresses separated by commas. IPv6 addresses are not supported. +**Note**: This parameter applies to Partner type connectors only if the value of the RestrictDomainsToIPAddresses parameter is $true. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -417,9 +457,7 @@ Accept wildcard characters: False ``` ### -TlsSenderCertificateName -The TlsSenderCertificateName parameter specifies the certificate used by the sender's domain when the RequireTls parameter is set to $true. Valid input for the TlsSenderCertificateName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. - -You can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. +The TlsSenderCertificateName parameter specifies the TLS certificate that's used when the value of the RequireTls parameter is $true. A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com is not valid). ```yaml Type: TlsCertificate @@ -460,6 +498,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TrustedOrganizations +The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). You can specify multiple Microsoft 365 organizations separated by commas. + +This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -481,12 +537,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-InboxRule.md b/exchange/exchange-ps/exchange/New-InboxRule.md index 1360967240..a3b0fe0e83 100644 --- a/exchange/exchange-ps/exchange/New-InboxRule.md +++ b/exchange/exchange-ps/exchange/New-InboxRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-inboxrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-InboxRule schema: 2.0.0 @@ -18,7 +18,7 @@ Use the New-InboxRule cmdlet to create Inbox rules in mailboxes. Inbox rules pro You must have adequate permissions on the mailbox to create an Inbox rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,6 @@ New-InboxRule [-Name] [-ExceptIfFlaggedForAction ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] - [-ExceptIfFromSubscription ] [-ExceptIfHasAttachment ] [-ExceptIfHasClassification ] [-ExceptIfHeaderContainsWords ] @@ -64,7 +63,6 @@ New-InboxRule [-Name] [-ForwardTo ] [-From ] [-FromAddressContainsWords ] - [-FromSubscription ] [-HasAttachment ] [-HasClassification ] [-HeaderContainsWords ] @@ -86,6 +84,7 @@ New-InboxRule [-Name] [-SendTextMessageNotificationTo ] [-SentOnlyToMe ] [-SentTo ] + [-SoftDeleteMessage ] [-StopProcessingRules ] [-SubjectContainsWords ] [-SubjectOrBodyContainsWords ] @@ -117,13 +116,13 @@ When you create, modify, remove, enable, or disable an Inbox rule in Exchange Po Parameters that are used for conditions also have corresponding exception parameters. When conditions specified in an exception are matched, the rule isn't applied to the message. Exception parameters begin with ExceptIf. For example, the exception parameter for SubjectOrBodyContainsWords is ExceptIfSubjectOrBodyContainsWords. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-InboxRule "CheckActionRequired" -MyNameInToBox $true -FlaggedForAction Any -MarkImportance "High" +New-InboxRule -Mailbox chris@contoso.com -Name "CheckActionRequired" -MyNameInToBox $true -FlaggedForAction Any -MarkImportance "High" ``` This example raises the message importance to High if the mailbox owner is in the To field. In addition, the message is flagged for action. @@ -131,7 +130,7 @@ This example raises the message importance to High if the mailbox owner is in th ## PARAMETERS ### -Name -The Name parameter specifies the name of the Inbox rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the name of the Inbox rule. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String @@ -188,7 +187,7 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob parameter suppresses a warning that end users or administrators get if they use Outlook Web App or Windows PowerShell to modify Inbox rules. +The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -267,7 +266,9 @@ Accept wildcard characters: False ### -BodyContainsWords The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. @@ -417,7 +418,9 @@ Accept wildcard characters: False ### -ExceptIfBodyContainsWords The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is BodyContainsWords. @@ -465,7 +468,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom -The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: For example: +The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name - Alias @@ -494,7 +497,9 @@ Accept wildcard characters: False ### -ExceptIfFromAddressContainsWords The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. -You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is FromAddressContainsWords. @@ -511,26 +516,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfFromSubscription -This parameter is available only in the cloud-based service. - -The ExceptIfFromSubscription parameter specifies an exception for the Inbox rule that looks for messages received from subscriptions (for example, POP or IMAP subscriptions). You can identify the subscription by using the Get-Subscription cmdlet. - -The corresponding condition parameter to this exception is FromSubscription. - -```yaml -Type: AggregationSubscriptionIdentity[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ExceptIfHasAttachment The ExceptIfHasAttachment parameter specifies an exception for the Inbox rule that looks for messages with attachments. Valid values are: @@ -573,7 +558,9 @@ Accept wildcard characters: False ### -ExceptIfHeaderContainsWords The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is HeaderContainsWords. @@ -707,7 +694,7 @@ Accept wildcard characters: False ### -ExceptIfReceivedAfterDate The ExceptIfReceivedAfterDate parameter specifies an exception for the Inbox rule that looks for messages received after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding condition parameter to this exception is ReceivedAfterDate. @@ -727,7 +714,7 @@ Accept wildcard characters: False ### -ExceptIfReceivedBeforeDate The ExceptIfReceivedBeforeDate parameter specifies an exception for the Inbox rule that looks for messages received before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding condition parameter to this exception is ReceivedBeforeDate. @@ -747,7 +734,7 @@ Accept wildcard characters: False ### -ExceptIfRecipientAddressContainsWords The ExceptIfRecipientAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in recipient email addresses. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is RecipientAddressContainsWords. @@ -815,7 +802,9 @@ Accept wildcard characters: False ### -ExceptIfSubjectContainsWords The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding condition parameter to this exception is SubjectContainsWords. @@ -835,9 +824,11 @@ Accept wildcard characters: False ### -ExceptIfSubjectOrBodyContainsWords The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. -The corresponding condition parameter to this exception is ExceptIfSubjectOrBodyContainsWords. +The corresponding condition parameter to this exception is SubjectOrBodyContainsWords. ```yaml Type: MultiValuedProperty @@ -986,7 +977,7 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -1083,7 +1074,9 @@ Accept wildcard characters: False ### -FromAddressContainsWords The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. -You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. @@ -1100,26 +1093,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FromSubscription -This parameter is available only in the cloud-based service. - -The FromSubscription parameter specifies a condition for the Inbox rule that looks for messages received from subscriptions (for example, POP or IMAP subscriptions). You can identify the subscription by using the Get-Subscription cmdlet. - -The corresponding exception parameter to this condition is ExceptIfFromSubscription. - -```yaml -Type: AggregationSubscriptionIdentity[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -HasAttachment The HasAttachment parameter specifies a condition for the Inbox rule that looks for messages with attachments. Valid values are: @@ -1162,7 +1135,9 @@ Accept wildcard characters: False ### -HeaderContainsWords The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. @@ -1428,7 +1403,7 @@ Accept wildcard characters: False ### -ReceivedAfterDate The ReceivedAfterDate parameter specifies a condition for the Inbox rule that looks for messages received after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding exception parameter to this condition is ExceptIfReceivedAfterDate. @@ -1448,7 +1423,7 @@ Accept wildcard characters: False ### -ReceivedBeforeDate The ReceivedBeforeDate parameter specifies a condition for the Inbox rule that looks for messages received before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding exception parameter to this condition is ExceptIfReceivedBeforeDate. @@ -1468,7 +1443,7 @@ Accept wildcard characters: False ### -RecipientAddressContainsWords The RecipientAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in recipient email addresses. -You can specify multiple values separated by commas. +You can specify multiple values separated by commas. The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. @@ -1511,6 +1486,8 @@ Accept wildcard characters: False ``` ### -SendTextMessageNotificationTo +This parameter is available only in on-premises Exchange. + The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. You can specify multiple values separated by commas. @@ -1519,7 +1496,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1576,6 +1553,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SoftDeleteMessage +This parameter is available only in the cloud-based service. + +{{ Fill SoftDeleteMessage Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StopProcessingRules The StopProcessingRules parameter specifies an action for the Inbox rule that stops processing additional rules if the conditions of this Inbox rule are met. Valid values are:If set to $true, the StopProcessingRules parameter instructs Exchange to stop processing additional rules if the conditions of this Inbox rule are met. @@ -1598,7 +1593,9 @@ Accept wildcard characters: False ### -SubjectContainsWords The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. @@ -1618,7 +1615,9 @@ Accept wildcard characters: False ### -SubjectOrBodyContainsWords The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -If the phrase contains spaces, you need to enclose the value in quotation marks. You can specify multiple values separated by commas. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 255 characters. The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. @@ -1761,12 +1760,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md index fe7acd3036..0e1826be8c 100644 --- a/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/New-InformationBarrierPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy +applicable: Security & Compliance title: New-InformationBarrierPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-InformationBarrierPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-InformationBarrierPolicy cmdlet to create information barrier policies in the Microsoft 365 compliance center. +Use the New-InformationBarrierPolicy cmdlet to create information barrier policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,6 +25,8 @@ For information about the parameter sets in the Syntax section below, see [Excha New-InformationBarrierPolicy [-Name] -AssignedSegment -SegmentAllowedFilter [-Comment ] [-Confirm] + [-Force] + [-ModerationAllowed ] [-State ] [-WhatIf] [] @@ -35,6 +37,8 @@ New-InformationBarrierPolicy [-Name] -AssignedSegment -Segment New-InformationBarrierPolicy [-Name] -AssignedSegment -SegmentsAllowed [-Comment ] [-Confirm] + [-Force] + [-ModerationAllowed ] [-WhatIf] [] ``` @@ -44,6 +48,8 @@ New-InformationBarrierPolicy [-Name] -AssignedSegment -Segment New-InformationBarrierPolicy [-Name] -AssignedSegment -SegmentsBlocked [-Comment ] [-Confirm] + [-Force] + [-ModerationAllowed ] [-WhatIf] [] ``` @@ -51,12 +57,12 @@ New-InformationBarrierPolicy [-Name] -AssignedSegment -Segment ## DESCRIPTION Information barrier policies are not in effect until you set them to active status, and then apply the policies: -- (If needed): [Define a policy to block communications between segments](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#scenario-1-block-communications-between-segments). -- After all of your policies are defined: [Apply information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#part-3-apply-information-barrier-policies). +- (If needed): [Block communications between segments](https://learn.microsoft.com/purview/information-barriers-policies#scenario-1-block-communications-between-segments). +- After all of your policies are defined: [Apply information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies#step-4-apply-ib-policies). -For more information, see [Information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies). +For more information, see [Information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -90,7 +96,7 @@ The Name parameter specifies a unique name for the information barrier policy th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -106,7 +112,7 @@ The AssignedSegment parameter specifies the Name value of segment that you want Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -122,7 +128,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: OrganizationSegmentAllowedFilter Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -142,7 +148,7 @@ You can't use this parameter with the SegmentsBlocked parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsAllowed Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -162,7 +168,7 @@ You can't use this parameter with the SegmentsAllowed parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsBlocked Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -178,7 +184,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -194,7 +200,41 @@ The Confirm switch doesn't work on this cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationAllowed +{{ Fill ModerationAllowed Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -214,7 +254,7 @@ Type: EopInformationBarrierPolicyState Parameter Sets: (All) Aliases: Accepted values: Inactive, Active -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -224,13 +264,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -244,14 +284,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) diff --git a/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md index 7f3279a8ef..4e22683783 100644 --- a/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/exchange/New-IntraOrganizationConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-intraorganizationconnector +online version: https://learn.microsoft.com/powershell/module/exchange/new-intraorganizationconnector applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-IntraOrganizationConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-IntraOrganizationConnector cmdlet to create an Intra-Organization connector between two on-premises Exchange forests in an organization, between an Exchange on-premises organization and an Exchange Online organization, or between two Exchange Online organizations. This connector enables feature availability and service connectivity across the organizations using a common connector and connection endpoints. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ The New-IntraOrganizationConnector cmdlet is used to create a connection for fea For hybrid deployments between on-premises Exchange and Exchange Online organizations, the New-IntraOrganizationConnector cmdlet is used by the Hybrid Configuration wizard. Typically, the Intra-Organization connector is configured when the hybrid deployment is initially created by the wizard. We strongly recommend that you use the Hybrid Configuration wizard to create the Intra-Organization connector when configuring a hybrid deployment with an Exchange Online organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,33 +48,33 @@ This example creates an Intra-Organization connector named "MainCloudConnector" ## PARAMETERS -### -DiscoveryEndpoint -The DiscoveryEndpoint parameter specifies the externally-accessible URL that's used for the Autodiscover service for the domain that's configured in the Intra-Organization connector. +### -Name +The Name parameter specifies a friendly name for the Intra-Organization connector. If the value contains spaces, enclose the value in double quotation marks. ```yaml -Type: Uri +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a friendly name for the Intra-Organization connector. If the value contains spaces, enclose the value in double quotation marks. +### -DiscoveryEndpoint +The DiscoveryEndpoint parameter specifies the externally-accessible URL that's used for the Autodiscover service for the domain that's configured in the Intra-Organization connector. ```yaml -Type: String +Type: Uri Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -192,12 +192,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-JournalRule.md b/exchange/exchange-ps/exchange/New-JournalRule.md index 3e28f55f66..2812bcf0ef 100644 --- a/exchange/exchange-ps/exchange/New-JournalRule.md +++ b/exchange/exchange-ps/exchange/New-JournalRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-journalrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-JournalRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-JournalRule cmdlet to create a journal rule in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,9 +34,9 @@ New-JournalRule -Name -JournalEmailAddress ## DESCRIPTION The New-JournalRule cmdlet creates a journal rule in your organization. -By default, new journal rules are disabled unless the Enabled parameter is set to $true. For more information about how to enable a new journal rule that was created in a disabled state, see [Enable-JournalRule](https://docs.microsoft.com/powershell/module/exchange/enable-journalrule). +By default, new journal rules are disabled unless the Enabled parameter is set to $true. For more information about how to enable a new journal rule that was created in a disabled state, see [Enable-JournalRule](https://learn.microsoft.com/powershell/module/exchange/enable-journalrule). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -144,6 +144,8 @@ Accept wildcard characters: False ### -Recipient The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or from a recipient are journaled. +To journal messages from all recipients, don't use this parameter. + ```yaml Type: SmtpAddress Parameter Sets: (All) @@ -198,12 +200,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-Label.md b/exchange/exchange-ps/exchange/New-Label.md index 873f097a82..ccfa3a9d5e 100644 --- a/exchange/exchange-ps/exchange/New-Label.md +++ b/exchange/exchange-ps/exchange/New-Label.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance/new-label -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/policy-and-compliance/new-label +applicable: Security & Compliance title: New-Label schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-Label ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-Label cmdlet to create sensitivity labels in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,17 +37,20 @@ New-Label [-Name] -DisplayName -Tooltip [-ApplyContentMarkingHeaderFontSize ] [-ApplyContentMarkingHeaderMargin ] [-ApplyContentMarkingHeaderText ] + [-ApplyDynamicWatermarkingEnabled ] [-ApplyWaterMarkingEnabled ] [-ApplyWaterMarkingFontColor ] [-ApplyWaterMarkingFontName ] [-ApplyWaterMarkingFontSize ] [-ApplyWaterMarkingLayout ] - [-ColumnAssetCondition ] [-ApplyWaterMarkingText ] + [-ColumnAssetCondition ] [-Comment ] [-Conditions ] [-Confirm] [-ContentType ] + [-DefaultContentLabel ] + [-DynamicWatermarkDisplay ] [-EncryptionAipTemplateScopes ] [-EncryptionContentExpiredOnDateInDaysOrNever ] [-EncryptionDoNotForward ] @@ -58,7 +61,7 @@ New-Label [-Name] -DisplayName -Tooltip [-EncryptionOfflineAccessDays ] [-EncryptionPromptUser ] [-EncryptionProtectionType ] - [-EncryptionRightsDefinitions ] + [-EncryptionRightsDefinitions ] [-EncryptionRightsUrl ] [-EncryptionTemplateId ] [-Identity ] @@ -66,6 +69,7 @@ New-Label [-Name] -DisplayName -Tooltip [-LocaleSettings ] [-MigrationId ] [-ParentId ] + [-SchematizedDataCondition ] [-Setting ] [-Settings ] [-SiteAndGroupProtectionAllowAccessToGuestUsers ] @@ -74,15 +78,32 @@ New-Label [-Name] -DisplayName -Tooltip [-SiteAndGroupProtectionAllowLimitedAccess ] [-SiteAndGroupProtectionBlockAccess ] [-SiteAndGroupProtectionEnabled ] - [-SiteAndGroupProtectionPrivacy ] + [-SiteAndGroupProtectionLevel ] + [-SiteAndGroupProtectionPrivacy ] [-SiteExternalSharingControlType ] - [-SqlAssetCondition ] + [-TeamsAllowedPresenters ] + [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] + [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] + [-TeamsChannelSharedWithSameLabelOnly ] + [-TeamsCopyRestrictionEnforced ] + [-TeamsEndToEndEncryptionEnabled ] + [-TeamsLobbyBypassScope ] + [-TeamsLobbyRestrictionEnforced ] + [-TeamsPresentersRestrictionEnforced ] + [-TeamsProtectionEnabled ] + [-TeamsRecordAutomatically ] + [-TeamsVideoWatermark ] + [-TeamsWhoCanRecord ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -102,7 +123,7 @@ The Name parameter specifies the unique name for the sensitivity label. The maxi Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -118,7 +139,7 @@ The DisplayName parameter specifies the display name for the sensitivity label. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -134,7 +155,7 @@ The ToolTip parameter specifies the default tooltip and sensitivity label descri Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -144,13 +165,37 @@ Accept wildcard characters: False ``` ### -AdvancedSettings -The AdvancedSettings parameter enables client-specific features and capabilities for a sensitivity label. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see [Custom configurations for the Azure Information Protection unified labeling client](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). +The AdvancedSettings parameter enables specific features and capabilities for a sensitivity label. + +Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. + +Some of the settings that you configure with this parameter are supported only by the Microsoft Purview Information Protection client and not by Office apps and services that support built-in labeling. For a list of these, see [Advanced settings for Microsoft Purview Information Protection client](https://learn.microsoft.com/powershell/exchange/client-advanced-settings). + +Supported settings for built-in labeling: + +- **BlockContentAnalysisServices**: Specifies a privacy setting to allow or prevent content in Word, Excel, PowerPoint, and Outlook from being sent to Microsoft for content analysis. Available values are True, and False (the default). This setting impacts services such as data loss prevention policy tips, automatic and recommended labeling, and Microsoft Copilot for Microsoft 365. Example: `New-Label -Identity Confidential -AdvancedSettings @{BlockContentAnalysisServices="True"}`. For more information, see [Prevent some connected experiences that analyze content](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#prevent-some-connected-experiences-that-analyze-content). + +- **Color**: Specifies a label color as a hex triplet code for the red, green, and blue (RGB) components of the color. Example: `New-Label -DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{color="#40e0d0"}`. For more information, see [Configuring custom colors by using PowerShell](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configuring-custom-colors-by-using-powershell). + +- **DefaultSharingScope**: Specifies the default sharing link type for a site when the label scope includes **Groups & sites**, and the default sharing link type for a document when the label scope includes **Files & emails**. Available values are SpecificPeople, Organization, and Anyone. Example: `New-Label DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{DefaultSharingScope="SpecificPeople"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultShareLinkPermission**: Specifies the permissions for the sharing link for a site when the label scope includes **Groups & sites**, and the permissions for the sharing link for a document when the label scope includes **Files & emails**. Available values are View and Edit. Example: `New-Label DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{DefaultShareLinkPermission="Edit"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultShareLinkToExistingAccess**: Specifies whether to override *DefaultSharingScope* and *DefaultShareLinkPermission* to instead set the default sharing link type to people with existing access with their existing permissions. Example: `New-Label DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{DefaultShareLinkToExistingAccess="True"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultSubLabelId**: Specifies a default sublabel to be applied automatically when a user selects a parent label in Office apps. Example: `New-Label -DisplayName "Confidential" -Name "Confidential" -Tooltip "Confidential data that requires protection, which allows all employees full permissions. Data owners can track and revoke content." -AdvancedSettings @{DefaultSubLabelId="8faca7b8-8d20-48a3-8ea2-0f96310a848e"}`. For more information, see [Specify a default sublabel for a parent label](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#specify-a-default-sublabel-for-a-parent-label). + +- **MembersCanShare**: For a container label, specifies how members can share for a SharePoint site. Available values are MemberShareAll, MemberShareFileAndFolder, and MemberShareNone. Example: `New-Label -DisplayName "General" -Name "General" -Tooltip "Business data that is not intended for public consumption." -AdvancedSettings @{MembersCanShare="MemberShareFileAndFolder"}`. For more information, see [Configure site sharing permissions by using PowerShell advanced settings](https://learn.microsoft.com/purview/sensitivity-labels-teams-groups-sites#configure-site-sharing-permissions-by-using-powershell-advanced-settings). + +- **SMimeEncrypt**: Specifies S/MIME encryption for Outlook. Available values are True, and False (the default). Example: `New-Label DisplayName "Confidential" -Name "Confidential" -Tooltip "Sensitive business data that could cause damage to the business if shared with unauthorized people." -AdvancedSettings @{SMimeEncrypt="True"}`. For more information, see [Configure a label to apply S/MIME protection in Outlook](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). + +- **SMimeSign**: Specifies S/MIME digital signature for Outlook. Available values are True, and False (the default). Example: `New-Label DisplayName "Confidential" -Name "Confidential" -Tooltip "Sensitive business data that could cause damage to the business if shared with unauthorized people." -AdvancedSettings @{SMimeSign="True"}`. For more information, see [Configure a label to apply S/MIME protection in Outlook](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -172,7 +217,7 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -191,7 +236,7 @@ The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -209,7 +254,7 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -223,11 +268,13 @@ The ApplyContentMarkingFooterFontName parameter specifies the font of the footer This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. +This parameter is supported only by the Azure Information Protection unified labeling client and not by Office apps and services that support built-in labeling. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -245,7 +292,7 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -259,11 +306,13 @@ The ApplyContentMarkingFooterMargin parameter specifies the size (in points) of This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. +**Note**: In Microsoft Word and PowerPoint, the specified value is used as a bottom margin and left margin or right margin for left-aligned or right-aligned content marks. A minimum value of 15 points is required. Word also adds a constant offset of 5 points to the left margin for left-aligned content marks, or to the right margin for right-aligned content marks. + ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -281,7 +330,7 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -303,7 +352,7 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -322,7 +371,7 @@ The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Con Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -340,7 +389,7 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -358,7 +407,7 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -376,7 +425,7 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -390,11 +439,13 @@ The ApplyContentMarkingHeaderMargin parameter specifies the size (in points) of This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. +**Note**: In Microsoft Word and PowerPoint, the specified value is used as a top margin and left margin or right margin for left-aligned or right-aligned content marks. A minimum value of 15 points is required. Word also adds a constant offset of 5 points to the left margin for left-aligned content marks, or to the right margin for right-aligned content marks. + ```yaml Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -412,7 +463,30 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyDynamicWatermarkingEnabled +**Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. + +The ApplyDynamicWatermarkingEnabled parameter enables dynamic watermarking for a specific label that applies encryption. Valid values are: + +- $true: Enables dynamic watermarking for a specific label. +- $false: Disables dynamic watermarking for a specific label. + +You set the watermark text with the DynamicWatermarkDisplay parameter. For more information about using dynamic watermarks for supported apps, see [Dynamic watermarks](https://learn.microsoft.com/purview/encryption-sensitivity-labels#dynamic-watermarks). + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -431,7 +505,7 @@ The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarkin Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -449,7 +523,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -467,7 +541,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -485,7 +559,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -495,7 +569,7 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingLayout -The ApplyWaterMarkingAlignment parameter specifies the watermark alignment. Valid values are: +The ApplyWaterMarkingLayout parameter specifies the watermark alignment. Valid values are: - Horizontal - Diagonal @@ -506,7 +580,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -524,7 +598,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -534,13 +608,13 @@ Accept wildcard characters: False ``` ### -ColumnAssetCondition -{{ Fill ColumnAssetCondition Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -556,7 +630,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -572,7 +646,7 @@ This parameter is reserved for internal Microsoft use. Type: MulitValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -591,7 +665,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -601,19 +675,62 @@ Accept wildcard characters: False ``` ### -ContentType -The ContentType parameter specifies where the sensivity label can be applied. Valid values are: +The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: -- File, Email -- Site, UnifiedGroup +- File +- Email +- Site +- UnifiedGroup - PurviewAssets +- Teamwork +- SchematizedData -Values can be combined, for example: "File, Email, PurviewAssets". Splitting related content types like "File, Email" into just "File" or just "Email" is not supported. +Values can be combined, for example: "File, Email, PurviewAssets". ```yaml Type: MipLabelContentType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultContentLabel +The DefaultContentLabel specifies a label that can be automatically applied to meetings created in a labeled Teams channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DynamicWatermarkDisplay +**Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. + +The DynamicWatermarkDisplay parameter specifies the watermark text to display for a given label. This parameter supports text and the following special tokens: + +- `${Consumer.PrincipalName}`: Required. The value is the user principal name (UPN) of the user. +- `${Device.DateTime}`: Optional. The value is current date/time of the device used to view the document. + +This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled parameter value is $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -631,7 +748,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -652,7 +769,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -673,7 +790,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -695,7 +812,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -705,7 +822,7 @@ Accept wildcard characters: False ``` ### -EncryptionEnabled -The EncryptionEnabled parameter specifies whether encryption in enabled. Value values are: +The EncryptionEnabled parameter specifies whether encryption in enabled. Valid values are: - $true: Encryption is enabled. - $false: Encryption is disabled. @@ -714,7 +831,7 @@ The EncryptionEnabled parameter specifies whether encryption in enabled. Value v Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -735,7 +852,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -751,7 +868,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -769,7 +886,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -790,7 +907,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -812,7 +929,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -827,10 +944,10 @@ The EncryptionRightsDefinitions parameter specifies the rights users have when a This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false and the EncryptionProtectionType parameter value is Template. ```yaml -Type: String +Type: EncryptionRightsDefinitionsParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -848,7 +965,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -858,7 +975,7 @@ Accept wildcard characters: False ``` ### -EncryptionTemplateId -The EncryptionTemplateId parameter lets you convert an existing protection template from Azure Information Protection to a new sensitivity label. Specify the template by its ID that you can identify by running the [Get-AipServiceTemplate](https://docs.microsoft.com/powershell/module/aipservice/get-aipservicetemplate) cmdlet from the [AIPService PowerShell module](https://docs.microsoft.com/powershell/module/aipservice). +The EncryptionTemplateId parameter lets you convert an existing protection template from Azure Information Protection to a new sensitivity label. Specify the template by its ID that you can identify by running the [Get-AipServiceTemplate](https://learn.microsoft.com/powershell/module/aipservice/get-aipservicetemplate) cmdlet from the [AIPService PowerShell module](https://learn.microsoft.com/powershell/module/aipservice). This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. @@ -866,7 +983,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -882,7 +999,7 @@ The Identity parameter is used to migrate an existing Azure Information Protecti Type: MasterIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -898,7 +1015,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -917,7 +1034,7 @@ The LocaleSettings parameter specifies one or more localized label names or labe Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -933,7 +1050,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -953,7 +1070,23 @@ The ParentId parameter specifies the parent label that you want this label to be Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchematizedDataCondition +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -969,7 +1102,7 @@ This parameter is reserved for internal Microsoft use. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -985,7 +1118,7 @@ This parameter is reserved for internal Microsoft use. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1006,7 +1139,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1027,7 +1160,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1048,7 +1181,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1069,7 +1202,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1090,7 +1223,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1109,7 +1242,23 @@ The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Gro Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionLevel +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SiteAndGroupProtectionLevelParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1127,10 +1276,10 @@ The SiteAndGroupProtectionPrivacy parameter specifies the privacy level for the This parameter is meaningful only when the SiteAndGroupProtectionEnabled parameter value is $true or $false. ```yaml -Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType +Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+GroupProtectionPrivacy Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1158,7 +1307,7 @@ These correspond to the following settings through the admin center: Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1167,14 +1316,329 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlAssetCondition -{{ Fill SqlAssetCondition Description }} +### -TeamsAllowedPresenters +The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Valid values are: + +- Everyone +- Organization +- Organizer +- RoleIsPresenter +- $null (blank): Users configure this setting themselves in the Teams app. ```yaml -Type: String +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AllowedPresenters +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowMeetingChat +The TeamsAllowMeetingChat parameter controls whether chat is available in Teams meetings. Valid values are: + +- Enabled +- Disabled +- Limited: Chat is available only for the duration of the call. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.MeetingChatMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch +{{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsBypassLobbyForDialInUsers +The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: + +- $true: Dial in users bypass the lobby when joining Teams meetings. +- $false: Dial in users don't bypass the lobby when joining Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelProtectionEnabled +{{ Fill TeamsChannelProtectionEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithExternalTenants +{{ Fill TeamsChannelSharedWithExternalTenants Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithPrivateTeamsOnly +{{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithSameLabelOnly +{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsCopyRestrictionEnforced +The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: + +- $true: Chat messages can be copied to the clipboard. +- $false: Chat messages can't be copied to the clipboard. + +The value $null (blank) allows users to configure this setting in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsEndToEndEncryptionEnabled +The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Teams meetings. Valid values are: + +- $true: Video stream encryption is enabled. +- $false: Video stream encryption is not enabled. +- $null (blank): Users configure this setting themselves in the Teams app. + +The value $null (blank) allows users to configure this setting in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLobbyBypassScope +The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Teams meetings. Valid values are: + +- Everyone +- Invited +- Organization +- OrganizationAndFederated +- OrganizationExcludingGuests +- Organizer +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.LobbyBypassScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLobbyRestrictionEnforced +The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass the lobby when joining Teams meetings. Valid values are: + +- $true: Users bypass the lobby when joining Teams meetings. +- $false: Users don't bypass the lobby when joining Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsPresentersRestrictionEnforced +The TeamsPresentersRestrictionEnforced parameter controls whether presenter restrictions are enabled in Teams meetings. Valid values are: + +- $true: Presenter restrictions are enabled in Teams meetings. +- $false: Presenter restrictions aren't enabled in Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsProtectionEnabled +The TeamsProtectionEnabled parameter controls whether Teams protection is enabled in Teams meetings. Valid values are: + +- $true: Teams protection is enabled in Teams meetings. +- $false: Teams protection is not enabled in Teams meetings. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsRecordAutomatically +The TeamsRecordAutomatically parameter controls whether Teams meetings are automatically recorded after they start. Valid values are: + +- $true: Teams meetings are automatically recorded after they start. +- $false: Teams meetings are not automatically recorded. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsVideoWatermark +The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams meetings. Valid values are: + +- None +- EnabledForContentSharing +- EnabledForVideo +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WaterMarkProtectionValues +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsWhoCanRecord +The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid values are: + +- Organizer +- Coorganizers +- Presenters +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WhoCanRecordOptions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1184,13 +1648,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1204,12 +1668,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-LabelPolicy.md b/exchange/exchange-ps/exchange/New-LabelPolicy.md index 25e3543bf0..ce59ac07c5 100644 --- a/exchange/exchange-ps/exchange/New-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/New-LabelPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-labelpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-labelpolicy +applicable: Security & Compliance title: New-LabelPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-LabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-LabelPolicy cmdlet to create sensitivity label policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,6 +33,7 @@ New-LabelPolicy -Name -Labels [-ModernGroupLocationException ] [-OneDriveLocation ] [-OneDriveLocationException ] + [-PolicyRBACScopes ] [-PublicFolderLocation ] [-Setting ] [-Settings ] @@ -45,7 +46,7 @@ New-LabelPolicy -Name -Labels ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -65,7 +66,7 @@ The Name parameter specifies the unique name for the policy. The maximum length Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -87,7 +88,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -99,27 +100,41 @@ Accept wildcard characters: False ### -AdvancedSettings The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. -Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. +Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. -Most of the settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For instructions, see [Custom configurations for the Azure Information Protection unified labeling client](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). +Some of the settings that you configure with this parameter are supported only by the Microsoft Purview Information Protection client and not by Office apps and services that support built-in labeling. For a list of these, see [Advanced settings for Microsoft Purview Information Protection client](https://learn.microsoft.com/powershell/exchange/client-advanced-settings). Supported settings for built-in labeling: -- **OutlookDefaultLabel**: Outlook apps that support this setting apply a default label, or no label. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{OutlookDefaultLabel="None"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). +- **AttachmentAction**: Unlabeled emails inherit the highest priority label from file attachments. Set the value to **Automatic** (to automatically apply the label) or **Recommended** (as a recommended prompt to the user. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{AttachmentAction="Automatic"}`. For more information about this configuration choice, see [Configure label inheritance from email attachments](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-label-inheritance-from-email-attachments). -- **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: ` Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). +- **EnableAudit**: Prevent Office apps from sending sensitivity label data to Microsoft 365 auditing solutions. Supported apps: Word, Excel, and PowerPoint on Windows (version 2201+), macOS (version 16.57+), iOS (version 2.57+), and Android (version 16.0.14827+); Outlook on Windows (version 2201+), Outlook on the web, and rolling out to macOS, iOS, and Android. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}`. + +- **EnableRevokeGuiSupport**: Remove the Track & Revoke button from the sensitivity menu in Office clients. Supported apps: Word, Excel, and PowerPoint on Windows (version 2406+). Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{EnableRevokeGuiSupport="False"}`. For more information about this configuration choice, see [Track and revoke document access](https://learn.microsoft.com/purview/track-and-revoke-admin). + +- **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). + +- **DisableShowSensitiveContent**: For Office apps that highlight the sensitive content that caused a label to be recommended, turn off these highlights and corresponding indications about the sensitive content. For more information, see [Sensitivity labels are automatically applied or recommended for your files and emails in Office](https://support.microsoft.com/office/sensitivity-labels-are-automatically-applied-or-recommended-for-your-files-and-emails-in-office-622e0d9c-f38c-470a-bcdb-9e90b24d71a1). Supported apps: Word for Windows (version 2311+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableShowSensitiveContent="True"}` + +- **OutlookDefaultLabel**: Outlook apps that support this setting apply a default label, or no label. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{OutlookDefaultLabel="None"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). + +- **TeamworkMandatory**: Outlook and Teams apps that support this setting can enable or disable mandatory labeling for meetings. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{TeamworkMandatory="True"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). + +- **teamworkdefaultlabelid**: Outlook and Teams apps that support this setting apply a default label, or no label for meetings. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{teamworkdefaultlabelid="General"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). + +- **HideBarByDefault**: For Office apps that support the sensitivity bar, don't display the sensitivity label name on the window bar title so that there's more space to display long file names. Just the label icon and color (if configured) will be displayed. Users can't revert this setting in the app. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{HideBarByDefault="True"}` Additionally, for Power BI: -- **powerbimandatory**: Mandatory labeling for Power BI. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{powerbimandatory="true"}`. For more information about this configuration choice, see [Mandatory label policy for Power BI](https://docs.microsoft.com/power-bi/admin/service-security-sensitivity-label-mandatory-label-policy). +- **powerbimandatory**: Mandatory labeling for Power BI. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{powerbimandatory="true"}`. For more information about this configuration choice, see [Mandatory label policy for Power BI](https://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-mandatory-label-policy). -- **powerbidefaultlabelid**: Default label for Power BI content. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{powerbidefaultlabelid="General"}`. For more information about this configuration choice, see [Default label policy for Power BI](https://docs.microsoft.com/power-bi/admin/service-security-sensitivity-label-default-label-policy). +- **powerbidefaultlabelid**: Default label for Power BI content. Example: `New-LabelPolicy -Identity Global -AdvancedSettings @{powerbidefaultlabelid="General"}`. For more information about this configuration choice, see [Default label policy for Power BI](https://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-default-label-policy). ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -135,7 +150,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -154,7 +169,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -179,7 +194,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -204,7 +219,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -214,13 +229,15 @@ Accept wildcard characters: False ``` ### -Force -{{ Fill Force Description }} +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -230,13 +247,13 @@ Accept wildcard characters: False ``` ### -MigrationId -{{ Fill MigrationId Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -254,7 +271,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -270,7 +287,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -280,13 +297,13 @@ Accept wildcard characters: False ``` ### -OneDriveLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -296,13 +313,31 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -312,13 +347,13 @@ Accept wildcard characters: False ``` ### -PublicFolderLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -328,13 +363,13 @@ Accept wildcard characters: False ``` ### -Setting -PARAMVALUE: PswsHashtable +This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -344,13 +379,13 @@ Accept wildcard characters: False ``` ### -Settings -PARAMVALUE: PswsHashtable +This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -360,13 +395,13 @@ Accept wildcard characters: False ``` ### -SharePointLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -376,13 +411,13 @@ Accept wildcard characters: False ``` ### -SharePointLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -392,13 +427,13 @@ Accept wildcard characters: False ``` ### -SkypeLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -408,13 +443,13 @@ Accept wildcard characters: False ``` ### -SkypeLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -424,13 +459,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -444,12 +479,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md index 62368dc612..1182270b7a 100644 --- a/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/New-M365DataAtRestEncryptionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-m365dataatrestencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-m365dataatrestencryptionpolicy applicable: Exchange Online title: New-M365DataAtRestEncryptionPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-M365DataAtRestEncryptionPolicy cmdlet to create a new Microsoft 365 data-at-rest encryption policy. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,9 +31,9 @@ New-M365DataAtRestEncryptionPolicy [-Name] -AzureKeyIDs -ExternalEmailAddress ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,52 +57,57 @@ This example creates a new mail contact named Chris Ashton. ## PARAMETERS -### -ExternalEmailAddress -The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. +### -Name +The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). -In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. +This value is also used for the DisplayName property if you don't use the DisplayName parameter. ```yaml -Type: ProxyAddress +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the unique name of the mail contact. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +### -ExternalEmailAddress +The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user. -This value is also used for the DisplayName property if you don't use the DisplayName parameter. +In on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments. ```yaml -Type: String +Type: ProxyAddress Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -485,12 +490,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailMessage.md b/exchange/exchange-ps/exchange/New-MailMessage.md index 5d9a5154c2..c016c6ef01 100644 --- a/exchange/exchange-ps/exchange/New-MailMessage.md +++ b/exchange/exchange-ps/exchange/New-MailMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailmessage +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MailMessage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MailMessage cmdlet to create an email message for the specified user mailbox and place the email message in the Drafts folder of the user's mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ New-MailMessage ## DESCRIPTION If the cmdlet is run without specifying the Subject or Body parameters, an empty email message is placed in the user's Drafts folder. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,7 +43,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi New-MailMessage -Subject "Delivery Report" -Body "Click here to view this report" -Mailbox tony ``` -In Exchange Server 2010, this example creates an message in the Drafts folder of Tony's mailbox, with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified. +In Exchange Server 2010, this example creates a message in the Drafts folder of Tony's mailbox, with the subject and body specified by the Subject and Body parameters. The message body is rendered in plain text because no format for the message body is specified. ### Example 2 ```powershell @@ -57,7 +57,7 @@ This example creates an email message in the Drafts folder with the subject and New-MailMessage -Mailbox tony@contoso.com ``` -In Exchange Server 2010, this example creates an empty message in the Drafts folder of Tony's mailbox because no subject or message body is specified. +In Exchange Server 2010, this example creates an empty message in the Drafts folder of Tony's mailbox because no subject or message body is specified. ### Example 4 ```powershell @@ -71,7 +71,7 @@ This example creates an empty email message in the Drafts folder because no subj New-MailMessage -Subject "Delivery Information" -Body "Click here to see details" -Mailbox tony -BodyFormat Html ``` -In Exchange Server 2010, this example creates an message in the Drafts folder of Tony's mailbox with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format. +In Exchange Server 2010, this example creates a message in the Drafts folder of Tony's mailbox with the subject and body specified by the Subject and Body parameters. The message body is rendered in HTML format. ### Example 6 ```powershell @@ -188,12 +188,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailUser.md b/exchange/exchange-ps/exchange/New-MailUser.md index 571e83bd3b..27ea5d62e4 100644 --- a/exchange/exchange-ps/exchange/New-MailUser.md +++ b/exchange/exchange-ps/exchange/New-MailUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailuser +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-MailUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MailUser cmdlet to create mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. Email messages sent to mail users are delivered to the specified external email address. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -78,15 +78,12 @@ New-MailUser [-Name] -ExternalEmailAddress -Password ] ``` -### MicrosoftOnlineServicesID +### EnableRoomMailboxAccount ``` -New-MailUser [-Name] -MicrosoftOnlineServicesID -Password - [-ExternalEmailAddress ] +New-MailUser [-Name] [-MicrosoftOnlineServicesID ] [-Alias ] - [-ArbitrationMailbox ] [-Confirm] [-DisplayName ] - [-DomainController ] [-FirstName ] [-ImmutableId ] [-Initials ] @@ -97,8 +94,6 @@ New-MailUser [-Name] -MicrosoftOnlineServicesID -Passwo [-OrganizationalUnit ] [-PrimarySmtpAddress ] [-RemotePowerShellEnabled ] - [-ResetPasswordOnNextLogon ] - [-SamAccountName ] [-SendModerationNotifications ] [-WhatIf] [] @@ -130,6 +125,49 @@ New-MailUser [-Name] -FederatedIdentity [] ``` +### HVEAccount +``` +New-MailUser [-Name] -Password [-HVEAccount] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-RemotePowerShellEnabled ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + +### LOBAppAccount +``` +New-MailUser [-Name] -Password [-LOBAppAccount] + [-Alias ] + [-Confirm] + [-DisplayName ] + [-FirstName ] + [-ImmutableId ] + [-Initials ] + [-LastName ] + [-MailboxRegion ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-OrganizationalUnit ] + [-PrimarySmtpAddress ] + [-ProgressAction ] + [-RemotePowerShellEnabled ] + [-SendModerationNotifications ] + [-WhatIf] + [] +``` + ### MicrosoftOnlineServicesFederatedUser ``` New-MailUser [-Name] -FederatedIdentity -MicrosoftOnlineServicesID @@ -155,13 +193,15 @@ New-MailUser [-Name] -FederatedIdentity -MicrosoftOnlineServic [] ``` -### EnableRoomMailboxAccount +### MicrosoftOnlineServicesID ``` -New-MailUser [-Name] - [-MicrosoftOnlineServicesID ] +New-MailUser [-Name] -MicrosoftOnlineServicesID -Password + [-ExternalEmailAddress ] [-Alias ] + [-ArbitrationMailbox ] [-Confirm] [-DisplayName ] + [-DomainController ] [-FirstName ] [-ImmutableId ] [-Initials ] @@ -170,32 +210,27 @@ New-MailUser [-Name] [-ModeratedBy ] [-ModerationEnabled ] [-OrganizationalUnit ] + [-PrimarySmtpAddress ] [-RemotePowerShellEnabled ] + [-ResetPasswordOnNextLogon ] + [-SamAccountName ] [-SendModerationNotifications ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -MicrosoftOnlineServicesID ed@tailspintoys -Password (ConvertTo-SecureString -String 'P@ssw0rd1' -AsPlainText -Force) +New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -MicrosoftOnlineServicesID ed@contoso.com -Password (Get-Credential).password ``` This example creates a new mail user for Ed Meadows in the contoso.com cloud-based organization. The mail user gives Ed an account and email address in the contoso.com domain, but messages sent to Ed are delivered to his tailspintoys.com email address. -### Example 2 -```powershell -$password = Read-Host "Enter password" -AsSecureString -New-MailUser -Name "Ed Meadows" -ExternalEmailAddress ed@tailspintoys.com -UserPrincipalName ed@contoso.com -Password $password -``` - -This example is similar to the first, except contoso.com is now an on-premises Exchange organization, and you use a separate command to enter the password so it isn't stored in clear text. - ## PARAMETERS ### -Name @@ -236,7 +271,7 @@ Accept wildcard characters: False ```yaml Type: ProxyAddress -Parameter Sets: MicrosoftOnlineServicesID, FederatedUser +Parameter Sets: FederatedUser, MicrosoftOnlineServicesID Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection @@ -297,11 +332,15 @@ Accept wildcard characters: False ### -Password The Password parameter specifies the password for the user's account. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString -Parameter Sets: EnabledUser, MicrosoftOnlineServicesID +Parameter Sets: EnabledUser, HVEAccount, LOBAppAccount, MicrosoftOnlineServicesID Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection @@ -331,15 +370,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -509,6 +553,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HVEAccount +This parameter is available only in the cloud-based service. + +The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: HVEAccount +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Position: Named +Default value: None +Required: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LOBAppAccount +This parameter is available only in the cloud-based service. + +{{ Fill LOBAppAccount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: LOBAppAccount +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MacAttachmentFormat The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are: @@ -544,7 +624,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -676,7 +756,7 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. @@ -686,9 +766,9 @@ If you use the PrimarySmtpAddress parameter to specify the primary email address ```yaml Type: SmtpAddress -Parameter Sets: DisabledUser, EnabledUser, FederatedUser, MicrosoftOnlineServicesID +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -698,10 +778,14 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled -The RemotePowerShellEnabled parameter specifies whether the user can connect to Exchange using remote PowerShell. Remote PowerShell is required to open the Exchange Management Shell on Exchange servers, or to use Windows PowerShell open and import a remote PowerShell session to Exchange. Access to remote PowerShell is required even if you're trying to open the Exchange Management Shell on the local Exchange server. Valid values are: +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: + +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. +- $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. + +Access to Exchange PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. -- $true: The user can use remote PowerShell. This is the default value. -- $false: The user can't use remote PowerShell. +A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. ```yaml Type: Boolean @@ -817,12 +901,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-Mailbox.md b/exchange/exchange-ps/exchange/New-Mailbox.md index a4f2a7ba74..8a4bb79a06 100644 --- a/exchange/exchange-ps/exchange/New-Mailbox.md +++ b/exchange/exchange-ps/exchange/New-Mailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailbox +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-Mailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-Mailbox cmdlet to create mailboxes and user accounts at the same time. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -119,6 +119,7 @@ New-Mailbox [-Name] [-Arbitration] [-Password ] [-UserPri [-MailboxRegion ] [-OrganizationalUnit ] [-PrimarySmtpAddress ] + [-ProxyEmailAddress ] [-RemotePowerShellEnabled ] [-ResetPasswordOnNextLogon ] [-RetentionPolicy ] @@ -267,7 +268,7 @@ New-Mailbox [-Name] [-Discovery] [-Password ] [-UserPrinc ### EnableRoomMailboxAccount ``` -New-Mailbox [-Name] -EnableRoomMailboxAccount [-MicrosoftOnlineServicesID [-Room] [-RoomMailboxPassword ] [-UserPrincipalName ] +New-Mailbox [-Name] -EnableRoomMailboxAccount [-MicrosoftOnlineServicesID ] [-Room] [-RoomMailboxPassword ] [-UserPrincipalName ] [-ActiveSyncMailboxPolicy ] [-AddressBookPolicy ] [-Alias ] @@ -762,13 +763,16 @@ New-Mailbox [-Name] [-SupervisoryReviewPolicy] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +In Exchange Server, the [CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216) InformationVariable and InformationAction don't work. ## EXAMPLES ### Example 1 ```powershell $password = Read-Host "Enter password" -AsSecureString + New-Mailbox -UserPrincipalName chris@contoso.com -Alias chris -Database "Mailbox Database 1" -Name ChrisAshton -OrganizationalUnit Users -Password $password -FirstName Chris -LastName Ashton -DisplayName "Chris Ashton" -ResetPasswordOnNextLogon $true ``` @@ -783,15 +787,17 @@ This example creates a user in Active Directory and a resource mailbox for a con ### Example 3 ```powershell -New-Mailbox -UserPrincipalName confroom1010@contoso.com -Alias confroom1010 -Name "Conference Room 1010" -Room -EnableRoomMailboxAccount $true -RoomMailboxPassword (ConvertTo-SecureString -String P@ssw0rd -AsPlainText -Force) +New-Mailbox -UserPrincipalName confroom1010@contoso.com -Alias confroom1010 -Name "Conference Room 1010" -Room -EnableRoomMailboxAccount $true -RoomMailboxPassword (Get-Credential).password ``` -This example creates an enabled user account in Active Directory and a room mailbox for a conference room in an on-premises Exchange organization. The RoomMailboxPassword parameter specifies the password for the user account. +This example creates an enabled user account in Active Directory and a room mailbox for a conference room in an on-premises Exchange organization. The RoomMailboxPassword parameter prompts you to enter the password for the user account. ### Example 4 ```powershell New-Mailbox -Shared -Name "Sales Department" -DisplayName "Sales Department" -Alias Sales + Set-Mailbox -Identity Sales -GrantSendOnBehalfTo MarketingSG + Add-MailboxPermission -Identity Sales -User MarketingSG -AccessRights FullAccess -InheritanceType All ``` @@ -804,6 +810,8 @@ This example assumes that you've already created a mail-enabled security group n ### -Name The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character). + ```yaml Type: String Parameter Sets: (All) @@ -895,7 +903,7 @@ Accept wildcard characters: False ### -Discovery The Discovery switch is required to create Discovery mailboxes. You don't need to specify a value with this switch. -Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). +Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: SwitchParameter @@ -911,16 +919,18 @@ Accept wildcard characters: False ``` ### -EnableRoomMailboxAccount +This parameter is functional only in on-premises Exchange. + The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: -- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. This allows the account to log on to the room mailbox. -- $false: The account that's associated with the room mailbox is disabled. You can't use the account to logon to the room mailbox. This is the default value. +- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. The account is able to log in and access the room mailbox or other resources. +- $false: The account that's associated with the room mailbox is disabled. The account is not able to log in and access the room mailbox or other resources. In on-premises Exchange, this is the default value. -You need to use this parameter with the Room switch. +You need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. -Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. +You need to use this parameter with the Room switch. -In Exchange Online, a room mailbox with an associated enabled account doesn't require a license. +A room mailbox in Exchange Online is created with associated an account that has a random, unknown password. This account is active and visible in Microsoft Graph PowerShell and the Microsoft 365 admin center just like a regular user account, but it consumes no licenses. To prevent this account from being able to log in after you create the mailbox, use the AccountEnabled parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: Boolean @@ -1068,7 +1078,7 @@ Accept wildcard characters: False ### -MicrosoftOnlineServicesID This parameter is available only in the cloud-based service. -The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter applies only to objects in the cloud-based service and is used instead of the UserPrincipalName parameter. The MicrosoftOnlineServicesID parameter isn't available in on-premises deployments. +The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter applies only to objects in the cloud-based service and is used instead of the UserPrincipalName parameter. The MicrosoftOnlineServicesID parameter isn't available in on-premises deployments. ```yaml Type: WindowsLiveId @@ -1115,7 +1125,11 @@ Accept wildcard characters: False ### -Password The Password parameter specifies the password for the mailbox (the user account that's associated with the mailbox). This parameter isn't required if you're creating a linked mailbox, resource mailbox, or shared mailbox, because the associated user accounts are disabled for these types of mailboxes. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString @@ -1186,7 +1200,9 @@ The Room switch is required to create room mailboxes. You don't need to specify Room mailboxes are resource mailboxes that are associated with a specific location (for example, conference rooms). -When you use this switch, a logon-disabled account is created with the room mailbox, which prevents users from signing in to the mailbox. When you use the EnableRoomMailboxAccount and RoomMailboxPassword parameters, you can mail-enable the associated account. +When you use this switch in on-premises Exchange, a disabled account is created with the room mailbox. The account can't be used to sign in to the mailbox or anywhere in the organization. To enable the associated account, use the EnableRoomMailboxAccount and RoomMailboxPassword parameters. + +When you use this switch in Exchange Online, an account with a random, unknown password is created for the room mailbox. If the password is known or changed, the account can be used to log in to the mailbox or anywhere in the organization. To prevent this account from being able to log in after you create the room mailbox, use the AccountEnabled parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: SwitchParameter @@ -1283,7 +1299,7 @@ The AddressBookPolicy parameter specifies the address book policy that's applied - Distinguished name (DN) - GUID -For more information about address book policies, see [Address book policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). +For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). ```yaml Type: AddressBookMailboxPolicyIdParameter @@ -1299,15 +1315,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -1534,7 +1555,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -1640,7 +1663,7 @@ This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -1690,7 +1713,7 @@ The MailboxRegion parameter specifies the geo location for the mailbox in multi- To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the following command: `Get-OrganizationConfig | Select -ExpandProperty AllowedMailboxRegions | Format-Table`. To view your central geo location, run the following command: `Get-OrganizationConfig | Select DefaultMailboxRegion`. - For more information, see [Administering Exchange Online mailboxes in a multi-geo environment](https://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). + For more information, see [Administering Exchange Online mailboxes in a multi-geo environment](https://learn.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). ```yaml Type: String @@ -1726,7 +1749,9 @@ Accept wildcard characters: False ### -ManagedFolderMailboxPolicyAllowed This parameter is available only in Exchange Server 2010. -The ManagedFolderMailboxPolicyAllowed parameter specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Microsoft Outlook earlier than Office Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed parameter is used. +The ManagedFolderMailboxPolicyAllowed switch specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for clients using versions of Microsoft Outlook earlier than Office Outlook 2007. You don't need to specify a value with this switch. + +When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed switch is used. Outlook 2003 Service Pack 3 clients are supported but are provided limited functionality for MRM. @@ -1864,6 +1889,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProxyEmailAddress +This parameter is available only in the cloud-based service. + +{{ Fill ProxyEmailAddress Description }} + +```yaml +Type: Object +Parameter Sets: Arbitration +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoteArchive This parameter is available only in on-premises Exchange. @@ -1883,12 +1926,12 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled -The RemotePowerShellEnabled parameter specifies whether the user has access to remote PowerShell. Valid values are: +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: - $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. - $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. -Access to remote PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. +Access to Exchange PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. @@ -1977,7 +2020,7 @@ The RoleAssignmentPolicy parameter specifies the role assignment policy that's a In Exchange Online PowerShell, if you don't use this parameter, the default role assignment policy named Default Role Assignment Policy is automatically applied to the mailbox. In on-premises Exchange, no role assignment policy is automatically applied to the mailbox. -Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information about assignment policies, see [Understanding management role assignment policies](https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). +Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). ```yaml Type: MailboxPolicyIdParameter @@ -1993,14 +2036,25 @@ Accept wildcard characters: False ``` ### -RoomMailboxPassword -Use the RoomMailboxPassword parameter to configure the password for a room mailbox that has a logon-enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) +This parameter is functional only in on-premises Exchange. + +Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). + +To use this parameter in on-premises Exchange, you need to be a member of one of the following role groups: + +- The Organization Management role group via the Mail Recipients and User Options roles. +- The Recipient Management role group via the Mail Recipients role. +- The Help Desk role group via the User Options role. + +The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. -To use this parameter, you need to be a member of one of the following role groups: +You can use the following methods as a value for this parameter: -- Exchange Online: The Organization Management role group via the Mail Recipients, Reset Password, and User Options roles, the Help Desk role group via the Reset Password and User Options roles, or the Recipient Management role group via the Mail Recipients and Reset Password roles. -- On-premises Exchange: The Organization Management role group via the Mail Recipients and User Options roles, the Recipient Management role group via the Mail Recipients role, or the Help Desk role group via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +To configure the password for a room mailbox account in Exchange Online, use [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: SecureString @@ -2164,12 +2218,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md b/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md index 8be33f9672..38f9329045 100644 --- a/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md +++ b/exchange/exchange-ps/exchange/New-MailboxAuditLogSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailboxauditlogsearch +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxauditlogsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MailboxAuditLogSearch schema: 2.0.0 @@ -12,11 +12,14 @@ ms.reviewer: # New-MailboxAuditLogSearch ## SYNOPSIS +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: . + This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the New-MailboxAuditLogSearch cmdlet to search mailbox audit logs and have search results sent via email to specified recipients. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,9 +42,9 @@ New-MailboxAuditLogSearch -EndDate -StartDate -StatusM ## DESCRIPTION The New-MailboxAuditLogSearch cmdlet performs an asynchronous search of mailbox audit logs for the specified mailboxes and sends the search results by email to the specified recipients. The body of the email message contains search metadata such as search parameters and the time when the search request was submitted. The results are attached in an .xml file. -To search mailbox audit logs for a single mailbox and have the results displayed in the Exchange Management Shell window, use the Search-MailboxAuditLog cmdlet instead. To learn more about mailbox audit logging, see [Mailbox audit logging in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). +To search mailbox audit logs for a single mailbox and have the results displayed in the Exchange Management Shell window, use the Search-MailboxAuditLog cmdlet instead. To learn more about mailbox audit logging, see [Mailbox audit logging in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,7 +67,7 @@ This example returns entries from the mailbox audit logs of all users in organiz ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -82,7 +85,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -334,12 +337,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailboxDatabase.md b/exchange/exchange-ps/exchange/New-MailboxDatabase.md index f88f8f0278..a16092d137 100644 --- a/exchange/exchange-ps/exchange/New-MailboxDatabase.md +++ b/exchange/exchange-ps/exchange/New-MailboxDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailboxdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-MailboxDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-MailboxDatabase cmdlet to create a mailbox database, or a recovery database. Each database you create must have a unique name in the organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,7 +52,7 @@ New-MailboxDatabase [[-Name] ] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -199,7 +199,9 @@ Accept wildcard characters: False ``` ### -IsExcludedFromInitialProvisioning -The IsExcludedFromInitialProvisioning parameter specifies that this database is temporarily not considered by the mailbox provisioning load balancer. If the IsExcludedFromInitialProvisioning parameter is enabled, new mailboxes aren't added automatically to this database. +The IsExcludedFromInitialProvisioning switch specifies that this database is temporarily not considered by the mailbox provisioning load balancer. You don't need to specify a value with this switch. + +If you use this switch, new mailboxes aren't added automatically to this database. ```yaml Type: SwitchParameter @@ -335,12 +337,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md index 3124acaa16..56a97e1c20 100644 --- a/exchange/exchange-ps/exchange/New-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxExportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailboxexportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-MailboxExportRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the New-MailboxExportRequest cmdlet to begin the process of exporting contents of a primary mailbox or archive to a .pst file. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -119,7 +119,7 @@ New-MailboxExportRequest [-Mailbox] -ComplianceStor ## DESCRIPTION You can create more than one mailbox export request per mailbox, and each mailbox export request must have a unique name. Microsoft Exchange automatically generates up to 10 unique names for a mailbox export request. However, to create more than 10 export requests for a mailbox, you need to specify a unique name when creating the export request. You can remove existing export requests with the Remove-MailboxExportRequest cmdlet before starting a new request with the default request name `\MailboxExportX` (where X = 0-9). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: @@ -160,45 +160,6 @@ This example exports all messages from Kweku's Inbox to the .pst file InPlaceHol ## PARAMETERS -### -ComplianceStorePath -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: MailboxComplianceExportRequest -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -The FilePath parameter specifies the network share path of the .pst file to which data is exported, for example, \\\\SERVER01\\PST Files\\exported.pst. - -You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: - -- To import PST files from the share: Read permission -- To save exported PST files to the share: Read/Write permission. - -If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. - -```yaml -Type: LongPath -Parameter Sets: Mailbox, MailboxExportRequest -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Mailbox The Mailbox parameter specifies the source mailbox where the contents are being exported from. @@ -243,6 +204,45 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -ComplianceStorePath +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: MailboxComplianceExportRequest +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilePath +The FilePath parameter specifies the network share path of the .pst file to which data is exported, for example, \\\\SERVER01\\PST Files\\exported.pst. + +You need to grant the following permission to the group Exchange Trusted Subsystem to the network share where you want to export or import PST files: + +- To import PST files from the share: Read permission +- To save exported PST files to the share: Read/Write permission. + +If you don't grant this permission, you will receive an error message stating that Exchange is unable to establish a connection to the PST file on the network share. + +```yaml +Type: LongPath +Parameter Sets: Mailbox, MailboxExportRequest +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoteCredential This parameter is reserved for internal Microsoft use. @@ -409,16 +409,18 @@ Accept wildcard characters: False ``` ### -ContentFilter -The ContentFilter parameter uses OPath filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be exported into the .pst file. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +**Important**: You can't use this parameter to export between two dates. If you try, you'll get system convert errors. You can export from a specific date, or export to a specific date, but not both. + +The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be exported into the .pst file. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://docs.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://learn.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -436,7 +438,7 @@ Accept wildcard characters: False ### -ContentFilterLanguage The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -468,7 +470,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster -The ExcludeDumpster parameter specifies whether to exclude the Recoverable Items folder. You don't have to include a value with this parameter. If you don't specify this parameter, the Recoverable Items folder is copied with the following subfolders: +The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. + +If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: - Deletions - Versions @@ -616,8 +620,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -784,7 +788,9 @@ Accept wildcard characters: False ``` ### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter @@ -868,12 +874,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailboxFolder.md b/exchange/exchange-ps/exchange/New-MailboxFolder.md index b4b919f9b3..8edb27513b 100644 --- a/exchange/exchange-ps/exchange/New-MailboxFolder.md +++ b/exchange/exchange-ps/exchange/New-MailboxFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailboxfolder +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MailboxFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MailboxFolder cmdlet to create folders in your own mailbox. Administrators can't use this cmdlet to create folders in other mailboxes (the cmdlet is available only from the MyBaseOptions user role). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ New-MailboxFolder [-Name] -Parent ## DESCRIPTION If no parent folder is specified, the cmdlet creates a mail folder in the root folder hierarchy of the mailbox. If the mailbox isn't specified, the cmdlet creates the folder in the mailbox of the user currently running the task. When run, the cmdlet returns the new folder name and the folder path as the output. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). . +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). . ## EXAMPLES @@ -162,12 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md index 0e2706cfb4..f037f6aba2 100644 --- a/exchange/exchange-ps/exchange/New-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxImportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailboximportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MailboxImportRequest schema: 2.0.0 @@ -16,11 +16,11 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MailboxImportRequest cmdlet to begin the process of importing a .pst file to a mailbox or archive. -**Note**: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://docs.microsoft.com/microsoft-365/compliance/use-network-upload-to-import-pst-files). +**Note**: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://learn.microsoft.com/purview/use-network-upload-to-import-pst-files). -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -419,7 +419,7 @@ Accept wildcard characters: False ``` ### -ContentCodePage -The ContentCodePage parameter specifies the specific code page to use for an ANSI pst file. ANSI pst files are used in Outlook 97 to Outlook 2002. You can find the valid values in the [Code Page Identifiers](https://docs.microsoft.com/windows/win32/intl/code-page-identifiers) topic. +The ContentCodePage parameter specifies the specific code page to use for an ANSI pst file. ANSI pst files are used in Outlook 97 to Outlook 2002. You can find the valid values in the [Code Page Identifiers](https://learn.microsoft.com/windows/win32/intl/code-page-identifiers) topic. ```yaml Type: Int32 @@ -453,7 +453,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster -The ExcludeDumpster parameter specifies whether to exclude the Recoverable Items folder. You don't have to include a value with this parameter. If you don't specify this parameter, the Recoverable Items folder is copied with the following subfolders: +The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. + +If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: - Deletions - Versions @@ -601,8 +603,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -835,7 +837,9 @@ Accept wildcard characters: False ``` ### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter @@ -921,12 +925,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md index beb9355eeb..b5e267cdc2 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRepairRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailboxrepairrequest +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxrepairrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-MailboxRepairRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-MailboxRepairRequest cmdlet to detect and fix mailbox corruption issues. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -50,7 +50,7 @@ After you begin a repair request, you can't stop it unless you dismount the data To avoid performance problems, only one request can be active on a server for a database-level repair, or up to 100 requests can be active on a server for a mailbox-level repair. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -85,6 +85,7 @@ This example detects and repairs all corruption types for Ayla Kol's mailbox and ### Example 5 ```powershell $Mailbox = Get-MailboxStatistics annb + New-MailboxRepairRequest -Database $Mailbox.Database -StoreMailbox $Mailbox.MailboxGuid -CorruptionType ProvisionedFolder,SearchFolder,AggregateCounts,Folderview ``` @@ -92,66 +93,6 @@ This example creates a variable that identifies Ann Beebe's mailbox and then use ## PARAMETERS -### -CorruptionType -The CorruptionType parameter specifies the type of corruption that you want to detect and repair. You can use the following values: - -- AbandonedMoveDestination\*: Exchange 2016 or later, but only with the Database parameter, not the Mailbox parameter. -- AggregateCounts\*: Aggregate counts on folders that aren't reflecting correct values. -- BigFunnelMissingPOIs\*: Exchange 2016. -- BigFunnelPOI: Exchange 2019. -- CleanupFilesFolder\*: Exchange 2016 or later. -- CleanupGraphNodesWithPropertyError\*: Exchange 2016 or later. -- CleanupOfficeGraphFolders\*: Exchange 2016 or later. -- CleanupOfficeGraphSsc: Exchange 2016 or later. -- CleanupOrphanedIndexes\*: Exchange 2016 or later. -- CleanupTrendingAroundMe\*: Exchange 2016 or later. -- CorruptJunkRule\*: Exchange 2013 or later. -- CorruptSearchFolderCriteria\*: Exchange 2016 or later. -- CorruptedPerUserData\*: Exchange 2016 or later. -- DropAllLazyIndexes\*: Exchange 2013 or later. -- EmptyFilesFolder\*: Exchange 2016 or later. -- Extension1: Exchange 2013 or later, but reserved for internal Microsoft use. -- Extension2: Exchange 2013 or later, but reserved for internal Microsoft use. -- Extension3: Exchange 2013 or later, but reserved for internal Microsoft use. -- Extension4: Exchange 2013 or later, but reserved for internal Microsoft use. -- Extension5: Exchange 2013 or later, but reserved for internal Microsoft use. -- FocusedInboxCleanup\*: Exchange 2016 or later. -- FolderACL\*: Exchange 2013 or later. -- FolderView\*: Views on folders that aren't returning correct contents. -- ImapId\*: Exchange 2013 or later. -- LockedMoveTarget\*: Exchange 2013 or later, but only if the mailbox is locked. -- MessageId -- MessagePtagCn -- MissingSpecialFolders: Exchange 2013 or later. -- OlcFolderCleanup: Exchange 2016 or later. -- ProvisionedFolder: Provisioned folders that are incorrectly pointing into parent folders that aren't provisioned. -- ReduceRedundantAI\*: Exchange 2016 or later. -- RemovePICWFolder: Exchange 2016 or later, but reserved for internal Microsoft use. -- ReplState: Exchange 2013 or later. -- RestrictionFolder: Exchange 2013 or later. -- RuleMessageClass: Exchange 2013 or later. -- ScheduledCheck: Exchange 2013 or later. -- SearchFolder: Search folder corruption. -- SyncDefaultFolderLocalizationWithMailbox: Exchange 2016 or later. -- UniqueMidIndex: Exchange 2013 or later. - -You can specify multiple values separated by commas. - -\* You can only use this value by itself. - -```yaml -Type: MailboxStoreCorruptionType[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Database The Database parameter repairs or detects corruption in all mailboxes in the specified database. You can use any value that uniquely identifies the database. For example: @@ -223,6 +164,66 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -CorruptionType +The CorruptionType parameter specifies the type of corruption that you want to detect and repair. You can use the following values: + +- AbandonedMoveDestination\*: Exchange 2016 or later, but only with the Database parameter, not the Mailbox parameter. +- AggregateCounts\*: Aggregate counts on folders that aren't reflecting correct values. +- BigFunnelMissingPOIs\*: Exchange 2016. +- BigFunnelPOI: Exchange 2019. +- CleanupFilesFolder\*: Exchange 2016 or later. +- CleanupGraphNodesWithPropertyError\*: Exchange 2016 or later. +- CleanupOfficeGraphFolders\*: Exchange 2016 or later. +- CleanupOfficeGraphSsc: Exchange 2016 or later. +- CleanupOrphanedIndexes\*: Exchange 2016 or later. +- CleanupTrendingAroundMe\*: Exchange 2016 or later. +- CorruptJunkRule\*: Exchange 2013 or later. +- CorruptSearchFolderCriteria\*: Exchange 2016 or later. +- CorruptedPerUserData\*: Exchange 2016 or later. +- DropAllLazyIndexes\*: Exchange 2013 or later. +- EmptyFilesFolder\*: Exchange 2016 or later. +- Extension1: Exchange 2013 or later, but reserved for internal Microsoft use. +- Extension2: Exchange 2013 or later, but reserved for internal Microsoft use. +- Extension3: Exchange 2013 or later, but reserved for internal Microsoft use. +- Extension4: Exchange 2013 or later, but reserved for internal Microsoft use. +- Extension5: Exchange 2013 or later, but reserved for internal Microsoft use. +- FocusedInboxCleanup\*: Exchange 2016 or later. +- FolderACL\*: Exchange 2013 or later. +- FolderView\*: Views on folders that aren't returning correct contents. +- ImapId\*: Exchange 2013 or later. +- LockedMoveTarget\*: Exchange 2013 or later, but only if the mailbox is locked. +- MessageId +- MessagePtagCn +- MissingSpecialFolders: Exchange 2013 or later. +- OlcFolderCleanup: Exchange 2016 or later. +- ProvisionedFolder: Provisioned folders that are incorrectly pointing into parent folders that aren't provisioned. +- ReduceRedundantAI\*: Exchange 2016 or later. +- RemovePICWFolder: Exchange 2016 or later, but reserved for internal Microsoft use. +- ReplState: Exchange 2013 or later. +- RestrictionFolder: Exchange 2013 or later. +- RuleMessageClass: Exchange 2013 or later. +- ScheduledCheck: Exchange 2013 or later. +- SearchFolder: Search folder corruption. +- SyncDefaultFolderLocalizationWithMailbox: Exchange 2016 or later. +- UniqueMidIndex: Exchange 2013 or later. + +You can specify multiple values separated by commas. + +\* You can only use this value by itself. + +```yaml +Type: MailboxStoreCorruptionType[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Archive The Archive switch specifies whether to repair or detect corruption the archive mailbox that's associated with the specified mailbox. You don't need to specify a value with this switch. @@ -295,7 +296,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies that the command should run immediately and not wait to be dispatched by workload management. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +This switch runs the command immediately without waiting to be dispatched by workload management. ```yaml Type: SwitchParameter @@ -331,12 +334,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md index 54768801bb..43a1b13892 100644 --- a/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/New-MailboxRestoreRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailboxrestorerequest +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MailboxRestoreRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MailboxRestoreRequest cmdlet to restore a soft-deleted or disconnected mailbox. This cmdlet starts the process of moving content from the soft-deleted mailbox, disabled mailbox, or any mailbox in a recovery database into a connected primary or archive mailbox. -The properties used to find disconnected mailboxes and restore a mailbox are different in Exchange Server and Exchange Online. For more information about Exchange Online, see [Restore an inactive mailbox](https://docs.microsoft.com/microsoft-365/compliance/restore-an-inactive-mailbox). +The properties used to find disconnected mailboxes and restore a mailbox are different in Exchange Server and Exchange Online. For more information about Exchange Online, see [Restore an inactive mailbox](https://learn.microsoft.com/purview/restore-an-inactive-mailbox). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -59,6 +59,8 @@ New-MailboxRestoreRequest -SourceEndpoint -Source [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-CrossTenantRestore] [-DomainController ] [-ExcludeDumpster] @@ -66,6 +68,7 @@ New-MailboxRestoreRequest -SourceEndpoint -Source [-IncludeFolders ] [-LargeItemLimit ] [-Name ] + [-SkipMerging ] [-SourceRootFolder ] [-SuspendComment ] [-Suspend] @@ -87,6 +90,8 @@ New-MailboxRestoreRequest -SourceDatabase -SourceStoreMail [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -119,6 +124,8 @@ New-MailboxRestoreRequest -SourceStoreMailbox -TargetM [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -181,6 +188,8 @@ New-MailboxRestoreRequest -RemoteDatabaseGuid -RemoteHostName -Rem [-CompletedRequestAgeLimit ] [-Confirm] [-ConflictResolutionOption ] + [-ContentFilter ] + [-ContentFilterLanguage ] [-DomainController ] [-ExcludeDumpster] [-ExcludeFolders ] @@ -216,21 +225,16 @@ Exchange retains disabled mailboxes in the mailbox database based on the deleted To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a database and look for results that have a DisconnectReason with a value of Disabled. For more information, see Examples 2 and 3 later in this topic. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +**Note**: To restore the contents of a primary mailbox to an archive mailbox, use the TargetRootFolder parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. ## EXAMPLES ### Example 1 ```powershell -Get-Mailbox -SoftDeletedMailbox "User Name" | Format-List ExchangeGUID -New-MailboxRestoreRequest -SourceMailbox "ExchangeGUID" -TargetMailbox "User Name" -AllowLegacyDNMismatch -``` - -In Exchange Online, this example uses the Get-Mailbox cmdlet to find the ExchangeGUID value of the mailbox, which is required to restore the mailbox contents. - -### Example 2 -```powershell Get-MailboxStatistics -Database MBD01 | Where {$_.DisconnectReason -eq "SoftDeleted" -or $_.DisconnectReason -eq "Disabled"} | Format-List LegacyExchangeDN,DisplayName,MailboxGUID, DisconnectReason + New-MailboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox 1d20855f-fd54-4681-98e6-e249f7326ddd -TargetMailbox Ayla ``` @@ -238,13 +242,24 @@ In on-premises Exchange, this example uses the Get-MailboxStatistics cmdlet to r Using this information, the source mailbox with the MailboxGUID value 1d20855f-fd54-4681-98e6-e249f7326ddd is restored to the target mailbox that has the Alias value Ayla. -### Example 3 +### Example 2 ```powershell New-MailboxRestoreRequest -SourceDatabase "MBD01" -SourceStoreMailbox "Tony Smith" -TargetMailbox Tony@contoso.com -TargetIsArchive ``` In on-premises Exchange, this example restores the content of the source mailbox with the DisplayName of Tony Smith on mailbox database MBD01 to the archive mailbox for Tony@contoso.com. +### Example 3 +```powershell +New-MailboxRestoreRequest -SourceMailbox 33948c06-c453-48be-bdb9-08eacd466f81 -TargetMailbox Tony@contoso.com -AllowLegacyDNMismatch +``` + +In Exchange Online, this example restores the content of the inactive, disconnected, or soft deleted source mailbox to the active mailbox for Tony@contoso.com: + +- The SourceMailbox value is the MailboxGUID value of an inactive, disconnected, or soft deleted mailbox. +- The TargetMailbox value is the MailboxGUID or email address of the active target mailbox. +- AllowLegacyDNMismatch allows copying data from one mailbox to another in this scenario. + ## PARAMETERS ### -CrossTenantRestore @@ -412,7 +427,7 @@ Accept wildcard characters: False ``` ### -SourceStoreMailbox -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The SourceStoreMailbox parameter specifies the MailboxGUID of the source mailbox that you want to restore content from. @@ -509,6 +524,8 @@ The AllowLegacyDNMismatch switch specifies that the operation should continue if By default, this cmdlet checks to make sure that the LegacyExchangeDN on the source physical mailbox is present on the target user in the form of the LegacyExchangeDN or an X500 proxy address that corresponds to the LegacyExchangeDN. This check prevents you from accidentally restoring a source mailbox into the incorrect target mailbox. +**Note**: This parameter is being deprecated in the cloud-based service. To complete a mailbox restore request for mailboxes with a LegacyExchangeDN that doesn't match, you need to obtain the LegacyExchangeDN value for the source mailbox and add it to the target mailbox as an X500 proxy address. For detailed instructions, see [Restore an inactive mailbox](https://learn.microsoft.com/purview/restore-an-inactive-mailbox#restore-inactive-mailboxes). + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -640,8 +657,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContentFilter +This parameter is available only in the cloud-based service. + +The ContentFilter parameter uses OPATH filter syntax to filter the results by the specified properties and values. Only contents that match the ContentFilter parameter will be restored. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. + +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the ContentFilter parameter](https://learn.microsoft.com/exchange/filterable-properties-for-the-contentfilter-parameter). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. + +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + +```yaml +Type: String +Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFilterLanguage +This parameter is available only in the cloud-based service. + +The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. + +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +```yaml +Type: CultureInfo +Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, SourceMailbox +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -659,7 +723,9 @@ Accept wildcard characters: False ``` ### -ExcludeDumpster -The ExcludeDumpster parameter specifies whether to exclude the Recoverable Items folder. You don't have to include a value with this parameter. If you don't specify this parameter, the Recoverable Items folder is copied with the following subfolders: +The ExcludeDumpster switch specifies whether to exclude the Recoverable Items folder. You don't need to specify a value with this switch. + +If you don't use this switch, the Recoverable Items folder is copied with the following subfolders: - Deletions - Versions @@ -789,8 +855,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -900,8 +966,6 @@ Accept wildcard characters: False ``` ### -SkipMerging -This parameter is available only in on-premises Exchange. - The SkipMerging parameter specifies folder-related items to skip when restoring the mailbox. Use one of the following values: - FolderACLs @@ -913,9 +977,9 @@ Use this parameter only if a restore request fails because of folder rules, fold ```yaml Type: SkippableMergeComponent[] -Parameter Sets: MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox +Parameter Sets: CrossTenantRestore, MigrationLocalMailboxRestore, RemoteMailboxRestoreMailboxLocationId, RemoteMailboxRestoreMailboxId, SourceMailbox Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -925,7 +989,9 @@ Accept wildcard characters: False ``` ### -SourceIsArchive -The SourceIsArchive switch specifies that the source mailbox is an archive mailbox. You can use this switch only with the SourceMailbox parameter. +The SourceIsArchive switch specifies that the source mailbox is an archive mailbox. You don't need to specify a value with this switch. + +You can use this switch only with the SourceMailbox parameter. ```yaml Type: SwitchParameter @@ -957,7 +1023,9 @@ Accept wildcard characters: False ``` ### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter @@ -989,7 +1057,7 @@ Accept wildcard characters: False ``` ### -TargetIsArchive -The TargetIsArchive parameter specifies that the content is restored into the specified target mailbox's archive. +The TargetIsArchive switch specifies that the content is restored into the specified target mailbox's archive. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -1007,6 +1075,8 @@ Accept wildcard characters: False ### -TargetRootFolder The TargetRootFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. +**Note**: To restore the contents of a primary mailbox to an archive mailbox, use this parameter to specify the archive mailbox folders to migrate the content to. This content will be visible after it's restored. If you don't use this parameter, the restored content is not visible because it's mapped to locations in the archive mailbox that aren't visible to users. + ```yaml Type: String Parameter Sets: (All) @@ -1079,12 +1149,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MailboxSearch.md b/exchange/exchange-ps/exchange/New-MailboxSearch.md index 4da33f6a85..8c7db70175 100644 --- a/exchange/exchange-ps/exchange/New-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/New-MailboxSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-mailboxsearch +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-MailboxSearch schema: 2.0.0 author: chrisda @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MailboxSearch cmdlet to create a mailbox search and either get an estimate of search results, place search results on In-Place Hold or copy them to a Discovery mailbox. You can also place all contents in a mailbox on hold by not specifying a search query, which accomplishes similar results as Litigation Hold. -**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -59,9 +59,9 @@ The New-MailboxSearch cmdlet creates an In-Place eDiscovery search or an In-Plac By default, mailbox searches are performed across all Exchange 2013 or later Mailbox servers in an organization, unless you constrain the search to fewer mailboxes by using the SourceMailboxes parameter. To search mailboxes on Exchange 2010 Mailbox servers, run the command on an Exchange 2010 server. -For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/holds/holds). +For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/holds/holds). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -84,14 +84,14 @@ This example creates the mailbox search Legal-ProjectX. The search uses several New-MailboxSearch -Name "Hold-ProjectX" -SourceMailboxes DG-Finance -InPlaceHoldEnabled $true ``` -This example creates an In-Place Hold Hold-ProjectX and places all members of the distribution group DG-Finance on hold. Because the search doesn't specify the SearchQuery and ItemHoldPeriod parameters, all messages in mailboxes returned are placed on indefinite In-Place Hold. +This example creates an In-Place Hold named Hold-ProjectX and places all members of the distribution group DG-Finance on hold. Because the search doesn't specify the SearchQuery and ItemHoldPeriod parameters, all messages in mailboxes returned are placed on indefinite In-Place Hold. ### Example 3 ```powershell New-MailboxSearch -Name "Hold-tailspintoys" -SourceMailboxes DG-Research -SearchQuery '"Patent" AND "Project tailspintoys"' -InPlaceHoldEnabled $true ``` -This example creates an In-Place Hold Hold-tailspintoys and places all members of the distribution group DG-Research on hold. Because the search specifies the SearchQuery parameter, only messages that match the search query are placed on indefinite In-Place Hold. +This example creates an In-Place Hold named Hold-tailspintoys and places all members of the distribution group DG-Research on hold. Because the search specifies the SearchQuery parameter, only messages that match the search query are placed on indefinite In-Place Hold. ### Example 4 ```powershell @@ -168,7 +168,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -214,7 +214,9 @@ Accept wildcard characters: False ### -DoNotIncludeArchive This parameter is available only in Exchange Server 2010. -The DoNotIncludeArchive parameter specifies whether archive mailboxes are included in the search. By default, archive mailboxes are included in the search. To exclude archive mailboxes, set the DoNotIncludeArchive parameter to $true. +The DoNotIncludeArchive switch specifies that archive mailboxes are not included in the search. You don't need to specify a value with this switch. + +By default, archive mailboxes are included in the search. To exclude archive mailboxes, use this switch. ```yaml Type: SwitchParameter @@ -232,7 +234,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -285,7 +287,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -348,7 +352,7 @@ If you attempt to place a hold but don't specify mailboxes using the SourceMailb Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -383,7 +387,7 @@ The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -395,7 +399,7 @@ Accept wildcard characters: False ### -Language The Language parameter specifies a locale for the search. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -480,9 +484,9 @@ Accept wildcard characters: False ### -SearchDumpster This parameter is available only in Exchange Server 2010. -The SearchDumpster parameter specifies whether the dumpster is searched. The dumpster is a storage area in the mailbox where deleted items are temporarily stored after being deleted or removed from the Deleted Items folder, or after being hard-deleted and before being purged from the mailbox based on Deleted Item Retention settings. +The SearchDumpster switch specifies whether the dumpster is searched. You don't need to specify a value with this switch. -By default, items in the dumpster are searched. Set the value to $false to disable searching the dumpster. +The dumpster is a storage area in the mailbox where deleted items are temporarily stored after being deleted or removed from the Deleted Items folder, or after being hard-deleted and before being purged from the mailbox based on Deleted Item Retention settings. ```yaml Type: SwitchParameter @@ -498,7 +502,7 @@ Accept wildcard characters: False ``` ### -SearchQuery -The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). If you use this parameter with other search query parameters, the query combines these parameters by using the AND operator. @@ -578,7 +582,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -652,7 +656,7 @@ The WhatIf switch doesn't work on this cmdlet. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -666,12 +670,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md index b3f09cf565..0dd0822a20 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-malwarefilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-malwarefilterpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-MalwareFilterPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MalwareFilterPolicy cmdlet to create malware filter policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,8 +42,10 @@ New-MalwareFilterPolicy [-Name] [-EnableInternalSenderAdminNotifications ] [-EnableInternalSenderNotifications ] [-ExternalSenderAdminAddress ] + [-FileTypeAction ] [-FileTypes ] [-InternalSenderAdminAddress ] + [-QuarantineTag ] [-RecommendedPolicyType ] [-WhatIf] [-ZapEnabled ] @@ -53,7 +55,7 @@ New-MalwareFilterPolicy [-Name] ## DESCRIPTION New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the MalwareFilterPolicy parameter on the New-MalwareFilterRule or Set-MalwareFilterRule cmdlets to associate the policy with a rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,14 +66,13 @@ New-MalwareFilterPolicy -Name "Contoso Malware Filter Policy" -EnableInternalSen This example creates a new malware filter policy named Contoso Malware Filter Policy with the following settings: -- Block messages that contain malware. -- Don't notify the message sender when malware is detected in the message. +- Block messages that contain malware in on-premises Exchange, or quarantine the message in Exchange Online. - Notify the administrator admin@contoso.com when malware is detected in a message from an internal sender. ## PARAMETERS ### -Name -The Name parameter specifies a name for the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies the unique name of the malware filter policy. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String @@ -87,17 +88,19 @@ Accept wildcard characters: False ``` ### -Action +This parameter is available only in on-premises Exchange. + The Action parameter specifies the action to take when malware is detected in a message. Valid values are: -- DeleteMessage: Handles the message without notifying the recipients. This is the default value. In Exchange Server, the message is deleted. In the cloud-based service, the message is quarantined. -- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. In the cloud-based service, the message with the original attachments is also quarantined. -- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. In the cloud-based service, the message with the original attachments is also quarantined. +- DeleteMessage: Handles the message without notifying the recipients. This is the default value. +- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. +- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. ```yaml Type: MalwareFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,15 +187,17 @@ Accept wildcard characters: False ``` ### -CustomAlertText +This parameter is available only in on-premises Exchange. + The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the Action parameter value is ReplaceWithCustomAlert. +This parameter is meaningful only when the value of the Action parameter is DeleteAttachmentAndUseCustomAlert. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -202,9 +207,9 @@ Accept wildcard characters: False ``` ### -CustomExternalBody -The CustomExternalBody parameter specifies the body of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomExternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -223,9 +228,9 @@ Accept wildcard characters: False ``` ### -CustomExternalSubject -The CustomExternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomExternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -244,9 +249,9 @@ Accept wildcard characters: False ``` ### -CustomFromAddress -The CustomFromAddress parameter specifies the From address of the custom notification message for malware detections in messages from internal or external senders. +The CustomFromAddress parameter specifies the custom From address to use in notification messages for malware detections in messages from internal or external senders. -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -267,9 +272,9 @@ Accept wildcard characters: False ``` ### -CustomFromName -The CustomFromName parameter specifies the From name of the custom notification message for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomFromName parameter specifies the custom From name to use in notification messages for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -290,9 +295,9 @@ Accept wildcard characters: False ``` ### -CustomInternalBody -The CustomInternalBody parameter specifies the body of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomInternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableInternalSenderAdminNotifications - EnableInternalSenderNotifications @@ -311,9 +316,9 @@ Accept wildcard characters: False ``` ### -CustomInternalSubject -The CustomInternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomInternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableInternalSenderAdminNotifications - EnableInternalSenderNotifications @@ -332,10 +337,17 @@ Accept wildcard characters: False ``` ### -CustomNotifications -The CustomNotifications parameter enables or disables custom notification messages for malware detections in messages from internal or external senders. Valid values are: +The CustomNotifications parameter enables or disables the customization of notification messages for malware detections. Valid values are: -- $true: When malware is detected in a message, a custom notification message is sent to the message sender. You specify the details of message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. -- $false: Custom notifications to the original message sender are disabled. This is the default value. Default notification messages are sent if the EnableExternalSenderNotifications and EnableInternalSenderNotifications parameters are set to $true. +- $true: Replace the default values used in notification messages with the values of the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. +- $false: No customization is done to notification messages. The default values are used. + +This parameter is meaningful only when the value of at least one of the following parameters is also $true: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications ```yaml Type: Boolean @@ -369,10 +381,12 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderAdminNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from external senders. Valid values are: +The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: -- $true: When malware is detected in messages from external senders, send notification messages to the email address that's specified by the ExternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. -- $false: When malware is detected in messages from external senders, don't send administrator notifications. This is the default value. +- $true: When malware attachments are detected in messages from external senders, a notification messages is sent to the email address that's specified by the ExternalSenderAdminAddress parameter. +- $false: Notifications aren't sent for malware attachment detections in messages from external senders. This is the default value. + +**Note**: Admin notifications are sent only for _attachments_ that are classified as malware. ```yaml Type: Boolean @@ -388,16 +402,18 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderNotifications -The EnableExternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from external senders. Valid values are: +This parameter is available only in on-premises Exchange. -- $true: When malware is detected in a message from an external sender, send them a notification message. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. +The EnableExternalSenderNotifications parameter enables or disables sending notification messages to external senders for malware detections in their messages. Valid values are: + +- $true: When malware is detected in a message from an external sender, send them a notification message. - $false: Don't send malware detection notification messages to external message senders. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -409,10 +425,14 @@ Accept wildcard characters: False ### -EnableFileFilter This parameter is available only in the cloud-based service. -The EnableFileFilter parameter enables or disables common attachment blocking (also known as the Common Attachment Types Filter). Valid values are: +The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: + +- $true: The common attachments filter is enabled. This is the default value. +- $false: The common attachments filter is disabled. -- $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. -- $false: Common attachment blocking is disabled. This is the default value. +You specify the file types using the FileTypes parameter. A default list of values is automatically provided, but you can customize it. + +You specify the action for detected files using the FileTypeAction parameter. ```yaml Type: Boolean @@ -428,10 +448,12 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications -The EnableInternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from internal senders. Valid values are: +The EnableInternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: + +- $true: When malware attachments are detected in messages from internal senders, a notification messages is sent to the email address that's specified by the InternalSenderAdminAddress parameter. +- $false: Notifications aren't sent for malware attachment detections in messages from internal senders. This is the default value. -- $true: When malware is detected in messages from internal senders, send notification messages to the email address that's specified by the InternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. -- $false: When malware is detected in messages from internal senders, don't send administrator notifications. This is the default value. +**Note**: Admin notifications are sent only for _attachments_ that are classified as malware. ```yaml Type: Boolean @@ -447,16 +469,18 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderNotifications -The EnableInternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from internal senders. Valid values are: +This parameter is available only in on-premises Exchange. + +The EnableInternalSenderNotifications parameter enables or disables sending notification messages to internal senders for malware detections in their messages. Valid values are: -- $true: When malware is detected in a message from an internal sender, send them a notification message. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. +- $true: When malware is detected in a message from an internal sender, send them a notification message. - $false: Don't send malware detection notification messages to internal message senders. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -466,7 +490,9 @@ Accept wildcard characters: False ``` ### -ExternalSenderAdminAddress -The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notifications messages when messages from external senders contain malware. Notification messages are sent to the specified email address only if the EnableExternalSenderAdminNotifications parameter is set to $true. +The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. + +This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. ```yaml Type: SmtpAddress @@ -481,25 +507,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FileTypeAction +This parameter is available only in the cloud-based service. + +The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: + +- Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the malware filter policy by the QuarantineTag parameter. +- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. + +This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. + +```yaml +Type: FileTypeFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FileTypes This parameter is available only in the cloud-based service. -The FileTypes parameter specifies the file types that are automatically blocked by common attachment blocking (also known as the Common Attachment Types Filter), regardless of content. The default values are: +The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: -- .ace -- .ani -- .app -- .docm -- .exe -- .jar -- .reg -- .scr -- .vbe -- .vbs +`ace, ani, apk, app, appx, arj, bat, cab, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, iso, jar, jnlp, kext, lha, lib, library, lnk, lzh, macho, msc, msi, msix, msp, mst, pif, ppa, ppam, reg, rev, scf, scr, sct, sys, uif, vb, vbe, vbs, vxd, wsc, wsf, wsh, xll, xz, z` -You enable or disable common attachment blocking by using the EnableFileFilter parameter. +This parameter is meaningful only if the value of the EnableFileFilter parameter is $true. -Common attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. +The common attachments filter uses best effort true-typing to detect the file type regardless of the file name extension. For example, an exe file renamed to txt is detected as an exe file. If true-typing fails or isn't supported for the specified file type, then extension matching is used. To replace the existing list of file types with the values you specify, use the syntax `FileType1,FileType2,...FileTypeN`. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. @@ -519,9 +559,9 @@ Accept wildcard characters: False ``` ### -InternalSenderAdminAddress -The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from internal senders. +The InternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from internal senders. -This parameter is only meaningful if the EnableInternalSenderAdminNotifications parameter value is $true. +This parameter is meaningful only if the value of the EnableInternalSenderAdminNotifications parameter is $true. ```yaml Type: SmtpAddress @@ -536,10 +576,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -QuarantineTag +This parameter is available only in the cloud-based service. + +The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecommendedPolicyType This parameter is available only in the cloud-based service. -The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this parameter yourself. +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType @@ -596,12 +664,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md b/exchange/exchange-ps/exchange/New-MalwareFilterRule.md index 516294b74f..ad4f6ad019 100644 --- a/exchange/exchange-ps/exchange/New-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/New-MalwareFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-malwarefilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-MalwareFilterRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MalwareFilterRule cmdlet to create malware filter rules in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,10 @@ New-MalwareFilterRule [-Name] -MalwareFilterPolicy [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Anti-malware policies](https://learn.microsoft.com/defender-office-365/anti-malware-protection-about#anti-malware-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,41 +54,41 @@ This example creates a new malware filter rule named Contoso Recipients with the ## PARAMETERS -### -MalwareFilterPolicy -The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule rule. - -You can use any value that uniquely identifies the policy. For example: - -- Name -- Distinguished name (DN) -- GUID. - -You can't specify the default malware filter policy, and you can't specify a policy that's already associated with another malware filter rule. +### -Name +The Name parameter specifies a unique name for the malware filter rule. ```yaml -Type: MalwareFilterPolicyIdParameter +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the malware filter rule. +### -MalwareFilterPolicy +The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule. + +You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID. + +You can't specify the default malware filter policy, and you can't specify a policy that's already associated with another malware filter rule. ```yaml -Type: String +Type: MalwareFilterPolicyIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -161,7 +164,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -202,7 +205,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -253,7 +256,7 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -294,7 +297,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -341,12 +344,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md b/exchange/exchange-ps/exchange/New-ManagedContentSettings.md index 7367837e15..1d10f3fbcb 100644 --- a/exchange/exchange-ps/exchange/New-ManagedContentSettings.md +++ b/exchange/exchange-ps/exchange/New-ManagedContentSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-managedcontentsettings +online version: https://learn.microsoft.com/powershell/module/exchange/new-managedcontentsettings applicable: Exchange Server 2010 title: New-ManagedContentSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the New-ManagedContentSettings cmdlet to create managed content settings for managed folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,9 +43,9 @@ Managed content settings are settings that you associate with managed folders to - By controlling content retention and removing content that's no longer needed. - By automatically journaling important content to a separate storage location outside the mailbox. -For more information about managed content settings, see [Messaging Records Management](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb123507(v=exchg.141)). +For more information about managed content settings, see [Messaging Records Management](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123507(v=exchg.141)). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -65,6 +65,22 @@ This example creates managed content settings CS-Exec-Calendar for the Calendar ## PARAMETERS +### -Name +The Name parameter specifies a unique name for the managed content settings. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FolderName The FolderName parameter specifies the name or GUID of the managed folder to which the managed content settings apply. @@ -123,22 +139,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the managed content settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AddressForJournaling The AddressForJournaling parameter specifies the journaling recipient where journaled messages are sent. You can use any value that uniquely identifies the recipient. For example: @@ -370,12 +370,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ManagedFolder.md b/exchange/exchange-ps/exchange/New-ManagedFolder.md index b1ddbe64a2..da5d39bc23 100644 --- a/exchange/exchange-ps/exchange/New-ManagedFolder.md +++ b/exchange/exchange-ps/exchange/New-ManagedFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-managedfolder +online version: https://learn.microsoft.com/powershell/module/exchange/new-managedfolder applicable: Exchange Server 2010 title: New-ManagedFolder schema: 2.0.0 @@ -18,7 +18,7 @@ Use the New-ManagedFolder cmdlet to create a managed folder object for messaging This command doesn't accept pipelined input. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,15 +53,15 @@ New-ManagedFolder [-Name] -FolderName ## DESCRIPTION The New-ManagedFolder cmdlet creates a new managed folder in Active Directory. After a new managed folder object is created, the following steps need to be taken to use it for MRM: -- Create managed content settings for the folder. For information, see [Create Managed Content Settings](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/aa997968(v=exchg.141)). +- Create managed content settings for the folder. For information, see [Create Managed Content Settings](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/aa997968(v=exchg.141)). - Link the managed folder to an existing managed folder mailbox policy or create a managed folder mailbox policy and link the managed folder to it. - Apply a managed folder mailbox policy to a user's mailbox. For information, seeApply a Managed Folder Mailbox Policy to Users. -- Ensure the managed folder assistant is scheduled or run the managed folder assistant manually. For information about scheduling the managed folder assistant, see [Configure the Managed Folder Assistant](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb123958(v=exchg.141)). When the managed folder assistant runs, it configures default folders as managed and creates any managed custom folders in the user's mailbox with the settings specified. -- For more information about the steps to implement MRM in Microsoft Exchange Server 2010, see [Deploying Messaging Records Management](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb123548(v=exchg.141)). +- Ensure the managed folder assistant is scheduled or run the managed folder assistant manually. For information about scheduling the managed folder assistant, see [Configure the Managed Folder Assistant](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123958(v=exchg.141)). When the managed folder assistant runs, it configures default folders as managed and creates any managed custom folders in the user's mailbox with the settings specified. +- For more information about the steps to implement MRM in Microsoft Exchange Server 2010, see [Deploying Messaging Records Management](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123548(v=exchg.141)). By default, managed custom folders are created with this cmdlet. However, you can also create additional copies of managed default folders using the DefaultFolderType parameter to specify which type of default folder to create (for example, an additional Inbox folder). When you create multiple copies of a managed default folder, you can assign different content settings to each one. For example, you could have two Inbox folders, one named InboxSixMonths and another named InboxOneYear. Then, you could assign a retention time of six months to the first folder and one year to the second folder with the New-ManagedContentSettings cmdlet (or using the New Managed Content Settings wizard in the Exchange Management Console). You must assign a unique name (using the Name parameter) to each of the managed default folders that you create. Users, however, always see the unaltered default folder name. In the example, whether users are assigned an InboxSixMonths folder or an InboxOneYear folder, the Inbox that they see in their mailbox is labeled Inbox. Although the folder names that users see in their mailboxes can be reassigned for managed custom folders (using the Set-ManagedFolder command FolderName parameter), the folder names seen by users for managed default folders can't be changed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,6 +88,24 @@ This example creates an instance of the default folder Inbox. ## PARAMETERS +### -Name +The Name parameter specifies a unique name for the managed folder object in Active Directory. The name can have up to 65 characters. Whereas the FolderName parameter specifies the folder name as displayed to users in clients, the Name parameter is used by Exchange administration tools to represent the managed folder object. + +The Name parameter shouldn't be confused with the FolderName parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultFolderType The DefaultFolderType parameter specifies the type of default folder to create, such as Inbox or Deleted Items. @@ -147,24 +165,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the managed folder object in Active Directory. The name can have up to 65 characters. Whereas the FolderName parameter specifies the folder name as displayed to users in clients, the Name parameter is used by Exchange administration tools to represent the managed folder object. - -The Name parameter shouldn't be confused with the FolderName parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -BaseFolderOnly The BaseFolderOnly parameter specifies whether the managed content settings should be applied only to the managed folder or to the folder and all its subfolders. @@ -317,12 +317,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md index 0c8231c451..0a4c872b09 100644 --- a/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-ManagedFolderMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-managedfoldermailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-managedfoldermailboxpolicy applicable: Exchange Server 2010 title: New-ManagedFolderMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the New-ManagedFolderMailboxPolicy cmdlet to create a managed folder mailbox policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ New-ManagedFolderMailboxPolicy [-Name] ## DESCRIPTION Managed folder mailbox policies are applied to user mailboxes to control message retention settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). Managed custom folders are a premium feature of messaging records management (MRM). Mailboxes with policies that include managed custom folders require an Exchange Server Enterprise client access license (CAL). @@ -135,12 +135,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ManagementRole.md b/exchange/exchange-ps/exchange/New-ManagementRole.md index 32d48d4340..84f1b34a67 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRole.md +++ b/exchange/exchange-ps/exchange/New-ManagementRole.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-managementrole +online version: https://learn.microsoft.com/powershell/module/exchange/new-managementrole applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-ManagementRole schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-ManagementRole cmdlet to create a management role based on an existing role or create an unscoped management role. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,19 +49,20 @@ You can either create a management role based on an existing role, or you can cr An unscoped role doesn't have any scope restrictions applied. Scripts or third-party cmdlets included in an unscoped role can view or modify any object in the Exchange organization. -The ability to create an unscoped management role isn't granted by default. To create an unscoped management role, you must assign the Unscoped Role Management management role to a role group you're a member of. For more information about how to create an unscoped management role, see [Create an unscoped role](https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). +The ability to create an unscoped management role isn't granted by default. To create an unscoped management role, you must assign the management role named Unscoped Role Management to a role group you're a member of. For more information about how to create an unscoped management role, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). After you create a role, you can change the management role entries on the role and assign the role with a management scope to a user or universal security group (USG). -For more information about management roles, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about management roles, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell New-ManagementRole -Name "Redmond Journaling View-Only" -Parent Journaling + Get-ManagementRoleEntry "Redmond Journaling View-Only\*" | Where { $_.Name -NotLike "Get*" } | %{Remove-ManagementRoleEntry -Identity "$($_.id)\$($_.name)"} ``` @@ -71,8 +72,8 @@ After the role is created, the Remove-ManagementRoleEntry cmdlet is used along w For more information about pipelining and the Where cmdlet, see the following topics: -- [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) -- [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help) +- [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) +- [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help) ### Example 2 ```powershell @@ -116,13 +117,13 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. +This parameter is available only in on-premises Exchange. -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). The UnScopedTopLevel switch specifies that the role new role is an unscoped top-level management role (a custom, empty role). You don't need to specify a value with this switch. -You can only add custom scripts or non-Exchange cmdlets to an unscoped top-level management role. For more information, see [Create an unscoped role](https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). You can't use this switch with the Parent parameter. @@ -213,7 +214,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -249,12 +252,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md index 5fc8e0b274..9cd0581b13 100644 --- a/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/New-ManagementRoleAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-managementroleassignment +online version: https://learn.microsoft.com/powershell/module/exchange/new-managementroleassignment applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-ManagementRoleAssignment schema: 2.0.0 @@ -16,10 +16,22 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-ManagementRoleAssignment cmdlet to assign a management role to a management role group, management role assignment policy, user, or universal security group (USG). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### App +``` +New-ManagementRoleAssignment [[-Name] ] -Role -App [-CustomResourceScope ] + [-Confirm] + [-Delegating] + [-Force] + [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] + [-WhatIf] + [] +``` + ### Computer ``` New-ManagementRoleAssignment [[-Name] ] -Computer -Role @@ -29,7 +41,9 @@ New-ManagementRoleAssignment [[-Name] ] -Computer [-DomainController ] [-ExclusiveConfigWriteScope ] [-ExclusiveRecipientWriteScope ] + [-Force] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientRelativeWriteScope ] [-UnScopedTopLevel] @@ -48,6 +62,7 @@ New-ManagementRoleAssignment [[-Name] ] -Policy ] [-Force] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientRelativeWriteScope ] [-UnScopedTopLevel] @@ -67,6 +82,7 @@ New-ManagementRoleAssignment [[-Name] ] -Role -Securit [-ExclusiveRecipientWriteScope ] [-Force] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientRelativeWriteScope ] [-UnScopedTopLevel] @@ -86,6 +102,7 @@ New-ManagementRoleAssignment [[-Name] ] -Role -User ] [-Force] [-RecipientAdministrativeUnitScope ] + [-RecipientGroupScope ] [-RecipientOrganizationalUnitScope ] [-RecipientRelativeWriteScope ] [-UnScopedTopLevel] @@ -98,9 +115,9 @@ When you add a new role assignment, you can specify a built-in or custom role th You can create custom management scopes using the New-ManagementScope cmdlet and can view a list of existing scopes using the Get-ManagementScope cmdlet. If you choose not to specify an OU, or predefined or custom scope, the implicit write scope of the role applies to the role assignment. -For more information about management role assignments, see [Understanding management role assignments](https://docs.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). +For more information about management role assignments, see [Understanding management role assignments](https://learn.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,6 +131,7 @@ This example assigns the Mail Recipients role to the Tier 2 Help Desk role group ### Example 2 ```powershell Get-ManagementRole "MyVoiceMail" | Format-Table Name, IsEndUserRole + New-ManagementRoleAssignment -Role "MyVoiceMail" -Policy "Sales end-users" ``` @@ -174,12 +192,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -App +This parameter is available only in the cloud-based service. + +The App parameter specifies the service principal to assign the management role to. Specifically, the ObjectId GUID value from the output of the Get-ServicePrincipal cmdlet (for example, 6233fba6-0198-4277-892f-9275bf728bcc). + +For more information about service principals, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +You can't use this parameter with the SecurityGroup, Policy, or User cmdlets. + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: App +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Computer This parameter is available only in on-premises Exchange. The Computer parameter specifies the name of the computer to assign the management role to. -If you specify the Computer parameter, you can't specify the SecurityGroup, User, or Policy parameters. +You can't use this parameter with the SecurityGroup, User, or Policy parameters. ```yaml Type: ComputerIdParameter @@ -195,11 +235,11 @@ Accept wildcard characters: False ``` ### -Policy -The Policy parameter specifies the name of the management role assignment policy to assign the management role to. +The Policy parameter specifies the name of the management role assignment policy to assign the management role to. If the value contains spaces, enclose the value in quotation marks ("). The IsEndUserRole property of the role you specify using the Role parameter must be set to $true. -If you specify the Policy parameter, you can't specify the SecurityGroup, Computer, or User parameters. If the policy name contains spaces, enclose the name in quotation marks ("). +You can't use this parameter with the App, SecurityGroup, Computer, or User parameters. ```yaml Type: MailboxPolicyIdParameter @@ -215,7 +255,15 @@ Accept wildcard characters: False ``` ### -Role -The Role parameter specifies the existing role to assign. If the role name contains spaces, enclose the name in quotation marks ("). +The Role parameter specifies the existing role to assign. You can use any value that uniquely identifies the role. For example: + +- Name +- Distinguished name (DN) +- GUID + +If the value contains spaces, enclose the value in quotation marks ("). + +If you use the App parameter, you can't specify admin or user roles; you can only specify application roles (for example, "Application Mail.Read"). ```yaml Type: RoleIdParameter @@ -231,9 +279,9 @@ Accept wildcard characters: False ``` ### -SecurityGroup -The SecurityGroup parameter specifies the name of the management role group or universal USG to assign the management role to. +The SecurityGroup parameter specifies the name of the management role group or mail-enabled universal security group to assign the management role to. If the value contains spaces, enclose the value in quotation marks ("). -If you specify the SecurityGroup parameter, you can't specify the Policy, Computer, or User parameters. If the role group or USG name contains spaces, enclose the name in quotation marks ("). +You can't use this parameter with the App, Policy, Computer, or User parameters. ```yaml Type: SecurityGroupIdParameter @@ -249,9 +297,14 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the name or alias of the user to assign the management role to. +The User parameter specifies the user to assign the management role to. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. -If you specify the User parameter, you can't specify the SecurityGroup, Computer, or Policy parameters. If the value contains spaces, enclose the name in quotation marks ("). +You can't use this parameter with the App, SecurityGroup, Computer, or Policy parameters. ```yaml Type: UserIdParameter @@ -292,7 +345,7 @@ The CustomConfigWriteScope parameter specifies the existing configuration scope ```yaml Type: ManagementScopeIdParameter -Parameter Sets: (All) +Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -308,7 +361,7 @@ The CustomRecipientWriteScope parameter specifies the existing recipient-based m ```yaml Type: ManagementScopeIdParameter -Parameter Sets: (All) +Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection @@ -319,12 +372,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CustomResourceScope +This parameter is available only in the cloud-based service. + +The CustomResourceScope parameter specifies the custom management scope to associate with this management role assignment. You can use any value that uniquely identifies the management scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +If the value contains spaces, enclose the value in quotation marks ("). + +You use this parameter with the App parameter to assign permissions to service principals. For more information, see For more information about service principals, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +```yaml +Type: ManagementScopeIdParameter +Parameter Sets: App +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Delegating -The Delegating parameter specifies whether the user or USG assigned to the role can delegate the role to other users or groups. You don't have to specify a value with the Delegating parameter. +The Delegating switch specifies whether the user or USG assigned to the role can delegate the role to other users or groups. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter -Parameter Sets: SecurityGroup, User +Parameter Sets: SecurityGroup, User, App Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection @@ -342,7 +421,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -360,7 +439,7 @@ The ExclusiveConfigWriteScope parameter specifies the exclusive configuration-ba ```yaml Type: ManagementScopeIdParameter -Parameter Sets: (All) +Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -376,7 +455,7 @@ The ExclusiveRecipientWriteScope parameter specifies the exclusive recipient-bas ```yaml Type: ManagementScopeIdParameter -Parameter Sets: (All) +Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection @@ -390,11 +469,13 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter -Parameter Sets: Policy, SecurityGroup, User +Parameter Sets: (All) Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -406,9 +487,11 @@ Accept wildcard characters: False ``` ### -RecipientAdministrativeUnitScope +This parameter is functional only in the cloud-based service. + The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the new role assignment to. -Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. +Administrative units are Microsoft Entra containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. ```yaml Type: AdministrativeUnitIdParameter @@ -423,12 +506,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RecipientGroupScope +This parameter is available only in the cloud-based service. + +The RecipientGroupScope parameter specifies a group to consider for scoping the role assignment. Individual members of the specified group (not nested groups) are considered as in scope for the assignment. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, or DisplayName. + +```yaml +Type: GroupIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientOrganizationalUnitScope The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope or ExclusiveRecipientWriteScope parameters. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). ```yaml Type: OrganizationalUnitIdParameter -Parameter Sets: (All) +Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection @@ -446,7 +547,7 @@ Even though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExec ```yaml Type: RecipientWriteScopeType -Parameter Sets: (All) +Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection @@ -460,15 +561,15 @@ Accept wildcard characters: False ### -UnScopedTopLevel This parameter is available only in on-premises Exchange. -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top-level management role. You don't need to specify a value with this switch. -Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Computer, Policy, SecurityGroup, User Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -500,12 +601,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ManagementScope.md b/exchange/exchange-ps/exchange/New-ManagementScope.md index 9b62c15ca0..c2fcc0e2d9 100644 --- a/exchange/exchange-ps/exchange/New-ManagementScope.md +++ b/exchange/exchange-ps/exchange/New-ManagementScope.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-managementscope +online version: https://learn.microsoft.com/powershell/module/exchange/new-managementscope applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-ManagementScope schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-ManagementScope cmdlet to create a regular or exclusive management scope. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -77,11 +77,11 @@ New-ManagementScope [-Name] -ServerRestrictionFilter ``` ## DESCRIPTION -After you create a regular or exclusive scope, you need to associate the scope with a management role assignment. To associate a scope with a role assignment, use the New-ManagementRoleAssignment cmdlet. For more information about adding new management scopes, see [Create a regular or exclusive scope](https://docs.microsoft.com/exchange/create-a-regular-or-exclusive-scope-exchange-2013-help). +After you create a regular or exclusive scope, you need to associate the scope with a management role assignment. To associate a scope with a role assignment, use the New-ManagementRoleAssignment cmdlet. For more information about adding new management scopes, see [Create a regular or exclusive scope](https://learn.microsoft.com/exchange/create-a-regular-or-exclusive-scope-exchange-2013-help). -For more information about regular and exclusive scopes, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +For more information about regular and exclusive scopes, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,7 +97,7 @@ This example creates a scope that includes only the servers MailboxServer1, Mail New-ManagementScope -Name "Redmond Site Scope" -ServerRestrictionFilter "ServerSite -eq 'CN=Redmond,CN=Sites,CN=Configuration,DC=contoso,DC=com'" ``` -This example creates the Redmond Site Scope scope and sets a server restriction filter that matches only the servers located in the "CN=Redmond,CN=Sites,CN=Configuration,DC=contoso,DC=com" Active Directory Domain Services (AD DS) site. +This example creates the scope named Redmond Site Scope and sets a server restriction filter that matches only the servers located in the "CN=Redmond,CN=Sites,CN=Configuration,DC=contoso,DC=com" Active Directory Domain Services (AD DS) site. ### Example 3 ```powershell @@ -109,6 +109,7 @@ This example creates the Executive Mailboxes scope. Only mailboxes located withi ### Example 4 ```powershell New-ManagementScope -Name "Protected Exec Users" -RecipientRestrictionFilter "Title -like 'VP*'" -Exclusive + New-ManagementRoleAssignment -SecurityGroup "Executive Administrators" -Role "Mail Recipients" -CustomRecipientWriteScope "Protected Exec Users" ``` @@ -170,16 +171,16 @@ Accept wildcard characters: False ### -DatabaseRestrictionFilter This parameter is available only in on-premises Exchange. -The DatabaseRestrictionFilter parameter uses OPath filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. +The DatabaseRestrictionFilter parameter uses OPATH filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For a list of filterable database properties, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For a list of filterable database properties, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter with the RecipientRestrictionFilter, ServerRestrictionFilter, RecipientRoot, DatabaseList, or ServerList parameters. @@ -197,16 +198,16 @@ Accept wildcard characters: False ``` ### -RecipientRestrictionFilter -The RecipientRestrictionFilter parameter uses OPath filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. +The RecipientRestrictionFilter parameter uses OPATH filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. @@ -253,16 +254,16 @@ Accept wildcard characters: False ### -ServerRestrictionFilter This parameter is available only in on-premises Exchange. -The ServerRestrictionFilter parameter uses OPath filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. +The ServerRestrictionFilter parameter uses OPATH filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For a list of filterable server properties, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For a list of filterable server properties, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter wit the RecipientRestrictionFilter, RecipientRoot, DatabaseRestrictionFilter, DatabaseList, or ServerList parameters. @@ -317,7 +318,7 @@ Accept wildcard characters: False ``` ### -Exclusive -The Exclusive switch specifies that the role should be an exclusive scope. +The Exclusive switch specifies that the role should be an exclusive scope. You don't need to specify a value with this switch. When you create exclusive management scopes, only users or universal security groups (USG) assigned exclusive scopes that contain objects to be modified can access those objects. Users or USGs that aren't assigned an exclusive scope that contains the objects immediately lose access to those objects. @@ -335,7 +336,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies that an exclusive scope should be created without showing the warning that the exclusive scope takes effect immediately. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to create an exclusive scope without showing the warning that the exclusive scope takes effect immediately. ```yaml Type: SwitchParameter @@ -394,14 +397,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES +Use two-letter country codes (ISO 3166-1 alpha-2) instead of the full country name in filters. For example, use `-RecipientRestrictionFilter "UsageLocation -eq 'FR'"` for France. ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md index fdaa9a8f79..54765cae91 100644 --- a/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-MapiVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mapivirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/new-mapivirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-MapiVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-MapiVirtualDirectory cmdlet to create Messaging Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ New-MapiVirtualDirectory ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,8 +90,6 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags -This parameter is available only in Exchange Server 2013. - The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -104,7 +102,7 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -114,8 +112,6 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList -This parameter is available only in Exchange Server 2013. - The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -125,7 +121,7 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,8 +131,6 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking -This parameter is available only in Exchange 2013. - The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -149,7 +143,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,7 +184,7 @@ You can specify multiple values separated by commas. The default values are NTLM, OAuth, and Negotiate. We recommend that you always have the virtual directory configured for OAuth. -For more information about the different authentication methods, see [Understanding HTTP Authentication](https://docs.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication) and [What is OAuth authentication?](https://docs.microsoft.com/exchange/using-oauth-authentication-to-support-ediscovery-in-an-exchange-hybrid-deployment-exchange-2013-help#what-is-oauth-authentication). +For more information about the different authentication methods, see [Understanding HTTP Authentication](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication) and [What is OAuth authentication?](https://learn.microsoft.com/exchange/using-oauth-authentication-to-support-ediscovery-in-an-exchange-hybrid-deployment-exchange-2013-help#what-is-oauth-authentication). ```yaml Type: MultiValuedProperty @@ -306,12 +300,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MessageClassification.md b/exchange/exchange-ps/exchange/New-MessageClassification.md index 45e7ec6d60..2692993652 100644 --- a/exchange/exchange-ps/exchange/New-MessageClassification.md +++ b/exchange/exchange-ps/exchange/New-MessageClassification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-messageclassification +online version: https://learn.microsoft.com/powershell/module/exchange/new-messageclassification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MessageClassification schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MessageClassification cmdlet to create a message classification instance in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,7 +49,7 @@ After you create a new message classification, you can specify the message class When you create a message classification, it has no locale. By default, the new message classification is used for all locales. After a default message classification is defined, you can add new locales of the classification by running the New-MessageClassification cmdlet and by specifying the default message classification identity that you want to localize. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -107,11 +107,11 @@ Accept wildcard characters: False ``` ### -Locale -This parameter is available or functional on in on-premises Exchange. +This parameter is functional on in on-premises Exchange. The Locale parameter specifies a locale-specific version of an existing message classification. You use the -Name parameter to identify the existing message classification, and the SenderDescription parameter to specify the descriptive text in another language. -A valid value for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class (for example, da-DK for Danish or ja-JP for Japanese). For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +A valid value for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class (for example, da-DK for Danish or ja-JP for Japanese). For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -127,7 +127,7 @@ Accept wildcard characters: False ``` ### -SenderDescription -The SenderDescription parameter specifies the the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). +The SenderDescription parameter specifies the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String @@ -247,7 +247,7 @@ Accept wildcard characters: False ``` ### -RecipientDescription -The RecipientDescription parameter specifies the the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). +The RecipientDescription parameter specifies the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). If you don't use this parameter, the value of the SenderDescription parameter is used. @@ -303,12 +303,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MigrationBatch.md b/exchange/exchange-ps/exchange/New-MigrationBatch.md index 85c9da60a2..e17cdd2090 100644 --- a/exchange/exchange-ps/exchange/New-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/New-MigrationBatch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-migrationbatch +online version: https://learn.microsoft.com/powershell/module/exchange/new-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MigrationBatch schema: 2.0.0 @@ -16,55 +16,176 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MigrationBatch cmdlet to submit a new migration request for a batch of users. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### Onboarding +### Abch ``` -New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [-WorkflowControlFlags ] +New-MigrationBatch -Name -CSVData [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-Locale ] + [-NotificationEmails ] + [-ReportInterval ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TargetDatabases ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Analysis +``` +New-MigrationBatch -Name -CSVData [-Analyze] + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-ExcludeFolders ] + [-IncludeFolders ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipDetails] + [-SkipReports] + [-SourceEndpoint ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### FolderMove +``` +New-MigrationBatch -Name -CSVData + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-LargeItemLimit ] + [-MoveOptions ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### GoogleResourceOnboarding +``` +New-MigrationBatch -Name -CSVData + [-AdoptPreexisting] + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-GoogleResource] + [-NotificationEmails ] + [-Partition ] + [-RemoveOnCopy] + [-ReportInterval ] + [-SkipDelegates] + [-SkipMerging ] + [-SkipProvisioning] + [-SkipReports] + [-SourceEndpoint ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Local +``` +New-MigrationBatch [-Local] -Name -CSVData [-DisallowExistingUsers] [-WorkloadType ] [-WorkflowControlFlags ] [-AdoptPreexisting] [-AllowIncrementalSyncs ] [-AllowUnknownColumnsInCsv ] - [-ArchiveDomain ] [-ArchiveOnly] [-AutoComplete] [-AutoRetryCount ] [-AutoStart] - [-AvoidMergeOverlap] [-BadItemLimit ] [-CompleteAfter ] - [-ContentFilter ] - [-ContentFilterLanguage ] [-Confirm] [-DomainController ] - [-ExcludeDumpsters] - [-ExcludeFolders ] - [-ForwardingDisposition ] - [-IncludeFolders ] - [-LargeItemLimit ] [-Locale ] [-MoveOptions ] [-NotificationEmails ] [-Partition ] [-PrimaryOnly] [-RemoveOnCopy] - [-RenamePrimaryCalendar] [-ReportInterval ] - [-SkipCalendar] - [-SkipContacts] - [-SkipMail] - [-SkipMerging ] [-SkipMoving ] [-SkipReports] - [-SkipRules] [-SkipSteps ] - [-SourceEndpoint ] - [-SourcePFPrimaryMailboxGuid ] [-StartAfter ] [-TargetArchiveDatabases ] [-TargetDatabases ] - [-TargetDeliveryDomain ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### LocalPublicFolder +``` +New-MigrationBatch -Name -CSVData -SourcePublicFolderDatabase + [-AllowIncrementalSyncs ] + [-AllowUnknownColumnsInCsv ] + [-AutoComplete] + [-AutoRetryCount ] + [-AutoStart] + [-BadItemLimit ] + [-CompleteAfter ] + [-Confirm] + [-DomainController ] + [-LargeItemLimit ] + [-Locale ] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipMerging ] + [-SkipReports] + [-SkipSteps ] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### ManagedGmailTeams +``` +New-MigrationBatch -Name -CSVData [-ManagedGmailTeams] + [-AdoptPreexisting] + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-NotificationEmails ] + [-Partition ] + [-RemoveOnCopy] + [-ReportInterval ] + [-SkipCalendar] + [-SkipContacts] + [-SkipReports] + [-SourceEndpoint ] + [-StartAfter ] [-TimeZone ] [-WhatIf] [] @@ -107,56 +228,116 @@ New-MigrationBatch -Name -CSVData [-DisallowExistingUsers] [] ``` -### Local +### Onboarding ``` -New-MigrationBatch [-Local] -Name -CSVData [-DisallowExistingUsers] [-WorkloadType ] [-WorkflowControlFlags ] +New-MigrationBatch -Name [-CSVData ] [-DisallowExistingUsers] [-WorkflowControlFlags ] [-AdoptPreexisting] [-AllowIncrementalSyncs ] [-AllowUnknownColumnsInCsv ] + [-ArchiveDomain ] [-ArchiveOnly] [-AutoComplete] + [-AutoProvisioning] [-AutoRetryCount ] [-AutoStart] + [-AvoidMergeOverlap] [-BadItemLimit ] [-CompleteAfter ] [-Confirm] + [-ContentFilter ] + [-ContentFilterLanguage ] + [-DataFusion] [-DomainController ] + [-ExcludeDumpsters] + [-ExcludeFolders ] + [-ForwardingDisposition ] + [-IncludeFolders ] + [-IncludeOtherContacts] + [-LargeItemLimit ] [-Locale ] + [-MigrateTasks] [-MoveOptions ] [-NotificationEmails ] [-Partition ] [-PrimaryOnly] [-RemoveOnCopy] + [-RenamePrimaryCalendar] [-ReportInterval ] + [-Restore] + [-SimplifiedSwitchOver] + [-SkipCalendar] + [-SkipContacts] + [-SkipDelegates] + [-SkipMail] + [-SkipMerging ] [-SkipMoving ] + [-SkipProvisioning] [-SkipReports] + [-SkipRules] [-SkipSteps ] + [-SourceEndpoint ] + [-SourcePFPrimaryMailboxGuid ] [-StartAfter ] [-TargetArchiveDatabases ] [-TargetDatabases ] + [-TargetDeliveryDomain ] [-TimeZone ] [-WhatIf] + [-XMLData ] [] ``` -### LocalPublicFolder +### PointInTimeRecovery ``` -New-MigrationBatch -Name -CSVData -SourcePublicFolderDatabase +New-MigrationBatch -Name -CSVData + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### PointInTimeRecoveryProvisionOnly +``` +New-MigrationBatch -Name -CSVData + [-AllowUnknownColumnsInCSV ] + [-AutoComplete] + [-AutoStart] + [-CompleteAfter ] + [-Confirm] + [-NotificationEmails ] + [-Partition ] + [-ReportInterval ] + [-SkipReports] + [-StartAfter ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Preexisting +``` +New-MigrationBatch -Name [-Users] [-AllowIncrementalSyncs ] - [-AllowUnknownColumnsInCsv ] [-AutoComplete] [-AutoRetryCount ] [-AutoStart] - [-BadItemLimit ] [-CompleteAfter ] [-Confirm] + [-DisableOnCopy] [-DomainController ] - [-LargeItemLimit ] [-Locale ] [-NotificationEmails ] [-Partition ] [-ReportInterval ] - [-SkipMerging ] [-SkipReports] [-SkipSteps ] [-StartAfter ] @@ -189,23 +370,19 @@ New-MigrationBatch -Name [-UserIds] [] ``` -### Preexisting +### PreexistingUsers ``` -New-MigrationBatch -Name [-Users] - [-AllowIncrementalSyncs ] +New-MigrationBatch [-Users] MultiValuedProperty> -Name + [-AllowUnknownColumnsInCSV ] [-AutoComplete] - [-AutoRetryCount ] [-AutoStart] [-CompleteAfter ] [-Confirm] [-DisableOnCopy] - [-DomainController ] - [-Locale ] [-NotificationEmails ] [-Partition ] [-ReportInterval ] [-SkipReports] - [-SkipSteps ] [-StartAfter ] [-TimeZone ] [-WhatIf] @@ -281,13 +458,14 @@ Onboarding and offboarding in Exchange Online - IMAP migration: This onboarding migration type migrates mailbox data from an IMAP server (including Exchange) to Exchange Online. For an IMAP migration, you must first provision mailboxes in Exchange Online before you can migrate mailbox data. For more information, see Example 7. - Google Workspace (formerly G Suite) migration: This onboarding migration type migrates mailbox data from a Google Workspace organization to Exchange Online. For a Google Workspace migration, you must first provision mail users (or mailboxes) in Exchange Online before you can migrate mailbox data. For more information, see Example 10. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell New-MigrationBatch -Local -Name LocalMove1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\LocalMove1.csv")) -TargetDatabases MBXDB2 + Start-MigrationBatch -Identity LocalMove1 ``` @@ -296,8 +474,11 @@ This example creates a migration batch for a local move, where the mailboxes in ### Example 2 ```powershell $Credentials = Get-Credential + $MigrationEndpointSource = New-MigrationEndpoint -ExchangeRemoteMove -Name Forest1Endpoint -Autodiscover -EmailAddress administrator@forest1.contoso.com -Credentials $Credentials + $CrossForestBatch = New-MigrationBatch -Name CrossForestBatch1 -SourceEndpoint $MigrationEndpointSource.Identity -TargetDeliveryDomain forest2.contoso.com -TargetDatabases MBXDB1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\CrossForestBatch1.csv")) + Start-MigrationBatch -Identity $CrossForestBatch.Identity ``` @@ -306,9 +487,12 @@ This example creates a migration batch for a cross-forest enterprise move, where ### Example 3 ```powershell $Credentials = Get-Credential + $MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials + $OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain contoso.mail.onmicrosoft.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")) -Start-MigrationBatch -Identity $OnboardingBatch.Identity + +Start-MigrationBatch -Identity $OnboardingBatch.Identity.Name ``` This example creates a migration batch for an onboarding remote move migration from an on-premises Exchange organization to Exchange Online. The syntax is similar to that of a cross-forest move, but it's initiated from the Exchange Online organization. A new migration endpoint is created, which points to the on-premises organization as the source location of the mailboxes that will be migrated. This endpoint is used to create the migration batch. Then the migration batch is started with the Start-MigrationBatch cmdlet. @@ -316,8 +500,11 @@ This example creates a migration batch for an onboarding remote move migration f ### Example 4 ```powershell $Credentials = Get-Credential + $MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials + $OffboardingBatch = New-MigrationBatch -Name RemoteOffBoarding1 -TargetEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain onprem.contoso.com -TargetDatabases @(MBXDB01,MBXDB02,MBXDB03) -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOffBoarding1.csv")) + Start-MigrationBatch -Identity $OffboardingBatch.Identity ``` @@ -326,7 +513,9 @@ This example creates a migration batch for an offboarding remote move migration ### Example 5 ```powershell $credentials = Get-Credential + $SourceEndpoint = New-MigrationEndpoint -ExchangeOutlookAnywhere -Autodiscover -Name SourceEndpoint -EmailAddress administrator@contoso.com -Credentials $credentials + New-MigrationBatch -Name CutoverBatch -SourceEndpoint $SourceEndpoint.Identity -TimeZone "Pacific Standard Time" -AutoStart ``` @@ -335,8 +524,11 @@ This example creates a migration batch for the cutover Exchange migration Cutove ### Example 6 ```powershell $Credentials = Get-Credential + $MigrationEndpoint = New-MigrationEndpoint -ExchangeOutlookAnywhere -Name ContosoEndpoint -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials + $StagedBatch1 = New-MigrationBatch -Name StagedBatch1 -SourceEndpoint $MigrationEndpoint.Identity -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\StagedBatch1.csv")) + Start-MigrationBatch -Identity $StagedBatch1.Identity ``` @@ -345,6 +537,7 @@ This example creates and starts a migration batch for a staged Exchange migratio ### Example 7 ```powershell New-MigrationEndpoint -IMAP -Name IMAPEndpoint1 -RemoteServer imap.contoso.com -Port 993 + New-MigrationBatch -Name IMAPbatch1 -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\IMAPmigration_1.csv")) -SourceEndpoint IMAPEndpoint1 -ExcludeFolders "Deleted Items","Junk Email" ``` @@ -353,35 +546,123 @@ This example creates a migration endpoint for the connection settings to the IMA ### Example 8 ```powershell $Credentials = Get-Credential + $MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials + $OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain contoso.mail.onmicrosoft.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")) -CompleteAfter "09/01/2018 7:00 PM" + Start-MigrationBatch -Identity $OnboardingBatch.Identity ``` This example is the same as Example 3, but the CompleteAfter parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (UTC). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Coordinated Universal Time. -### Example 9 -```powershell -$Credentials = Get-Credential -$MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials -$OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain contoso.mail.onmicrosoft.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")) -CompleteAfter "09/01/2018 7:00 PM" -TimeZone "Pacific Standard Time" -Start-MigrationBatch -Identity $OnboardingBatch.Identity +### Example 9 +```powershell +$Credentials = Get-Credential + +$MigrationEndpointOnPrem = New-MigrationEndpoint -ExchangeRemoteMove -Name OnpremEndpoint -Autodiscover -EmailAddress administrator@onprem.contoso.com -Credentials $Credentials + +$OnboardingBatch = New-MigrationBatch -Name RemoteOnBoarding1 -SourceEndpoint $MigrationEndpointOnprem.Identity -TargetDeliveryDomain contoso.mail.onmicrosoft.com -CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\RemoteOnBoarding1.csv")) -CompleteAfter "09/01/2018 7:00 PM" -TimeZone "Pacific Standard Time" + +Start-MigrationBatch -Identity $OnboardingBatch.Identity +``` + +This example is the same as Example 8, but the TimeZone parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (PST). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Pacific Standard Time. + +### Example 10 +```powershell +$MigrationEndpointGmail = New-MigrationEndpoint -Gmail -ServiceAccountKeyFileData $([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\gmailonboarding.json")) -EmailAddress admin@contoso.com -Name GmailEndpoint + +$OnboardingBatch = New-MigrationBatch -SourceEndpoint $MigrationEndpointGmail.Identity -Name GmailBatch1 -CSVData $([System.IO.File]::ReadAll +Bytes("C:\Users\Administrator\Desktop\gmail.csv")) -TargetDeliveryDomain "o365.contoso.com" -ContentFilter "Received -ge '2019/4/30'" -Inc +ludeFolders "Payment" + +Start-MigrationBatch -Identity $OnboardingBatch.Identity +``` + +A Google Workspace migration batch is created that uses the CSV migration file gmail.csv and includes the contents of the Payment label and only migrate the mails which were received after the time '2019/4/30 00:00' (local system time). This migration batch is pending until it's started with the Start-MigrationBatch cmdlet. + +## PARAMETERS + +### -UserIds +The UserIds parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify a user by email address or by their Guid property value from the Get-MigrationUser cmdlet. You can specify multiple users separated by commas. + +The users that you specify for this parameter must be defined in an existing migration batch. + +To disable the migration of the users in the original migration batch, use the DisableOnCopy switch with this parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: PreexistingUserIds +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Users +The Users parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify the users by using the Get-MigrationUser cmdlet. For example: + +$Failed = Get-MigrationUser -Status Failed + +New-MigrationBatch -Name "Retry Failed Users" -Users $Failed + +The users that you specify for this parameter must be defined in an existing migration batch. + +To disable the migration of the users in the original migration batch, use the DisableOnCopy switch with this parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Preexisting, PreexistingUsers +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -Analyze +This parameter is available only in the cloud-based service. + +{{ Fill Analyze Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Analysis +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False ``` -This example is the same as Example 8, but the TimeZone parameter is also used. Data migration for the batch will start, but won't complete until 09/01/2018 7:00 PM (PST). This method allows you to start a migration and then leave it to complete after business hours if your time zone is Pacific Standard Time. +### -ManagedGmailTeams +This parameter is available only in the cloud-based service. -### Example 10 -```powershell -$MigrationEndpointGmail = New-MigrationEndpoint -Gmail -ServiceAccountKeyFileData $([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\gmailonboarding.json")) -EmailAddress admin@contoso.com -Name GmailEndpoint -$OnboardingBatch = New-MigrationBatch -SourceEndpoint $MigrationEndpointGmail.Identity -Name GmailBatch1 -CSVData $([System.IO.File]::ReadAll -Bytes("C:\Users\Administrator\Desktop\gmail.csv")) -TargetDeliveryDomain "o365.contoso.com" -ContentFilter "Received -ge '2019/4/30'" -Inc -ludeFolders "Payment" -Start-MigrationBatch -Identity $OnboardingBatch.Identity -``` +{{ Fill ManagedGmailTeams Description }} -A Google Workspace migration batch is created that uses the CSV migration file gmail.csv and includes the contents of the Payment label and only migrate the mails which were received after the time '2019/4/30 00:00' (local system time). This migration batch is pending until it's started with the Start-MigrationBatch cmdlet. +```yaml +Type: SwitchParameter +Parameter Sets: ManagedGmailTeams +Aliases: +Applicable: Exchange Online -## PARAMETERS +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` ### -Name The Name parameter specifies an unique name for the migration batch on each system (Exchange On-premises or Exchange Online). The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. @@ -400,15 +681,15 @@ Accept wildcard characters: False ``` ### -CSVData -The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see [CSV files for mailbox migration](https://docs.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). +The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. For more information, see [CSV files for mailbox migration](https://learn.microsoft.com/exchange/csv-files-for-mailbox-migration-exchange-2013-help). -Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes())`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\MigrationBatch\_1.csv"))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). **Note**: This parameter doesn't validate the availability of the mailboxes based on RBAC scope. All mailboxes that are specified in the CSV file will be migrated, even if they are outside of the RBAC scope (for example, an OU) that gives the admin permissions to migrate mailboxes. ```yaml Type: Byte[] -Parameter Sets: Local, LocalPublicFolder, Offboarding, PublicFolderToUnifiedGroup +Parameter Sets: Abch, Analysis, FolderMove, Local, LocalPublicFolder, Offboarding, XO1, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -472,50 +753,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserIds -The UserIds parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify a user by email address or by their Guid property value from the Get-MigrationUser cmdlet. You can specify multiple users separated by commas. - -The users that you specify for this parameter must be defined in an existing migration batch. - -To disable the migration of the users in the original migration batch, use the DisableOnCopy switch with this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: PreexistingUserIds -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Users -The Users parameter specifies the users that you want to copy from an existing migration batch (for example, if a previous migration was partially successful). You identify the users by using the Get-MigrationUser cmdlet. For example: - -$Failed = Get-MigrationUser -Status Failed - -New-MigrationBatch -Name "Retry Failed Users" -Users $Failed - -The users that you specify for this parameter must be defined in an existing migration batch. - -To disable the migration of the users in the original migration batch, use the DisableOnCopy switch with this parameter. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Preexisting -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -AdoptPreexisting This parameter is available only in the cloud-based service. @@ -523,7 +760,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: SwitchParameter -Parameter Sets: Onboarding, Offboarding, Local +Parameter Sets: Onboarding, Local, Offboarding, GoogleResourceOnboarding Aliases: Applicable: Exchange Online @@ -544,7 +781,7 @@ The AllowIncrementalSyncs parameter specifies whether to enable or disable incre ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -632,6 +869,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoProvisioning +This parameter is available only in the cloud-based service. + +{{ Fill AutoProvisioning Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AutoRetryCount This parameter is available only in on-premises Exchange. @@ -639,7 +894,7 @@ The AutoRetryCount parameter specifies the number of attempts to restart the mig ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -695,7 +950,7 @@ Valid input for this parameter is an integer or the value unlimited. The default ```yaml Type: Unlimited -Parameter Sets: Local, LocalPublicFolder, Onboarding, Offboarding, PublicFolderToUnifiedGroup +Parameter Sets: Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, FolderMove Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -707,9 +962,11 @@ Accept wildcard characters: False ``` ### -CompleteAfter +This parameter is functional only in the cloud-based service. + The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but completion won't start until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a value, use either of the following options: @@ -751,7 +1008,7 @@ Accept wildcard characters: False ### -ContentFilter This parameter is available only in the cloud-based service for IMAP migration and Google Workspace migration. -The ContentFilter parameter uses OPath filter syntax to filter the messages by Received time. Only content that match the ContentFilter parameter will be moved to Exchange online. For example: +The ContentFilter parameter uses OPATH filter syntax to filter the messages by Received time. Only content that match the ContentFilter parameter will be moved to Exchange online. For example: - `"Received -gt '8/23/2020'"` - `"Received -le '2019/01/01'"` @@ -777,7 +1034,7 @@ This parameter is available only in the cloud-based service for IMAP migration a The ContentFilterLanguage parameter specifies the language being used in the ContentFilter parameter for string searches. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -792,12 +1049,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DataFusion +This parameter is available only in the cloud-based service. + +{{ Fill DataFusion Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisableOnCopy The DisableOnCopy switch disables the original migration job item for a user if you're copying users from an existing batch to a new batch by using the UserIds or Users parameters. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter -Parameter Sets: PreexistingUserIds, Preexisting +Parameter Sets: PreexistingUserIds, Preexisting, PreexistingUsers Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -835,7 +1110,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -900,7 +1175,7 @@ Wildcard characters can't be used in folder names. ```yaml Type: MultiValuedProperty -Parameter Sets: Onboarding +Parameter Sets: Onboarding, Analysis Aliases: Applicable: Exchange Online @@ -929,6 +1204,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -GoogleResource +{{ Fill GoogleResource Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: GoogleResourceOnboarding +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeFolders This parameter is available only in the cloud-based service. @@ -963,6 +1254,24 @@ Wildcard characters can't be used in folder names. ```yaml Type: MultiValuedProperty +Parameter Sets: Onboarding, Analysis +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeOtherContacts +This parameter is available only in the cloud-based service. + +{{ Fill IncludeOtherContacts Description }} + +```yaml +Type: SwitchParameter Parameter Sets: Onboarding Aliases: Applicable: Exchange Online @@ -979,8 +1288,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. @@ -988,7 +1297,7 @@ Valid input for this parameter is an integer or the value unlimited. The default ```yaml Type: Unlimited -Parameter Sets: LocalPublicFolder, Onboarding, Offboarding, PublicFolderToUnifiedGroup +Parameter Sets: Onboarding, Offboarding, LocalPublicFolder, PublicFolderToUnifiedGroup, FolderMove Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1004,11 +1313,11 @@ This parameter is available only in on-premises Exchange. The Locale parameter specifies the language for the migration batch. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo -Parameter Sets: (All) +Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1019,6 +1328,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MigrateTasks +This parameter is available only in the cloud-based service. + +{{ Fill MigrateTasks Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MoveOptions The MoveOptions parameter specifies the stages of the migration that you want to skip for debugging purposes. Don't use this parameter unless you're directed to do so by Microsoft Customer Service and Support or specific documentation. @@ -1026,7 +1353,7 @@ Don't use this parameter with the SkipMoving parameter. ```yaml Type: MultiValuedProperty -Parameter Sets: Local, Onboarding, Offboarding +Parameter Sets: Onboarding, Local, Offboarding, FolderMove Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1062,7 +1389,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: MailboxIdParameter -Parameter Sets: Local, LocalPublicFolder, PreexistingUserIds, Preexisting, Onboarding, Offboarding, PublicFolderToUnifiedGroup, WorkflowTemplate +Parameter Sets: PreexistingUserIds, Onboarding, Local, Offboarding, PublicFolderToUnifiedGroup, WorkflowTemplate, PreexistingUsers, GoogleResourceOnboarding, FolderMove, Analysis, PointInTimeRecoveryProvisionOnly, PointInTimeRecovery Aliases: Applicable: Exchange Online @@ -1078,7 +1405,7 @@ The PrimaryOnly switch specifies that only primary mailboxes are migrated for th You can only use this switch for local moves and remote move migrations. -Note : If the users don't have archive mailboxes, don't use this switch. +**Note**: If the users don't have archive mailboxes, don't use this switch. ```yaml Type: SwitchParameter @@ -1094,7 +1421,7 @@ Accept wildcard characters: False ``` ### -PublicFolderToUnifiedGroup -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The PublicFolderToUnifiedGroup switch specifies a migration from public folders to Microsoft 365 Groups. You don't need to specify a value with this switch. @@ -1118,7 +1445,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: SwitchParameter -Parameter Sets: Onboarding, Offboarding, Local +Parameter Sets: Onboarding, Local, Offboarding, GoogleResourceOnboarding Aliases: Applicable: Exchange Online @@ -1167,10 +1494,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipCalendar +### -Restore This parameter is available only in the cloud-based service. -{{ Fill SkipCalendar Description }} +{{ Fill Restore Description }} ```yaml Type: SwitchParameter @@ -1185,10 +1512,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipContacts +### -SimplifiedSwitchOver This parameter is available only in the cloud-based service. -{{ Fill SkipContacts Description }} +{{ Fill SimplifiedSwitchOver Description }} ```yaml Type: SwitchParameter @@ -1203,10 +1530,82 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SkipCalendar +This parameter is available only in the cloud-based service. + +The SkipCalendar switch specifies that you want to skip calendar migration during Google Workspace onboarding. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, ManagedGmailTeams +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipContacts +This parameter is available only in the cloud-based service. + +The SkipContacts switch specifies that you want to skip contact migration during Google Workspace onboarding. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, ManagedGmailTeams +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDelegates +This parameter is available only in the cloud-based service. + +{{ Fill SkipDelegates Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, GoogleResourceOnboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipDetails +This parameter is available only in the cloud-based service. + +{{ Fill SkipDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Analysis +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkipMail This parameter is available only in the cloud-based service. -{{ Fill SkipMail Description }} +The SkipMail switch specifies that you want to skip mail migration during Google Workspace onboarding. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -1226,7 +1625,7 @@ The SkipMerging parameter specifies the stages of the migration that you want to ```yaml Type: MultiValuedProperty -Parameter Sets: LocalPublicFolder, Onboarding, Offboarding +Parameter Sets: Onboarding, Offboarding, LocalPublicFolder, XO1, GoogleResourceOnboarding Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1255,6 +1654,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SkipProvisioning +This parameter is available only in the cloud-based service. + +{{ Fill SkipProvisioning Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Onboarding, GoogleResourceOnboarding +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkipReports The SkipReports switch specifies that you want to skip automatic reporting for the migration. You don't need to specify a value with this switch. @@ -1274,7 +1691,7 @@ Accept wildcard characters: False ### -SkipRules This parameter is available only in the cloud-based service. -The SkipRules switch specifies that you want to skip rule migration during GSuite onboarding. You don't need to specify a value with this switch. +The SkipRules switch specifies that you want to skip rule migration during Google Workspace onboarding. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -1301,7 +1718,7 @@ This parameter is only enforced for staged Exchange migrations. ```yaml Type: SkippableMigrationSteps[] -Parameter Sets: (All) +Parameter Sets: PreexistingUserIds, Preexisting, Onboarding, Local, Offboarding, LocalPublicFolder, XO1, PublicFolderToUnifiedGroup, Abch, WorkflowTemplate Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -1322,7 +1739,7 @@ This parameter defines the settings that are used to connect to the server where ```yaml Type: MigrationEndpointIdParameter -Parameter Sets: Onboarding, PublicFolderToUnifiedGroup +Parameter Sets: Onboarding, PublicFolderToUnifiedGroup, GoogleResourceOnboarding, Analysis Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1354,7 +1771,7 @@ Accept wildcard characters: False ### -StartAfter The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The migration will be prepared, but the actual data migration for the user won't start until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a value, use either of the following options: @@ -1417,7 +1834,7 @@ If you don't use this parameter for a local move, the cmdlet uses the automatic ```yaml Type: MultiValuedProperty -Parameter Sets: Local, Onboarding, Offboarding +Parameter Sets: Onboarding, Local, Offboarding, XO1, Abch Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1565,17 +1982,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -XMLData +This parameter is available only in the cloud-based service. + +{{ Fill XMLData Description }} + +```yaml +Type: Byte[] +Parameter Sets: Onboarding +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md b/exchange/exchange-ps/exchange/New-MigrationEndpoint.md index fee2ae5e60..f7429f506d 100644 --- a/exchange/exchange-ps/exchange/New-MigrationEndpoint.md +++ b/exchange/exchange-ps/exchange/New-MigrationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-migrationendpoint +online version: https://learn.microsoft.com/powershell/module/exchange/new-migrationendpoint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MigrationEndpoint schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MigrationEndpoint cmdlet to configure the connection settings for cross-forests moves, remote move migrations, cutover or staged Exchange migrations, IMAP migrations, and Google Workspace (formerly G Suite) migrations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -142,6 +142,21 @@ New-MigrationEndpoint -Name -ServiceAccountKeyFileData [] ``` +### GoogleMarketplaceApp +``` +New-MigrationEndpoint -Name -OAuthCode [-Gmail] + [-Confirm] + [-MaxConcurrentIncrementalSyncs ] + [-MaxConcurrentMigrations ] + [-Partition ] + [-ProgressAction ] + [-RedirectUri ] + [-SkipVerification] + [-TestMailbox ] + [-WhatIf] + [] +``` + ### PublicFolder ``` New-MigrationEndpoint -Name -Credentials -PublicFolderDatabaseServerLegacyDN -RpcProxyServer -SourceMailboxLegacyDN @@ -225,11 +240,11 @@ The New-MigrationEndpoint cmdlet configures the connection settings for differen - Cutover Exchange migration: Migrate all mailboxes in an on-premises Exchange organization to Exchange Online. A cutover Exchange migration requires the use of an Outlook Anywhere migration endpoint. - Staged Exchange migration: Migrate a subset of mailboxes from an on-premises Exchange organization to Exchange Online. A staged Exchange migration requires the use of an Outlook Anywhere migration endpoint. - IMAP migration: Migrate mailbox data from an on-premises Exchange organization or other email system to Exchange Online. For an IMAP migration, you must first create the cloud-based mailboxes before you migrate mailbox data. IMAP migrations require the use of an IMAP endpoint. -- Google Workspace migration: Migration mailbox data from a Google Workspace tenant to Exchange Online. For a Google Workspace migration, you must first create cloud-based mail users or mailboxes before you migrate mailbox data. Google Workspace migrations require the use of a Gmail endpoint. +- Google Workspace migration: Migration mailbox data from a Google Workspace tenant to Exchange Online. For a Google Workspace migration, you must first create cloud-based mail users or mailboxes before you migrate mailbox data. Google Workspace migrations require the use of a Gmail endpoint. Moving mailboxes between different servers or databases within a single on-premises Exchange forest (called a local move) doesn't require a migration endpoint. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -250,6 +265,7 @@ This example creates an endpoint for remote moves by specifying the settings man ### Example 3 ```powershell $Credentials = Get-Credential + New-MigrationEndpoint -ExchangeOutlookAnywhere -Name EXCH-AutoDiscover -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials ``` @@ -331,7 +347,7 @@ Accept wildcard characters: False ### -Credentials The Credentials parameter specifies the credentials to connect to the source or target endpoint for all Exchange migration types. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -458,6 +474,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OAuthCode +This parameter is available only in the cloud-based service. + +{{ Fill OAuthCode Description }} + +```yaml +Type: SecureString +Parameter Sets: GoogleMarketplaceApp +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PSTImport This parameter is available only in on-premises Exchange. @@ -585,7 +619,7 @@ This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. -Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes())`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json"))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -873,6 +907,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RedirectUri +This parameter is available only in the cloud-based service. + +{{ Fill RedirectUri Description }} + +```yaml +Type: String +Parameter Sets: GoogleMarketplaceApp +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoteTenant This parameter is available only in the cloud-based service. @@ -947,7 +999,7 @@ This parameter is only used to create Outlook Anywhere migration endpoints. ```yaml Type: MailboxIdParameter -Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup +Parameter Sets: ExchangeOutlookAnywhereAutoDiscover, ExchangeOutlookAnywhere, Gmail, GoogleMarketplaceApp, PublicFolder, MrsProxyPublicFolderToUnifiedGroup, LegacyPublicFolderToUnifiedGroup Aliases: Applicable: Exchange Online @@ -979,12 +1031,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md index bcf5761009..a091ad8d3d 100644 --- a/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-MobileDeviceMailboxPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-mobiledevicemailboxpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-MobileDeviceMailboxPolicy schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MobileDeviceMailboxPolicy cmdlet to create mobile device mailbox policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -87,7 +87,9 @@ Mobile device mailbox policies define settings for mobile devices that are used Some mobile device mailbox policy settings require the mobile device to have certain built-in features that enforce these security and device management settings. If your organization allows all devices, you need to set the AllowNonProvisionableDevices parameter to $true. This allows devices that can't enforce all policy settings to synchronize with your server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +Some settings in this cmdlet are supported by Outlook for iOS and Android. For more information, see [Leveraging Exchange Online mobile device policies](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/secure-outlook-for-ios-and-android#leveraging-exchange-online-mobile-device-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -155,7 +157,15 @@ Accept wildcard characters: False ``` ### -AllowBluetooth -The AllowBluetooth parameter specifies whether the Bluetooth capabilities of the mobile device are allowed. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow. +The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. Valid values are: + +- Allow (this is the default value). +- Disable +- HandsfreeOnly + +The values Allow or HandsfreeOnly allow synchronization between Outlook for Android and the Outlook for Android wearable app for the associated Microsoft account. + +The value Disable disables synchronization between Outlook for Android and the Outlook for Android wearable app for the associated Microsoft account. Any previously synchronized data is deleted. This value does not disable Bluetooth on the Android device or the wearable device, nor does it affect other Android wearable apps. ```yaml Type: BluetoothType @@ -259,7 +269,7 @@ The AllowGooglePushNotifications parameter controls whether the user can receive Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -325,7 +335,7 @@ The AllowMicrosoftPushNotifications parameter specifies whether push notificatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -594,7 +604,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -604,6 +614,8 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled +**Note**: This setting is supported by Outlook for iOS and Android. + The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, device encryption is enabled on the mobile device. @@ -872,6 +884,8 @@ Accept wildcard characters: False ``` ### -MinPasswordLength +**Note**: This setting is supported by Outlook for Android. + The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password. You can enter any number from 1 through 16 or the value $null. The default value is blank. The maximum password length is 16 characters. @@ -1125,7 +1139,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1155,12 +1169,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-MoveRequest.md b/exchange/exchange-ps/exchange/New-MoveRequest.md index 6066d3ba6d..85f5f280eb 100644 --- a/exchange/exchange-ps/exchange/New-MoveRequest.md +++ b/exchange/exchange-ps/exchange/New-MoveRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-moverequest +online version: https://learn.microsoft.com/powershell/module/exchange/new-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-MoveRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-MoveRequest cmdlet to begin the process of an asynchronous mailbox or personal archive move. You can also check mailbox readiness to be moved by using the WhatIf parameter. -**Note**: After April 15, 2020, you can't use this cmdlet to manually move mailboxes within an Exchange Online organization. You can only use this cmdlet for migrating to and from Exchange Online. +**Note**: After April 15, 2020, you shouldn't use this cmdlet to manually move mailboxes within an Exchange Online organization. You can only use this cmdlet for migrating to and from Exchange Online. If you have issues with a mailbox and want to fix it by moving the mailbox within your Exchange Online organization, please open a Microsoft Support request instead. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -55,6 +55,7 @@ New-MoveRequest [-Identity] -RemoteHostName ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] @@ -97,6 +98,7 @@ New-MoveRequest [-Identity] -RemoteHostName ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] @@ -134,6 +136,7 @@ New-MoveRequest [-Identity] -RemoteCredential ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] @@ -175,6 +178,7 @@ New-MoveRequest [-Identity] [-ProxyToMailbox ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] @@ -187,7 +191,7 @@ New-MoveRequest [-Identity] ### MigrationOutboundCrossTenant ``` -New-MoveRequest [-Identity] -RemoteTenant -TargetDeliveryDomain [-Outbound] +New-MoveRequest [-Identity] -TargetDeliveryDomain [-Outbound] [-AcceptLargeDataLoss] [-AllowLargeItems] [-BadItemLimit ] @@ -218,7 +222,7 @@ New-MoveRequest [-Identity] -RemoteTenant -RemoteTenant -TargetDeliveryDomain [-Remote] +New-MoveRequest [-Identity] -TargetDeliveryDomain [-Remote] [-TargetDatabase ] [-AcceptLargeDataLoss] [-AllowLargeItems] @@ -240,6 +244,7 @@ New-MoveRequest [-Identity] -RemoteTenant ] [-RequestExpiryInterval ] [-SkipMoving ] + [-SourceEndpoint ] [-StartAfter ] [-Suspend] [-SuspendComment ] @@ -250,7 +255,7 @@ New-MoveRequest [-Identity] -RemoteTenant ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-OMEConfiguration -Identity "Contoso Marketing" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image (Get-Content "C:\Temp\OME Logo.gif" -Encoding byte) +New-OMEConfiguration -Identity "Contoso Marketing" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image ([System.IO.File]::ReadAllBytes('C:\Temp\OME Logo.gif')) ``` This example creates a new OME configuration named "Contoso Marketing" with the specified values specified. Unused parameters get the default values. @@ -77,7 +75,7 @@ The BackgroundColor parameter specifies the background color. Valid values are: - An available text value (for example, `yellow` is 0x00FFFF00). - $null (blank). This is the default value. -For more information, see [Add your organization's brand to your encrypted messages](https://docs.microsoft.com/microsoft-365/compliance/add-your-organization-brand-to-encrypted-messages). +For more information, see [Add your organization's brand to your encrypted messages](https://learn.microsoft.com/purview/add-your-organization-brand-to-encrypted-messages). ```yaml Type: String @@ -141,7 +139,7 @@ Accept wildcard characters: False ``` ### -ExternalMailExpiryInDays -This parameter is only available with a Microsoft 365 Advanced Message Encryption subscription. +This parameter is available only with a Microsoft 365 Advanced Message Encryption subscription. The ExternalMailExpiryInDays parameter specifies the number of days that the encrypted message is available to external recipients in the Microsoft 365 portal. A valid value is an integer from 0 to 730. The value 0 means the messages will never expire. The default value is 0. @@ -163,7 +161,7 @@ Accept wildcard characters: False ### -Image The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. -You need to read the file to a byte-encoded object using the Get-Content cmdlet, for example, -Image (Get-Content "C:\\Temp\\OME Logo.gif" -Encoding byte) +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). - Supported file formats: .png, .jpg, .bmp, or .tiff - Optimal size of logo file: less than 40 KB @@ -305,12 +303,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md index 82ae44935b..7732f3db5a 100644 --- a/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-OabVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-oabvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/new-oabvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-OabVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-OABVirtualDirectory cmdlet to create offline address book (OAB) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. The OAB virtual directory configures the server as a web distribution point for an offline address book (OAB). Typically, you create virtual directories on Exchange servers that have the Client Access server role installed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,7 +44,7 @@ The New-OABVirtualDirectory cmdlet configures a web distribution point for an OA You have to manually create the file system folder on the server that hosts the OAB files. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -333,12 +333,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md index c5df9df8b9..cc267ae497 100644 --- a/exchange/exchange-ps/exchange/New-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/New-OfflineAddressBook.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-offlineaddressbook +online version: https://learn.microsoft.com/powershell/module/exchange/new-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-OfflineAddressBook schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-OfflineAddressBook cmdlet to create offline address books (OABs). -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,13 +43,14 @@ New-OfflineAddressBook [-Name] -AddressLists -HybridDomains ## DESCRIPTION The OnPremisesOrganization object represents an on-premises Microsoft Exchange organization configured for hybrid deployment with a Microsoft 365 organization. It's used with the Hybrid Configuration wizard and is typically created automatically when the hybrid deployment is initially configured by the wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,30 +46,30 @@ This example creates the OnPremisesOrganization object ExchangeMail in a Microso ## PARAMETERS -### -HybridDomains -The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between a Microsoft 365 organization and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains may be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". +### -Name +The Name parameter specifies a friendly name for the on-premises Exchange organization object in the Microsoft 365 organization. ```yaml -Type: MultiValuedProperty +Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InboundConnector -The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization. +### -HybridDomains +The HybridDomains parameter specifies the domains that are configured in the hybrid deployment between a Microsoft 365 organization and an on-premises Exchange organization. The domains specified in this parameter must match the domains listed in the HybridConfiguration object for the on-premises Exchange organization configured by the Hybrid Configuration wizard. Multiple domains may be listed and must be separated by a comma, for example, "contoso.com, sales.contoso.com". ```yaml -Type: InboundConnectorIdParameter +Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -80,17 +78,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a friendly name for the on-premises Exchange organization object in the Microsoft 365 organization. +### -InboundConnector +The InboundConnector parameter specifies the name of the inbound connector configured on the Microsoft Exchange Online Protection (EOP) service for a hybrid deployment configured with an on-premises Exchange organization. ```yaml -Type: String +Type: InboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -103,7 +101,7 @@ The OrganizationGuid parameter specifies the globally unique identifier (GUID) o Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -119,7 +117,7 @@ The OutboundConnector parameter specifies the name of the outbound connector con Type: OutboundConnectorIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -135,7 +133,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -154,7 +152,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -170,7 +168,7 @@ The OrganizationName parameter specifies the Active Directory object name of the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,7 +184,7 @@ The OrganizationRelationship parameter specifies the organization relationship c Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -202,7 +200,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -216,12 +214,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md b/exchange/exchange-ps/exchange/New-OrganizationRelationship.md index facf4270c2..8fe6d28c4a 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/New-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-organizationrelationship +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-OrganizationRelationship cmdlet to create organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,9 +48,9 @@ New-OrganizationRelationship [-Name] -DomainNames ``` ## DESCRIPTION -Before you can create an organization relationship, you must first create a federation trust. For more information, see [Federation](https://docs.microsoft.com/exchange/federation-exchange-2013-help). +Before you can create an organization relationship, you must first create a federation trust. For more information, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -93,7 +93,7 @@ The Name parameter specifies the unique name of the organization relationship. T Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -109,7 +109,7 @@ The DomainNames parameter specifies the SMTP domains of the external organizatio Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -128,7 +128,7 @@ The ArchiveAccessEnabled parameter specifies whether the organization relationsh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,7 +147,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,7 +168,7 @@ For message tracking to work in a cross-premises Exchange scenario, this paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -205,7 +205,7 @@ The Enabled parameter specifies whether to enable the organization relationship. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,7 +226,7 @@ You control the free/busy access level and scope by using the FreeBusyAccessLeve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -248,7 +248,7 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: FreeBusyAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -271,7 +271,7 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,13 +283,20 @@ Accept wildcard characters: False ### -MailboxMoveCapability This parameter is available only in the cloud-based service. -{{ Fill MailboxMoveCapability Description }} +The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. Valid values are: + +- Inbound +- Outbound +- RemoteInbound +- RemoteOutbound + +For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). ```yaml Type: MailboxMoveCapability Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -308,7 +315,7 @@ The MailboxMoveEnabled parameter specifies whether the organization relationship Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -320,13 +327,22 @@ Accept wildcard characters: False ### -MailboxMovePublishedScopes This parameter is available only in the cloud-based service. -{{ Fill MailboxMovePublishedScopes Description }} +The MailboxMovePublishedScopes parameter is used in cross-tenant mailbox migrations to specify the mail-enabled security groups whose members are allowed to migrate. You can use any value that uniquely identifies the group. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -347,7 +363,7 @@ You control the MailTips access level by using the MailTipsAccessLevel parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -369,7 +385,7 @@ This parameter is only meaningful when the MailTipsAccessEnabled parameter value Type: MailTipsAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -402,7 +418,7 @@ This restriction only applies to mailboxes, mail users, and mail contacts. It do Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -414,13 +430,13 @@ Accept wildcard characters: False ### -OAuthApplicationId This parameter is available only in the cloud-based service. -{{ Fill OAuthApplicationId Description }} +The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the application ID of the mailbox migration app that you consented to. For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -436,7 +452,7 @@ The OrganizationContact parameter specifies the email address that can be used t Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -455,7 +471,7 @@ The PhotosEnabled parameter specifies whether photos for users in the internal o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -471,7 +487,7 @@ The TargetApplicationUri parameter specifies the target Uniform Resource Identif Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -487,7 +503,7 @@ The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange W Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -503,7 +519,7 @@ The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook We Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -521,7 +537,7 @@ If you use this parameter, this URL is always used to reach the external Exchang Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -537,7 +553,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -551,12 +567,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-OrganizationSegment.md b/exchange/exchange-ps/exchange/New-OrganizationSegment.md index 89a6e747cc..a8a7015875 100644 --- a/exchange/exchange-ps/exchange/New-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/New-OrganizationSegment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-organizationsegment -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-organizationsegment +applicable: Security & Compliance title: New-OrganizationSegment schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-OrganizationSegment ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-OrganizationSegment cmdlet to create organization segments for use with information barrier policies in the Microsoft 365 compliance center. Organization Segments are not in effect until you [apply information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#part-3-apply-information-barrier-policies). +Use the New-OrganizationSegment cmdlet to create organization segments for use with information barrier policies in the Microsoft Purview compliance portal. Organization Segments are not in effect until you [apply information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies#step-4-apply-ib-policies). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,9 +28,9 @@ New-OrganizationSegment [-Name] -UserGroupFilter ``` ## DESCRIPTION -For more information about the filterable attributes that you can use to define segments, see [Attributes for information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes). +For more information about the filterable attributes that you can use to define segments, see [Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -64,7 +64,7 @@ The Name parameter specifies the unique name for the organization segment. The m Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -83,7 +83,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -93,14 +93,14 @@ Accept wildcard characters: False ``` ### -UserGroupFilter -The UserGroupFilter parameter uses OPath filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). +The UserGroupFilter parameter uses OPATH filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information, see [Attributes for information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information, see [Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). Use the same property for all of your segments, and verify that your segments don't overlap (a user must be assigned to only one segment). @@ -108,7 +108,7 @@ Use the same property for all of your segments, and verify that your segments do Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -118,13 +118,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -138,16 +138,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Attributes for information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes) +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) diff --git a/exchange/exchange-ps/exchange/New-OutboundConnector.md b/exchange/exchange-ps/exchange/New-OutboundConnector.md index cc0239c4e0..2121c66207 100644 --- a/exchange/exchange-ps/exchange/New-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/New-OutboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-outboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/new-outboundconnector applicable: Exchange Online, Exchange Online Protection title: New-OutboundConnector schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-OutboundConnector cmdlet to create a new Outbound connector in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,6 +33,7 @@ New-OutboundConnector [-Name] [-LinkForModifiedConnector ] [-RecipientDomains ] [-RouteAllMessagesViaOnPremises ] + [-SenderRewritingEnabled ] [-SmartHosts ] [-TestMode ] [-TlsDomain ] @@ -47,7 +46,7 @@ New-OutboundConnector [-Name] ## DESCRIPTION Outbound connectors send email messages to remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,9 +81,11 @@ Accept wildcard characters: False ### -AllAcceptedDomains The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: -- $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. You can only use this value when the ConnectorType parameter value is OnPremises. +- $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. This setting requires OnPremises for the ConnectorType value. - $false: The Outbound connector isn't used in hybrid organizations. This is the default value. +This parameter is effective only for OnPremises connectors. + ```yaml Type: Boolean Parameter Sets: (All) @@ -99,7 +100,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -270,10 +271,33 @@ Accept wildcard characters: False ``` ### -RouteAllMessagesViaOnPremises -The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises messaging system in hybrid organizations. Valid values are: +The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises email system in hybrid organizations. Valid values are: + +- $true: Messages are routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. +- $false: Messages aren't routed through the on-premises email system. This is the default value. -- $true: Messages are routed through the on-premises messaging system. This setting requires you to set the ConnectorType parameter to the value OnPremises in the same command. -- $false: Messages aren't routed through the on-premises messaging system. This is the default value. +This parameter is effective only for OnPremises connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderRewritingEnabled +The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewriting are rewritten for routing through the on-premises email system. Valid values are: + +- $true: Messages are rewritten by SRS as needed before being routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. +- $false: Messages aren't rewritten by SRS before being routed through the on-premises email system. This is the default value. + +This parameter is effective only for OnPremises connectors. ```yaml Type: Boolean @@ -292,7 +316,7 @@ Accept wildcard characters: False The SmartHosts parameter specifies the smart host that the Outbound connector uses to route mail. Valid values are: - FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record: For example, mail.contoso.com. -- Single IP address: For example, 10.10.1.1 +- Single IP address: For example, 10.10.1.1. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. You can specify multiple value separated by commas: `"Value1","Value2",..."ValueN"`. @@ -332,7 +356,11 @@ Accept wildcard characters: False ``` ### -TlsDomain -The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is only used if the TlsSettings parameter is set to DomainValidation. Valid input for the TlsDomain parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com +The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. A valid value for this parameter is an SMTP domain. + +Wildcards are supported to specify all subdomains of a domain (for example, \*.contoso.com), but you can't embed the wildcard character within the domain (for example, domain.\*.contoso.com). + +This parameter meaningful only when the TlsSettings value is DomainValidation. ```yaml Type: SmtpDomainWithSubdomains @@ -372,7 +400,7 @@ Accept wildcard characters: False The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: - $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. -- $false: The connector delivers email to one or more smart hosts. When you use this value, you also need to specify the smart hosts by using the SmartHosts parameter in the same command. +- $false: The connector delivers email to one or more smart hosts. This setting requires one or more smart hosts for the SmartHosts value. ```yaml Type: Boolean @@ -408,12 +436,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md index 6475ec9241..871a1233f5 100644 --- a/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/New-OutlookProtectionRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-outlookprotectionrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-OutlookProtectionRule schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-OutlookProtectionRule cmdlet to create a Microsoft Outlook protection rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,11 +40,11 @@ New-OutlookProtectionRule [-Name] -ApplyRightsProtectionTemplate ## DESCRIPTION The New-OutlookProvider cmdlet creates the AutoDiscoverConfig object under the Global Settings object in Active Directory and sets the attributes specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,12 +123,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md index 4c6714edbe..b25a96ccdb 100644 --- a/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-OwaMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-owamailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-owamailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-OwaMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-OwaMailboxPolicy cmdlet to create Outlook on the web mailbox policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ New-OwaMailboxPolicy [-Name] ## DESCRIPTION Use the Set-OwaMailboxPolicy cmdlet to configure the new policy. -Changes to Outlook on the web mailbox polices may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). +Changes to Outlook on the web mailbox policies may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -141,12 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md index 885cbfa0d3..703e02a8bd 100644 --- a/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-OwaVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-owavirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/new-owavirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-OwaVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-OwaVirtualDirectory cmdlet to create Outlook on the web virtual directories that are used in Internet Information Services on Exchange servers. Typically, you create virtual directories on Exchange servers that have the Client Access server role installed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,7 +44,7 @@ New-OwaVirtualDirectory ## DESCRIPTION By default, when Exchange is installed, the Outlook on the web virtual directory owa is created in the default IIS website on the server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +57,24 @@ This example creates the Outlook on the web virtual directory in an IIS website ## PARAMETERS +### -Name +This parameter is available only in Exchange Server 2010. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApplicationRoot The ApplicationRoot parameter specifies the metabase path of the virtual directory. By default, this path is the same as the website in which the virtual directory is created. @@ -258,24 +276,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -This parameter is available only in Exchange Server 2010. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Path The Path parameter specifies the file system path of the virtual directory. We recommend using this parameter only when you need to use a custom location for the virtual directory files. The default value is blank ($null), which indicates the default location is used. @@ -371,12 +371,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-PartnerApplication.md b/exchange/exchange-ps/exchange/New-PartnerApplication.md index ee7ac1bef5..d0ef93326f 100644 --- a/exchange/exchange-ps/exchange/New-PartnerApplication.md +++ b/exchange/exchange-ps/exchange/New-PartnerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-partnerapplication +online version: https://learn.microsoft.com/powershell/module/exchange/new-partnerapplication applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-PartnerApplication schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # New-PartnerApplication ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. Use the New-PartnerApplication cmdlet to create partner application configurations in on-premises Exchange organizations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -55,11 +55,11 @@ New-PartnerApplication [-Name] -AuthMetadataUrl ``` ## DESCRIPTION -You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://docs.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). +You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://learn.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -301,7 +301,7 @@ Accept wildcard characters: False ### -TrustAnySSLCertificate This parameter is available only in on-premises Exchange. -The TrustAnySSLCertificate switch specifies whether Exchange should trust certificates issued by a certification authority (CA) not trusted by the server. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -339,12 +339,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md index c368355278..4d6de2ee03 100644 --- a/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/exchange/New-PhishSimOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-phishsimoverridepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-phishsimoverridepolicy +applicable: Exchange Online title: New-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-PhishSimOverridePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -Use the New-PhishSimOverridePolicy cmdlet to create third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). +Use the New-PhishSimOverridePolicy cmdlet to create third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,13 +24,15 @@ For information about the parameter sets in the Syntax section below, see [Excha New-PhishSimOverridePolicy [-Name] [-Comment ] [-Confirm] + [-DomainController ] [-Enabled ] + [-Force] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,7 +52,7 @@ The Name parameter specifies the name for the phishing simulation override polic Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: True Position: 0 @@ -66,7 +68,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -85,7 +87,23 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -104,7 +122,25 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -114,13 +150,15 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +In Exchange Online PowerShell, 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. + +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -134,12 +172,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/New-PhishSimOverrideRule.md deleted file mode 100644 index 5647164033..0000000000 --- a/exchange/exchange-ps/exchange/New-PhishSimOverrideRule.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-phishsimoverriderule -applicable: Security & Compliance Center -title: New-PhishSimOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-PhishSimOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the New-PhishSimOverrideRule cmdlet to create third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -New-PhishSimOverrideRule [-Name] -Policy -SenderDomainIs -SenderIpRanges - [-Comment ] - [-Confirm] - [-WhatIf] - [] -``` - -## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -## EXAMPLES - -### Example 1 -```powershell -New-PhishSimOverrideRule -Name PhishSimOverrideRule -Policy PhishSimOverridePolicy -SenderDomainIs fabrikam.com,wingtiptoys.com -SenderIpRanges 192.168.1.55 -``` - -This example creates a new phishing simulation override rule with the specified settings. - -## PARAMETERS - -### -Name -The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be PhishSimOverrideRule\ where \ is a unique GUID value (for example, a0eae53e-d755-4a42-9320-b9c6b55c5011). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All)) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderDomainIs -The SenderDomainIs parameter specifies the email domain that's used by the third-party phishing simulation. - -You can specify up to 10 values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderIpRanges -The SenderIpRanges parameter specifies the source IP address that's used by the third-party phishing simulation. Valid values are: - -- Single IP address: For example, 192.168.1.1. -- IP address range: For example, 192.168.0.1-192.168.0.254. -- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. - -You can specify up to 10 entries separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md b/exchange/exchange-ps/exchange/New-PolicyTipConfig.md index c3d75c9154..c32359ad77 100644 --- a/exchange/exchange-ps/exchange/New-PolicyTipConfig.md +++ b/exchange/exchange-ps/exchange/New-PolicyTipConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-policytipconfig +online version: https://learn.microsoft.com/powershell/module/exchange/new-policytipconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-PolicyTipConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-PolicyTipConfig cmdlet to create custom Policy Tips in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ New-PolicyTipConfig [-Name] -Value ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,7 +56,7 @@ This example sets the informational URL in Policy Tips to the value `https://www ### -Name The Name parameter specifies the custom Policy Tip you want to modify. Valid input for this parameter is one of the following values: -- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - Url There can be only one custom Policy Tip with the value Url for the Name parameter. For the remaining Policy Tip actions, there can be only one custom Policy Tip for each combination of locale and action. For example, there can be only one custom Policy Tip with the Name value en\\NotifyOnly, but you can create additional custom Policy Tips with the values de\\NotifyOnly and fr\\NotifyOnly for the Name parameter. @@ -148,12 +148,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md index 668c374660..fd597096d0 100644 --- a/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-PowerShellVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-powershellvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/new-powershellvirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-PowerShellVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-PowerShellVirtualDirectory cmdlet to create Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,6 +25,9 @@ New-PowerShellVirtualDirectory [-Name] [-BasicAuthentication ] [-Confirm] [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] [-ExternalUrl ] [-InternalUrl ] [-RequireSSL ] @@ -38,7 +41,7 @@ New-PowerShellVirtualDirectory [-Name] ## DESCRIPTION Although it's possible to create a Windows PowerShell virtual directory, we recommend that you only do so at the request of Microsoft Customer Service and Support. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,6 +121,69 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExtendedProtectionFlags +The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: + +- None: This is the default setting. +- AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. +- NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. +- Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. +- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionSPNList +The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: + +- $null: This is the default value. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionTokenChecking +The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: + +- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. + +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. + +```yaml +Type: ExtendedProtectionTokenCheckingMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExternalUrl The ExternalUrl parameter specifies the external URL that the PowerShell virtual directory points to. @@ -245,12 +311,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ProtectionAlert.md b/exchange/exchange-ps/exchange/New-ProtectionAlert.md index e294888ee1..5c469a4905 100644 --- a/exchange/exchange-ps/exchange/New-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/New-ProtectionAlert.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-protectionalert -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-protectionalert +applicable: Security & Compliance title: New-ProtectionAlert schema: 2.0.0 author: chrisda @@ -12,11 +12,21 @@ ms.reviewer: # New-ProtectionAlert ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-ProtectionAlert cmdlet to create alert policies in the Microsoft 365 compliance center. Alert policies contain conditions that define the user activities to monitor, and the notification options for email alerts and entries in the Microsoft 365 compliance center. +Use the New-ProtectionAlert cmdlet to create alert policies in the Microsoft Purview compliance portal and the Microsoft Defender portal. Alert policies contain conditions that define the user activities to monitor, and the notification options for email alerts and entries. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +> [!NOTE] +> Although the cmdlet is available, you receive the following error if you don't have an enterprise license: +> +> _Creating advanced alert policies requires an Office 365 E5 subscription or Office 365 E3 subscription with an Office 365 Threat Intelligence or +Office 365 EquivioAnalytics add-on subscription for your organization. With your current subscription, only single event alerts can be created._ +> +> You can bypass this error by specifying `-AggregationType None` and an `-Operation` within the command. +> +> For more information, see [Alert policies in Microsoft 365](https://learn.microsoft.com/purview/alert-policies). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,6 +37,7 @@ New-ProtectionAlert -Category -Name -NotifyUser ] [-Comment ] [-Confirm] + [-CorrelationPolicyId ] [-Description ] [-Disabled ] [-Filter ] @@ -38,16 +49,21 @@ New-ProtectionAlert -Category -Name -NotifyUser ] [-NotifyUserThrottleWindow ] [-Operation ] + [-PrivacyManagementScopedSensitiveInformationTypes ] + [-PrivacyManagementScopedSensitiveInformationTypesForCounting ] + [-PrivacyManagementScopedSensitiveInformationTypesThreshold ] + [-CustomProperties ] [-Severity ] [-Threshold ] [-TimeWindow ] + [-UseCreatedDateTime ] [-VolumeThreshold ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -56,7 +72,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as New-ProtectionAlert -Name "Content search deleted" -Category Others -NotifyUser admin@contoso.com -ThreatType Activity -Operation SearchRemoved -Description "Custom alert policy to track when content searches are deleted" -AggregationType None ``` -This example creates an alert policy that triggers an alert whenever anyone in the organization deletes a Content Search in the Microsoft 365 compliance center. +This example creates an alert policy that triggers an alert whenever anyone in the organization deletes a Content Search in the Microsoft Purview compliance portal. ## PARAMETERS @@ -64,10 +80,13 @@ This example creates an alert policy that triggers an alert whenever anyone in t The Category parameter specifies a category for the alert policy. Valid values are: - AccessGovernance +- ComplianceManager - DataGovernance -- DataLossPrevention -- ThreatManagement +- MailFlow - Others +- PrivacyManagement +- Supervision +- ThreatManagement When an activity occurs that matches the conditions of the alert policy, the alert that's generated is tagged with the category that's specified by this parameter. This allows you to track and manage alerts that have the same category setting @@ -75,7 +94,7 @@ When an activity occurs that matches the conditions of the alert policy, the ale Type: AlertRuleCategory Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -91,7 +110,7 @@ The Name parameter specifies the unique name for the alert policy. If the value Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -107,7 +126,7 @@ The NotifyUser parameter specifies the SMTP address of the user who receives not Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -130,7 +149,7 @@ You can't change this value after you create the alert policy. Type: ThreatAlertType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -150,7 +169,7 @@ The AggregationType parameter specifies the how the alert policy triggers alerts Type: AlertAggregationType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -171,7 +190,7 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -187,7 +206,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -203,7 +222,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -222,7 +241,39 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CorrelationPolicyId +{{ Fill CorrelationPolicyId Description }} + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomProperties +{{ Fill CustomProperties Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -238,7 +289,7 @@ The Description parameter specifies descriptive text for the alert policy. If th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -257,7 +308,7 @@ The Disabled parameter enables or disables the alert policy. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -267,16 +318,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical `-and` operator (for example, `"Criteria1 -and Criteria2"`). -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). The filterable properties are: @@ -325,7 +376,7 @@ Malware Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -341,7 +392,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -353,13 +404,13 @@ Accept wildcard characters: False ### -NotificationCulture The NotificationCulture parameter specifies the language or locale that's used for notifications. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -375,7 +426,7 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -396,7 +447,7 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -408,13 +459,13 @@ Accept wildcard characters: False ### -NotifyUserSuppressionExpiryDate The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -433,7 +484,7 @@ The NotifyUserThrottleThreshold parameter specifies the maximum number of notifi Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -452,7 +503,7 @@ The NotifyUserThrottleWindow parameter specifies the time interval in minutes th Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -462,7 +513,7 @@ Accept wildcard characters: False ``` ### -Operation -The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). +The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. @@ -472,7 +523,55 @@ You can only use this parameter when the ThreatType parameter has the value Acti Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypes +{{ Fill PrivacyManagementScopedSensitiveInformationTypes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypesForCounting +{{ Fill PrivacyManagementScopedSensitiveInformationTypesForCounting Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypesThreshold +{{ Fill PrivacyManagementScopedSensitiveInformationTypesThreshold Description }} + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -492,7 +591,7 @@ The Severity parameter specifies the severity of the detection. Valid values are Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -510,7 +609,7 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -528,7 +627,23 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseCreatedDateTime +{{ Fill UseCreatedDateTime Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -544,7 +659,7 @@ Accept wildcard characters: False Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -554,13 +669,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -574,12 +689,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-PublicFolder.md b/exchange/exchange-ps/exchange/New-PublicFolder.md index 397b774076..71c11a5ab5 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolder.md +++ b/exchange/exchange-ps/exchange/New-PublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-publicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-PublicFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-PublicFolder cmdlet to create a public folder with the specified name. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ New-PublicFolder [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,10 +53,10 @@ In Exchange Server 2010, this example creates the public folder FY2010 under the ### Example 3 ```powershell -New-PublicFolder -Name FY2013 -Path \Legal\Cases +New-PublicFolder -Name FY2014 -Path \Legal\Cases ``` -This example creates the public folder FY2013 under the existing folders \\Legal\\Cases. The path to the new folder is \\Legal\\Cases\\FY2013. +This example creates the public folder FY2014 under the existing folders \\Legal\\Cases. The path to the new folder is \\Legal\\Cases\\FY2014. ### Example 4 ```powershell @@ -121,7 +121,7 @@ Accept wildcard characters: False ``` ### -EformsLocaleId -The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -225,12 +225,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md index 8dcf8e5346..992f21daac 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md +++ b/exchange/exchange-ps/exchange/New-PublicFolderDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-publicfolderdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolderdatabase applicable: Exchange Server 2010 title: New-PublicFolderDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the New-PublicFolderDatabase cmdlet to create a public folder database. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +31,9 @@ New-PublicFolderDatabase [-Name] -Server ``` ## DESCRIPTION -The new database must be mounted after it's created. For more information about mounting databases, see [Mount a Database](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb123587(v=exchg.141)). +The new database must be mounted after it's created. For more information about mounting databases, see [Mount a Database](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123587(v=exchg.141)). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -173,12 +173,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md index 13134daee9..332ac3deec 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md +++ b/exchange/exchange-ps/exchange/New-PublicFolderDatabaseRepairRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-publicfolderdatabaserepairrequest +online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfolderdatabaserepairrequest applicable: Exchange Server 2010 title: New-PublicFolderDatabaseRepairRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the New-PublicFolderDatabaseRepairRequest cmdlet to detect and fix replication issues in the public folder database. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ New-PublicFolderDatabaseRepairRequest [-Database] -Corrupt ## DESCRIPTION Public folders on the public folder database can still be accessed while the request is running. However, access isn't available to the public folder currently being repaired. -After you begin the repair request, it can't be stopped unless you dismount the database. For more information, see [Dismount a Database](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb123903(v=exchg.141)). +After you begin the repair request, it can't be stopped unless you dismount the database. For more information, see [Dismount a Database](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123903(v=exchg.141)). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,39 +54,39 @@ This example only detects and reports on replication issues on public folder dat ## PARAMETERS -### -CorruptionType -The CorruptionType parameter specifies the type of corruption that you want to detect and repair. The only available value is ReplState. +### -Database +The Database parameter specifies the public folder database that you want to repair. You can use any value that uniquely identifies the database. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml -Type: PublicFolderDatabaseCorruptionType[] +Type: DatabaseIdParameter Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Database -The Database parameter specifies the public folder database that you want to repair. You can use any value that uniquely identifies the database. For example: - -- Name -- Distinguished name (DN) -- GUID +### -CorruptionType +The CorruptionType parameter specifies the type of corruption that you want to detect and repair. The only available value is ReplState. ```yaml -Type: DatabaseIdParameter +Type: PublicFolderDatabaseCorruptionType[] Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -162,12 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md index 27fbda114f..8707577d81 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/exchange/New-PublicFolderMigrationRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-publicfoldermigrationrequest +online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-PublicFolderMigrationRequest schema: 2.0.0 @@ -18,7 +18,7 @@ Use the New-PublicFolderMigrationRequest cmdlet to start a serial public folder **Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,18 +47,18 @@ New-PublicFolderMigrationRequest [[-Name] ] -SourceDatabase " -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). You can't use this parameter with the CSVStream parameter, but you need to use it if you don't use CSVStream parameter. @@ -260,8 +260,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -447,12 +447,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md b/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md index 4b42250c61..435cac68b3 100644 --- a/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md +++ b/exchange/exchange-ps/exchange/New-PublicFolderMoveRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-publicfoldermoverequest -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +online version: https://learn.microsoft.com/powershell/module/exchange/new-publicfoldermoverequest +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-PublicFolderMoveRequest schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # New-PublicFolderMoveRequest ## SYNOPSIS -This cmdlet is available only in on-premises Exchange. +This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the New-PublicFolderMoveRequest cmdlet to begin the process of moving public folder contents between public folder mailboxes. Moving public folders only moves the physical contents of the public folder; it doesn't change the logical hierarchy. When the move request is completed, you must run the Remove-PublicFolderMoveRequest cmdlet to remove the request or wait until the time specified in the CompletedRequestAgeLimit parameter has passed. The request must be removed before you can run another move request. -Be aware that the target public folder mailbox will be locked while the move request is active. See the Detailed Description section below for more details. +Be aware that the target public folder mailbox will be locked while the move request is active. For more information, see the Description section. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,6 +32,7 @@ New-PublicFolderMoveRequest -Folders -TargetMailbox [-DomainController ] [-InternalFlags ] [-Name ] + [[-Organization] ] [-Priority ] [-RequestExpiryInterval ] [-Suspend] @@ -43,11 +44,11 @@ New-PublicFolderMoveRequest -Folders -TargetMailbox ``` ## DESCRIPTION -The New-PublicFolderMoveRequest cmdlet moves public folders from a source public folder mailbox to a target public folder mailbox. While the move request is active, the target public folder mailbox will be locked. As a result, public folders already residing in the target public folder mailbox will be inaccessible until the move request is complete. Therefore, before you begin the move request, you should make sure no users are accessing public folder data in that target public folder mailbox. +The New-PublicFolderMoveRequest cmdlet moves public folders from a source public folder mailbox to a target public folder mailbox. While the move request is active, the target public folder mailbox will be locked. As a result, public folders already residing in the target public folder mailbox will be inaccessible until the move request is complete. Therefore, before you begin the move request, you should ensure that no users are accessing public folder data in that target public folder mailbox. To move the public folder mailbox to another mailbox database, use the New-MoveRequest cmdlet. To ensure that this folder is already in the target public folder mailbox, run the Update-PublicFolderMailbox cmdlet against the target public folder mailbox. You can only perform one move request at a time. You can also move public folders by using the Move-PublicFolderBranch.ps1 script. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,6 +71,7 @@ You can also move a branch of public folders by using the Move-PublicFolderBranc ### Example 3 ```powershell $folders = Get-PublicFolder \ -Recurse -Mailbox PUB1 -ResidentFolders | ?{$_.Name -ne "IPM_SUBTREE"} | %{$_.Identity} + New-PublicFolderMoveRequest -TargetMailbox PUB2 -Folders $folders ``` @@ -78,13 +80,13 @@ This example moves all public folders from public folder mailbox Pub1 to public ## PARAMETERS ### -Folders -The Folders parameter specifies the public folders that you want to move. If the public folder has child public folders, child public folders won't be moved unless you explicitly state them in the command. You can move multiple public folders by separating them with a comma, for example, \\Dev\\CustomerEngagements,\\Dev\\RequestsforChange,\\Dev\\Usability. +The Folders parameter specifies the public folders that you want to move. If the public folder has child public folders, these child public folders won't be moved unless you explicitly state them in the command. You can move multiple public folders by separating them with a comma, for example, \\Dev\\CustomerEngagements,\\Dev\\RequestsforChange,\\Dev\\Usability. ```yaml Type: PublicFolderIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -111,7 +113,7 @@ The TargetMailbox parameter specifies the target public folder mailbox that you Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: Named @@ -121,7 +123,7 @@ Accept wildcard characters: False ``` ### -AcceptLargeDataLoss -The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. +The AcceptLargeDataLoss switch specifies that the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You don't need to specify a value with this switch. You need to use this switch if you set the LargeItemLimit parameter to a value of 51 or higher. Otherwise, the command will fail. @@ -129,7 +131,7 @@ You need to use this switch if you set the LargeItemLimit parameter to a value o Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -139,13 +141,15 @@ Accept wildcard characters: False ``` ### -AllowLargeItems -The AllowLargeItems parameter specifies that you can move large items only when large items are encountered. Large items are email messages with a maximum of 1,023 attachments. +The AllowLargeItems switch specifies that you can move large items only when they're encountered. You don't need to specify a value with this switch. + +Large items are email messages with a maximum of 1,023 attachments. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -155,15 +159,15 @@ Accept wildcard characters: False ``` ### -BadItemLimit -The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete. +The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to be completed. -Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again. +Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means that the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so that the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and then try the request again. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -173,13 +177,13 @@ Accept wildcard characters: False ``` ### -CompletedRequestAgeLimit -The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days. +The CompletedRequestAgeLimit parameter specifies how long the request will be kept after it has been completed before being automatically removed. The default value for this parameter is 30 days. ```yaml Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -198,7 +202,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -208,13 +212,15 @@ Accept wildcard characters: False ``` ### -DomainController +This parameter is functional only in on-premises Exchange. + The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -230,7 +236,7 @@ The InternalFlags parameter specifies the optional steps in the request. This pa Type: InternalMrsFlag[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -246,7 +252,7 @@ The Name parameter specifies the name of the public folder move request. If you Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -255,6 +261,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Organization +This parameter is available only in the cloud-based service. + +{{ Fill Organization Description }} + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Priority The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -271,7 +295,7 @@ The Priority parameter specifies the order in which the request should be proces Type: RequestPriority Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -294,7 +318,7 @@ When you use the value Unlimited, the completed request isn't automatically remo Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -304,13 +328,15 @@ Accept wildcard characters: False ``` ### -Suspend -The Suspend switch specifies whether to suspend the request. If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. You don't have to specify a value with this switch. +The Suspend switch specifies whether to suspend the request. You don't need to specify a value with this switch. + +If you use this switch, the request is queued, but the request won't reach the status of InProgress until you resume the request with the relevant resume cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -326,7 +352,7 @@ The SuspendComment parameter specifies a description about why the request was s Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -336,7 +362,11 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete -The SuspendWhenReadyToComplete switch specifies whether to suspend the request before it reaches the status of CompletionInProgress. After the move is suspended, it has a status of AutoSuspended. You can then manually complete the move by using the Resume-PublicFolderMoveRequest command. +This parameter is available only in on-premises Exchange. + +The SuspendWhenReadyToComplete switch specifies whether to suspend the request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. + +After the move is suspended, it has a status of AutoSuspended. You can then manually complete the move by using the Resume-PublicFolderMoveRequest command. ```yaml Type: SwitchParameter @@ -358,7 +388,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -368,13 +398,13 @@ Accept wildcard characters: False ``` ### -WorkloadType -This parameter is reserved for internal Microsoft use. +The WorkloadType parameter is reserved for internal Microsoft use. ```yaml Type: RequestWorkloadType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -388,12 +418,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-QuarantinePermissions.md b/exchange/exchange-ps/exchange/New-QuarantinePermissions.md new file mode 100644 index 0000000000..2ce42db98f --- /dev/null +++ b/exchange/exchange-ps/exchange/New-QuarantinePermissions.md @@ -0,0 +1,243 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepermissions +applicable: Exchange Online, Exchange Online Protection +title: New-QuarantinePermissions +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-QuarantinePermissions + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +**Note**: Instead of using this cmdlet to set quarantine policy permissions, we recommend using the EndUserQuarantinePermissionsValue parameter on the New-QuarantinePolicy and Set-QuarantinePolicy cmdlets. + +Use the New-QuarantinePermissions cmdlet to create a variable that contains a quarantine permissions object to use with the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets in the same PowerShell session. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-QuarantinePermissions + [[-PermissionToAllowSender] ] + [[-PermissionToBlockSender] ] + [[-PermissionToDelete] ] + [[-PermissionToDownload] ] + [[-PermissionToPreview] ] + [[-PermissionToRelease] ] + [[-PermissionToRequestRelease] ] + [[-PermissionToViewHeader] ] + [] +``` + +## DESCRIPTION +The default value for any parameters that you don't use is $false, so you only need to use parameters (permissions) that you want to set to $true. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$NoAccess = New-QuarantinePermissions +``` + +This example creates the same permissions that are used by the No access permissions group in quarantine policies. The permissions object is stored in the variable named `$NoAccess`. + +In the same PowerShell session, you can use `$NoAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command. + +### Example 2 +```powershell +$LimitedAccess = New-QuarantinePermissions -PermissionToAllowSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRequestRelease $true +``` + +This example creates the same permissions that are used by the Limited access permissions group in quarantine policies. The permissions object is stored in the variable named `$LimitedAccess`. + +In the same PowerShell session, you can use `$LimitedAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command. + +### Example 3 +```powershell +$FullAccess = New-QuarantinePermissions -PermissionToAllowSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRelease $true +``` + +This example creates the same permissions that are used by the Full access permissions group in quarantine policies. The permissions object is stored in the variable named `$FullAccess`. + +In the same PowerShell session, you can use `$FullAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command. + +## PARAMETERS + +### -PermissionToAllowSender +The PermissionToAllowSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are: + +- $true: Allow sender is available for affected messages in quarantine. +- $false: Allow sender isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToBlockSender +The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are: + +- $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine. +- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToDelete +The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: + +- $true: Delete messages and Delete from quarantine are available for affected messages in quarantine. +- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToDownload +The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are: + +- $true: The permission is enabled. +- $false: The permission is disabled. This is the default value. + +Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. End-users can't download quarantined messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToPreview +The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: + +- $true: Preview message is available for affected messages in quarantine. +- $false: Preview message isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToRelease +The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: + +- $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine. +- $false: Release message isn't available in quarantine notifications for affected messages, and Release and Release email aren't available for affected messages in quarantine. + +Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToRequestRelease +The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are: + +- $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine. +- $false: Request Release isn't available in quarantine notifications for affected messages, and Request release isn't available for affected messages in quarantine. + +Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToViewHeader +The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are: + +- $true: The permission is enabled. +- $false: The permission is disabled. This is the default value. + +Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. View message header is always available for affected messages in quarantine. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 8 +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-QuarantinePolicy.md b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md new file mode 100644 index 0000000000..1d12b70c98 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-QuarantinePolicy.md @@ -0,0 +1,493 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-quarantinepolicy +applicable: Exchange Online, Exchange Online Protection +title: New-QuarantinePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-QuarantinePolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-QuarantinePolicy cmdlet to create quarantine policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-QuarantinePolicy [-Name] + [-AdminDisplayName ] + [-AdminNotificationFrequencyInDays ] + [-AdminNotificationLanguage ] + [-AdminNotificationsEnabled ] + [-AdminQuarantinePermissionsList ] + [-CustomDisclaimer ] + [-DomainController ] + [-EndUserQuarantinePermissions ] + [-EndUserQuarantinePermissionsValue ] + [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationFrequency ] + [-EndUserSpamNotificationFrequencyInDays ] + [-EndUserSpamNotificationLanguage ] + [-EsnCustomSubject ] + [-ESNEnabled ] + [-IncludeMessagesFromBlockedSenderAddress ] + [-MultiLanguageCustomDisclaimer ] + [-MultiLanguageSenderName ] + [-MultiLanguageSetting ] + [-OrganizationBrandingEnabled ] + [-QuarantinePolicyType ] + [-QuarantineRetentionDays ] + [] +``` + +## DESCRIPTION +Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-QuarantinePolicy -Name ContosoTag -EndUserQuarantinePermissionsValue 0 +``` + +This example creates a new quarantine policy named ContosoTag with the same permissions as the No access preset permissions group. + +To assign Limited access permissions, use the value 27. To assign Full access permissions, use the value 23. + +## PARAMETERS + +### -Name +The Name parameter specifies a unique name for the quarantine policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the quarantine policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationFrequencyInDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationLanguage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminQuarantinePermissionsList +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserQuarantinePermissions +**Note**: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter. + +The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command. + +For example, run the following command to store the required permissions in a variable: `$Perms = New-QuarantinePermissions `. In the same PowerShell session, use the value `$Perms` for this parameter. + +```yaml +Type: QuarantinePermissions +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserQuarantinePermissionsValue +The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy. + +This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): + +- PermissionToViewHeader: The value 0 doesn't hide the **View message header** action in quarantine. If the message is visible in quarantine, the action is always available for the message. +- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing). +- PermissionToAllowSender +- PermissionToBlockSender +- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0. +- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead. +- PermissionToPreview +- PermissionToDelete + +The values for the preset end-user permission groups are described in the following list: + +- No access: Binary = 0000000, so use the decimal value 0. +- Limited access: Binary = 00101011, so use the decimal value 43. +- Full access: Binary = 00100111, so use the decimal value 39. + +For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter. + +**Note**: If the value of this parameter is 0 (No access) and the value of the ESNEnabled parameter is $true, users can view their messages in quarantine, but the only available action for the messages is **View message header**. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationCustomFromAddress +The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. + +If you don't use this parameter, the default sender is quarantine@messaging.microsoft.com. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequency +The EndUserSpamNotificationFrequency parameter specifies how often quarantine notifications are sent to users. Valid values are: + +- 04:00:00 (4 hours) +- 1.00:00:00 (1 day) +- 7.00:00:00 (7 days) + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequencyInDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationLanguage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EsnCustomSubject +The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: MultiValuedProperty +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ESNEnabled +The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: + +- $true: Quarantine notifications are enabled. +- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. + +**Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can see their messages in quarantine, but the only available action for the messages is **View message header**. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMessagesFromBlockedSenderAddress +The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are: + +- $true: Recipients get quarantine notifications for affected messages from blocked senders. +- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageCustomDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageSenderName +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageSetting +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationBrandingEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineRetentionDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantinePolicyType +This parameter is reserved for internal Microsoft use. + +```yaml +Type: QuarantinePolicyType +Parameter Sets: (All) +Aliases: +Accepted values: QuarantinePolicy, GlobalQuarantinePolicy +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ReceiveConnector.md b/exchange/exchange-ps/exchange/New-ReceiveConnector.md index f2e4e7529e..a053087232 100644 --- a/exchange/exchange-ps/exchange/New-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/New-ReceiveConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-receiveconnector +online version: https://learn.microsoft.com/powershell/module/exchange/new-receiveconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-ReceiveConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-ReceiveConnector cmdlet to create Receive connectors on Mailbox servers and Edge Transport servers. Receive connectors listen for inbound SMTP connections on the Exchange server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -381,9 +381,9 @@ New-ReceiveConnector [-Name] -Usage ## DESCRIPTION On Mailbox servers, you can create Receive connectors in the Front End Transport service, and the Transport (Hub) service. On Edge Transport servers, you can create Receive connectors in the Transport service. -For more information about Receive connector usage types, permission groups, and authentication methods, see [Receive connectors](https://docs.microsoft.com/Exchange/mail-flow/connectors/receive-connectors). +For more information about Receive connector usage types, permission groups, and authentication methods, see [Receive connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/receive-connectors). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -1146,9 +1146,9 @@ Accept wildcard characters: False ``` ### -MaxAcknowledgementDelay -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. -The MaxAcknowledgementDelay parameter specifies the maximum period the transport server delays acknowledgement until it verifies that the message has been successfully delivered to all recipients. When receiving messages from a host that doesn't support shadow redundancy, an Exchange Server 2010 transport server will delay issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server will time out and issue an acknowledgement anyway. +The MaxAcknowledgementDelay parameter specifies the maximum period the transport server delays acknowledgment until it verifies that the message has been successfully delivered to all recipients. When receiving messages from a host that doesn't support shadow redundancy, an Exchange Server 2010 transport server will delay issuing an acknowledgment until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server will time out and issue an acknowledgment anyway. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1456,7 +1456,7 @@ The default permission groups that are assigned to a Receive connector depend on When you use the value Custom, you need to configure individual permissions by using the Add-ADPermission cmdlet. -For more information about the default permissions and security principals for permission groups, see [Receive connector permission groups](https://docs.microsoft.com/Exchange/mail-flow/connectors/receive-connectors#receive-connector-permission-groups). +For more information about the default permissions and security principals for permission groups, see [Receive connector permission groups](https://learn.microsoft.com/Exchange/mail-flow/connectors/receive-connectors#receive-connector-permission-groups). ```yaml Type: PermissionGroups @@ -1498,7 +1498,7 @@ The ProtocolLoggingLevel parameter specifies whether to enable or disable protoc - None: Protocol logging is disabled on the Receive connector. This is the default value. - Verbose: Protocol logging is enabled on the Receive connector. -For more information about protocol logging, see [Protocol logging](https://docs.microsoft.com/Exchange/mail-flow/connectors/protocol-logging). +For more information about protocol logging, see [Protocol logging](https://learn.microsoft.com/Exchange/mail-flow/connectors/protocol-logging). ```yaml Type: ProtocolLoggingLevel @@ -1799,12 +1799,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-RemoteDomain.md b/exchange/exchange-ps/exchange/New-RemoteDomain.md index 9ee6b83594..d482738214 100644 --- a/exchange/exchange-ps/exchange/New-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/New-RemoteDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-remotedomain +online version: https://learn.microsoft.com/powershell/module/exchange/new-remotedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-RemoteDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-RemoteDomain cmdlet to create a managed connection for a remote domain. When you create a remote domain, you can control mail flow with more precision, apply message formatting and messaging policies and specify acceptable character sets for messages sent to and received from the remote domain. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ New-RemoteDomain [-Name] -DomainName ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,35 +42,35 @@ This example creates the remote domain named Contoso for the domain contoso.com ## PARAMETERS -### -DomainName -The DomainName parameter specifies the SMTP domain that you want to establish as a remote domain. A valid value is an SMTP domain (for example, contoso.com). The maximum length is 256 characters. - -You can use the wildcard character (\*) to specify a domain and all subdomains (for example: \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com). +### -Name +The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml -Type: SmtpDomainWithSubdomains +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies a unique name for the remote domain object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +### -DomainName +The DomainName parameter specifies the SMTP domain that you want to establish as a remote domain. A valid value is an SMTP domain (for example, contoso.com). The maximum length is 256 characters. + +You can use the wildcard character (\*) to specify a domain and all subdomains (for example: \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com). ```yaml -Type: String +Type: SmtpDomainWithSubdomains Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -136,12 +136,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-RemoteMailbox.md b/exchange/exchange-ps/exchange/New-RemoteMailbox.md index 1e4cb5f52c..2647a103bb 100644 --- a/exchange/exchange-ps/exchange/New-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/New-RemoteMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-remotemailbox +online version: https://learn.microsoft.com/powershell/module/exchange/new-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-RemoteMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-RemoteMailbox cmdlet to create a mail user in the on-premises Active Directory and also create an associated mailbox in the cloud-based service. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -157,13 +157,14 @@ Directory synchronization must be configured correctly for a mailbox to be creat The policies that you apply to recipients in the on-premises Exchange organization, such as Unified Messaging or compliance policies, aren't applied to mailboxes in the service. You must configure policies in the service if you want policies to be applied to recipients in the service. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $Credentials = Get-Credential + New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com ``` @@ -176,6 +177,7 @@ After the new mail user is created, directory synchronization synchronizes the n ### Example 2 ```powershell $Credentials = Get-Credential + New-RemoteMailbox -Name "Kim Akers" -Password $Credentials.Password -UserPrincipalName kim@corp.contoso.com -OnPremisesOrganizationalUnit "corp.contoso.com/Archive Users" -Archive ``` @@ -208,7 +210,7 @@ Accept wildcard characters: False ``` ### -AccountDisabled -The AccountDisabled switch specifies whether to create the mail user in a disabled state. You don't have to specify a value with this switch. +The AccountDisabled switch specifies whether to create the mail user in a disabled state. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -224,7 +226,7 @@ Accept wildcard characters: False ``` ### -Equipment -The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. +The Equipment switch specifies that the mailbox in the service should be created as an equipment resource mailbox. You don't need to specify a value with this switch. Equipment mailboxes are resource mailboxes that aren't associated with a specific location (for example, vehicles or computers). @@ -246,7 +248,11 @@ Accept wildcard characters: False ### -Password The Password parameter specifies the password used by the mail user to secure his or her account and associated mailbox in the service. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString @@ -275,7 +281,7 @@ Accept wildcard characters: False ``` ### -Room -The Room switch specifies that the mailbox in the service should be created as a room resource mailbox. +The Room switch specifies that the mailbox in the service should be created as a room resource mailbox. You don't need to specify a value with this switch. You can't use the Room switch if you specified the Equipment switch. @@ -358,15 +364,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -611,10 +622,14 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled -The RemotePowerShellEnabled parameter specifies whether the user can connect to Exchange using remote PowerShell. Remote PowerShell is required to open the Exchange Management Shell on Exchange servers, or to use Windows PowerShell open and import a remote PowerShell session to Exchange. Access to remote PowerShell is required even if you're trying to open the Exchange Management Shell on the local Exchange server. Valid values are: +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: + +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value. +- $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. + +Access to Exchange PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. -- $true: The user can use remote PowerShell. This is the default value. -- $false: The user can't use remote PowerShell. +A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. ```yaml Type: Boolean @@ -725,12 +740,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md new file mode 100644 index 0000000000..6ae7128ad5 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionPolicy.md @@ -0,0 +1,1029 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-reportsubmissionpolicy +applicable: Exchange Online +title: New-ReportSubmissionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ReportSubmissionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ReportSubmissionPolicy cmdlet to create the report submission policy in your cloud-based organization. The report submission policy controls most of the user reported message settings in the organization. + +**Note**: If the policy already exists (the Get-ReportSubmissionPolicy cmdlet returns output), you can't use this cmdlet. To delete the existing policy and start over with the default settings, use the Remove-ReportSubmissionPolicy cmdlet first. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ReportSubmissionPolicy + [-DisableQuarantineReportingOption ] + [-DisableUserSubmissionOptions ] + [-EnableCustomizedMsg ] + [-EnableCustomNotificationSender ] + [-EnableOrganizationBranding ] + [-EnableReportToMicrosoft ] + [-EnableThirdPartyAddress ] + [-EnableUserEmailNotification ] + [-JunkReviewResultMessage ] + [-NotificationFooterMessage ] + [-NotificationSenderAddress ] + [-NotificationsForCleanSubmissionAirInvestigationsEnabled ] + [-NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled ] + [-NotificationsForSpamSubmissionAirInvestigationsEnabled ] + [-NotificationsForSubmissionAirInvestigationsEnabled ] + [-NotJunkReviewResultMessage ] + [-OnlyShowPhishingDisclaimer ] + [-PhishingReviewResultMessage ] + [-PostSubmitMessage ] + [-PostSubmitMessageEnabled ] + [-PostSubmitMessageForJunk ] + [-PostSubmitMessageForNotJunk ] + [-PostSubmitMessageForPhishing ] + [-PostSubmitMessageTitle ] + [-PostSubmitMessageTitleForJunk ] + [-PostSubmitMessageTitleForNotJunk ] + [-PostSubmitMessageTitleForPhishing ] + [-PreSubmitMessage ] + [-PreSubmitMessageEnabled ] + [-PreSubmitMessageForJunk ] + [-PreSubmitMessageForNotJunk ] + [-PreSubmitMessageForPhishing ] + [-PreSubmitMessageTitle ] + [-PreSubmitMessageTitleForJunk ] + [-PreSubmitMessageTitleForNotJunk ] + [-PreSubmitMessageTitleForPhishing ] + [-ReportChatMessageEnabled ] + [-ReportChatMessageToCustomizedAddressEnabled ] + [-ReportJunkAddresses ] + [-ReportJunkToCustomizedAddress ] + [-ReportNotJunkAddresses ] + [-ReportNotJunkToCustomizedAddress ] + [-ReportPhishAddresses ] + [-ReportPhishToCustomizedAddress ] + [-ThirdPartyReportAddresses ] + [-UserSubmissionOptions ] + [-UserSubmissionOptionsMessage ] + [] +``` + +## DESCRIPTION +The report submission policy controls most of the settings for user submissions in the Microsoft Defender portal at . + +The report submission rule (\*-ReportSubmissionRule cmdlets) controls the email address of the reporting mailbox where user reported messages are delivered. + +When you set the email address of the reporting mailbox in the Microsoft Defender portal at , the same email address is also set in the following parameters in the \*-ReportSubmissionPolicy cmdlets: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: The ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses parameters. +- Microsoft integrated reporting using third-party tools in Outlook: The ThirdPartyReportAddresses parameter. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ReportSubmissionPolicy +``` + +This example creates the one and only report submission policy named DefaultReportSubmissionPolicy with the default values: reporting in Outlook is on, Microsoft reporting tools in Outlook are used, and reported messages are sent only to Microsoft (the reporting mailbox isn't used). + +### Example 2 +```powershell +$usersub = "reportedmessages@contoso.com" + +New-ReportSubmissionPolicy -ReportJunkToCustomizedAddress $true -ReportJunkAddresses $usersub -ReportNotJunkToCustomizedAddress $true -ReportNotJunkAddresses $usersub -ReportPhishToCustomizedAddress $true -ReportPhishAddresses $usersub + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example creates the report submission policy with the following values: reporting in Outlook is on, Microsoft reporting tools in Outlook are used, and reported messages are sent to Microsoft and the specified reporting mailbox in Exchange Online. + +**Notes**: + +- The default value of the EnableReportToMicrosoft parameter is $true and the default value of the EnableThirdPartyAddress parameter is $false, so you don't need to use them. +- To create the policy, you need to specify the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. +- Like the report submission policy, you can create the report submission rule only if it doesn't already exist. If the rule already exists, you can use Set-ReportSubmissionRule to change the email address of the reporting mailbox, or Remove-ReportSubmissionRule to delete it and recreate it. + +### Example 3 +```powershell +$usersub = "userreportedmessages@fabrikam.com" + +New-ReportSubmissionPolicy -EnableReportToMicrosoft $false -ReportJunkToCustomizedAddress $true -ReportJunkAddresses $usersub -ReportNotJunkToCustomizedAddress $true -ReportNotJunkAddresses $usersub -ReportPhishToCustomizedAddress $true -ReportPhishAddresses $usersub -DisableUserSubmissionOptions $false + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example creates the report submission policy with the following values: reporting in Outlook is on, Microsoft reporting tools in Outlook are used, and reported messages are sent only to the specified reporting mailbox in Exchange Online. + +### Example 4 +```powershell +$usersub = "thirdpartyreporting@wingtiptoys.com" + +New-ReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ThirdPartyReportAddresses $usersub + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example creates the report submission policy with the following values: reporting in Outlook is on and third-party reporting tools in Outlook are used to send reported messages to the specified reporting mailbox in Exchange Online. + +### Example 5 +```powershell +New-ReportSubmissionPolicy -EnableReportToMicrosoft $false +``` + +This example creates the report submission policy with the following values: reporting in Outlook is off. Microsoft reporting tools in Outlook are not available to users and messages reported by third-party tools in Outlook are not available on the Submissions page in the Microsoft Defender portal. + +## PARAMETERS + +### -DisableQuarantineReportingOption +The DisableQuarantineReportingOption parameter allows or prevents users from reporting messages in quarantine. Valid values are: + +- $true: Users can't report quarantined messages from quarantine. +- $false: Users can report quarantined messages from quarantine. This is the default value. + +This parameter is meaningful only reporting in Outlook is enabled as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableUserSubmissionOptions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomizedMsg +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomNotificationSender +The EnableCustomNotificationSender parameter specifies whether a custom sender email address is used for result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Use a custom Microsoft 365 sender email address. +- $false: Use the default sender email address. This is the default value. + +You specify the sender email address using the NotificationSenderAddress parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrganizationBranding +The EnableOrganizationBranding parameter specifies whether to show the company logo in the footer of result messages that users receive after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Use the company logo in the footer text instead of the Microsoft logo. +- $false: Don't use the company logo in the footer text. Use the Microsoft logo. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableReportToMicrosoft +The EnableReportToMicrosoft parameter specifies whether Microsoft integrated reporting experience is enabled or disabled. Valid values are $true or $false. + +The value $true for this parameter enables reporting in Outlook. The following configurations are possible: + +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft only (the reporting mailbox isn't used)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. This is the default result. +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft and reported messages are sent to the specified reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. + +The value $false for this parameter disables reporting in Outlook. The following configurations are possible: + +- **Microsoft reporting tools are available in Outlook, but reported messages are sent only to the reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. +- **Reporting in Outlook is disabled. Microsoft reporting tools are not available in Outlook. Any messages reported by users in Outlook with third-party reporting tools aren't visible on the Submissions page in the Microsoft Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. + +This parameter is required to create the report submission policy only if you set the value to $false (the default value is $true). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableThirdPartyAddress +The EnableThirdPartyAddress parameter specifies whether you're using third-party reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are: + +- $true: Reporting in Outlook is enabled, but third-party tools in Outlook send reported messages to the reporting mailbox in Exchange Online. You also need to set the EnableReportToMicrosoft parameter value to $false. To create the policy, use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. +- $false: Third-party reporting tools in Outlook aren't used. + +This parameter is required to create the report submission policy only if you set the value to $true (the default value is $false). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUserEmailNotification +The EnableUserEmailNotification parameter species whether users receive result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Customized admin review result messages are sent. +- $false: Customized admin review result messages are not sent. + +Use the JunkReviewResultMessage, NotJunkReviewResultMessage, PhishingReviewResultMessage parameters to configure the message body text that's used for each verdict. + +Use the NotificationFooterMessage parameter for the footer that's used for all verdicts (junk, not junk, and phishing). + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JunkReviewResultMessage +The JunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as junk. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotJunkReviewResultMessage +The NotJunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as not junk. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationFooterMessage +The NotificationFooterMessage parameter specifies the custom footer text to use in email notifications after an admin reviews and marks the reported messages as junk, not junk, or phishing. If the value contains spaces, enclose the value in quotation marks. + +You can use the EnableOrganizationBranding parameter to include your company logo in the message footer. + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSenderAddress +The NotificationSenderAddress parameter specifies the sender email address to use in result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. The email address must be in Exchange Online. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForCleanSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForSpamSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlyShowPhishingDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishingReviewResultMessage +The PhishingReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as phishing. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessage +The PostSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageEnabled +{{ Fill PostSubmitMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForJunk +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForNotJunk +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForPhishing +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitle +The PostSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message text using the PostSubmitMessage parameter. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForJunk +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForNotJunk +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForPhishing +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessage +The PreSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageEnabled +{{ Fill PreSubmitMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForJunk +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForNotJunk +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForPhishing +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitle +The PreSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the pop-up message text using the PreSubmitMessage parameter. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForJunk +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForNotJunk +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForPhishing +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageEnabled +{{ Fill ReportChatMessageEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageToCustomizedAddressEnabled +{{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkAddresses +The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +This parameter is required to create the report submission policy if the ReportJunkToCustomizedAddress parameter value is $true. + +You can't use this parameter by itself. You need to specify the same email address for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +You also need to specify the same email address in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkToCustomizedAddress +The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters in the same command. + +This parameter is required to create the report submission policy if you're using reporting in Outlook (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportNotJunkAddresses +The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +This parameter is required to create the report submission policy if the ReportNotJunkToCustomizedAddress parameter value is $true. + +You can't use this parameter by itself. You need to specify the same email address for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +You also need to specify the same email address in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportNotJunkToCustomizedAddress +The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters. + +This parameter is required to create the report submission policy if you're using reporting in Outlook (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPhishAddresses +The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +This parameter is required to create the report submission policy if the ReportPhishToCustomizedAddress parameter value is $true. + +You can't use this parameter by itself. You need to specify the same email address for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +You also need to specify the same email address in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPhishToCustomizedAddress +The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters. + +This parameter is required to create the report submission policy if you're using reporting in Outlook (see the EnableReportToMicrosoft parameter) and sending reported messages to the reporting mailbox (exclusively or in addition to reporting to Microsoft). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyReportAddresses +Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox in Exchange Online when you're using a third-party product for user submissions instead of reporting in Outlook. + +This parameter is required to create the report submission policy if you've disabled reporting in Outlook (`-EnableReportToMicrosoft $false`) and you're using the reporting mailbox with third-party tools (`-EnableThirdPartyAddress $true`). + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSubmissionOptions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSubmissionOptionsMessage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md new file mode 100644 index 0000000000..9128905359 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ReportSubmissionRule.md @@ -0,0 +1,204 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-reportsubmissionrule +applicable: Exchange Online +title: New-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ReportSubmissionRule cmdlet to create the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +**Note**: If the rule already exists (the Get-ReportSubmissionRule cmdlet returns output), you can't use this cmdlet. To delete the existing rule and start over, use the Remove-ReportSubmissionRule cmdlet first. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ReportSubmissionRule [-Name] -ReportSubmissionPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-SentTo ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use this cmdlet only if the following statements are true: + +- The report submission rule doesn't exist (the Get-ReportSubmissionRule cmdlet returns no output). +- The report submission policy exists (the Get-ReportSubmissionPolicy cmdlet returns output). + +The SentTo parameter identifies the email address of the reporting mailbox. Your organization needs a report submission rule only to send user reported messages to the reporting mailbox using Microsoft or third-party reporting tools in Outlook (reporting in Outlook is turned on). + +When you set the email address of the reporting mailbox in the Microsoft Defender portal at , the same email address is also set in the *\-ReportSubmissionPolicy cmdlets: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). +- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. + +When you use this cmdlet to set the email address of the reporting mailbox, the corresponding parameters in the *\-ReportSubmissionPolicy cmdlets are not updated. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo "userreportedmessages@contoso.onmicrosoft.com" +``` + +This example creates the report submission rule. The reporting mailbox is userreportedmessages@contoso.onmicrosoft.com. + +## PARAMETERS + +### -Name +The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportSubmissionPolicy +The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter specifies whether the rule is enabled or disabled. Valid values are: + +- $true: The rule is enabled. This is the default value. +- $false: The rule is disabled. + +After you create the rule, use the Enable-ReportSubmissionRule and Disable-ReportSubmissionRule cmdlets to enable or disable the rule. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent. + +The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): + +- Microsoft integrated reporting is enabled using Microsoft reporting tools in Outlook: `-EnableThirdPartyAddress $false -ReportJunkToCustomizedAddress $true -ReportNotJunkToCustomizedAddress $true -ReportPhishToCustomizedAddress $true`. +- Microsoft integrated reporting is enabled using third-party reporting tools in Outlook: `-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false`. + +If you set the email address of the reporting mailbox in the Microsoft Defender portal, the following parameters in the *\-ReportSubmissionPolicy cmdlets are set to the same value: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). +- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. + +When you use this cmdlet to set the email address of the reporting mailbox, the related parameter values in the *\-ReportSubmissionPolicy cmdlets are not updated, which doesn't affect the functionality of the reporting mailbox. You should update the related values in the \*-ReportSubmissionPolicy cmdlets for consistency and to avoid confusion. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md index 9fc8bc54e0..80238a5236 100644 --- a/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/New-RetentionCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-retentioncompliancepolicy +applicable: Security & Compliance title: New-RetentionCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-RetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-RetentionCompliancePolicy cmdlet to create new retention policies in the Microsoft 365 compliance center. +Use the New-RetentionCompliancePolicy cmdlet to create new retention policies and new retention label policies in the Microsoft Purview compliance portal. Creating a new policy also requires use of the New-RetentionComplianceRule cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,14 +30,20 @@ New-RetentionCompliancePolicy [-Name] [-ExchangeLocation ] [-ExchangeLocationException ] [-Force] + [-IsSimulation] [-ModernGroupLocation ] [-ModernGroupLocationException ] [-OneDriveLocation ] [-OneDriveLocationException ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] + [-PriorityCleanup] [-PublicFolderLocation ] [-RestrictiveRetention ] + [-RetainCloudAttachment ] [-SharePointLocation ] [-SharePointLocationException ] + [-SkipPriorityCleanupConfirmation] [-SkypeLocation ] [-SkypeLocationException ] [-WhatIf] @@ -51,7 +57,11 @@ New-RetentionCompliancePolicy [-Name] [-Confirm] [-Enabled ] [-Force] + [-IsSimulation] + [-PriorityCleanup] [-RestrictiveRetention ] + [-RetainCloudAttachment ] + [-SkipPriorityCleanupConfirmation] [-TeamsChannelLocation ] [-TeamsChannelLocationException ] [-TeamsChatLocation ] @@ -60,21 +70,47 @@ New-RetentionCompliancePolicy [-Name] [] ``` +### AdaptiveScopeLocation +``` +New-RetentionCompliancePolicy [-Name] -AdaptiveScopeLocation + [-Applications ] + [-Comment ] + [-Confirm] + [-Enabled ] + [-Force] + [-IsSimulation] + [-PriorityCleanup] + [-RestrictiveRetention ] + [-RetainCloudAttachment ] + [-SkipPriorityCleanupConfirmation] + [-WhatIf] + [] +``` + ## DESCRIPTION -New policies are not valid and will not be applied until a retention rule is added to the policy. For more information, see [New-RetentionComplianceRule](New-RetentionComplianceRule.md). In addition, at least one location parameter must be defined to create a retention policy. +Policies are not valid until a rule is added (for retention policies) or a label is added (for retention label policies). For more information, see [New-RetentionComplianceRule](/powershell/module/exchange/new-retentioncompliancerule). In addition, at least one location parameter must be defined to create a retention policy or retention label policy. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal]/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell New-RetentionCompliancePolicy -Name "Regulation 123 Compliance" -ExchangeLocation "Kitty Petersen", "Scott Nakamura" -SharePointLocation "https://contoso.sharepoint.com/sites/teams/finance" -New-RetentionComplianceRule -Name RetUnlimited -Policy "Regulation 123 Compliance" -RetentionDuration Unlimited ``` -The first command in this example creates a retention policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint Online site. -The second command creates a new retention rule named "RetUnlimited" and adds it to the retention policy created with the fist command. +This example creates a retention policy named "Regulation 123 Compliance" for the mailboxes of Kitty Petersen and Scott Nakamura, and the finance SharePoint site. + +The next step is to use the New-RetentionComplianceRule cmdlet to add a rule to the retention policy. + +### Example 2 +```powershell +New-RetentionCompliancePolicy -Name "Marketing Department" -Enabled $true -SharePointLocation https://contoso.sharepoint.com -RetainCloudAttachment $true -Comment "Regulatory compliance for Marketing Dept." +``` + +This example creates a new auto-apply label policy targeted to cloud attachments named Marketing Department with the specified details. + +The next step is to use the New-RetentionComplianceRule cmdlet to add a retention label to the retention label policy. ## PARAMETERS @@ -85,7 +121,7 @@ The Name parameter specifies the unique name of the retention policy. If the val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -94,19 +130,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AdaptiveScopeLocation +The AdaptiveScopeLocation parameter specifies the adaptive scope location to include in the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Applications The Applications parameter specifies the target when Microsoft 365 Groups are included in the policy (the ModernGroups parameter is set). Valid values are: - `Group:Exchange` for the mailbox that's connected to the Microsoft 365 Group. - `Group:SharePoint` for the SharePoint site that's connected to the Microsoft 365 Group. -- `"Group:Exchange","Group:SharePoint"` for both the mailbox and the SharePoint site that are connected to the Microsoft 365 Group. -- blank (`$null`): This is the default value, and is functionally equivalent to the value `"Group:Exchange","Group:SharePoint"`. +- `"Group:Exchange,SharePoint"` for both the mailbox and the SharePoint site that are connected to the Microsoft 365 Group. +- blank (`$null`): This is the default value, and is functionally equivalent to the value `"Group:Exchange,SharePoint"`. ```yaml Type: MultiValuedProperty -Parameter Sets: Default +Parameter Sets: Default, AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -122,7 +178,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -141,7 +197,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -160,7 +216,7 @@ The Enabled parameter specifies whether the policy is enabled or disabled. Valid Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -170,7 +226,7 @@ Accept wildcard characters: False ``` ### -ExchangeLocation -The ExchangeLocation parameter specifies the mailboxes to include. Valid values are: +The ExchangeLocation parameter specifies the mailboxes to include in the policy. Valid values are: - A mailbox - A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). @@ -191,7 +247,7 @@ If no mailboxes are specified, then no mailboxes are placed on hold. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -201,7 +257,7 @@ Accept wildcard characters: False ``` ### -ExchangeLocationException -This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: +The ExchangeLocationException parameter specifies the mailboxes to exclude from the policy when you use the value All for the ExchangeLocation parameter. Valid values are: - A mailbox - A distribution group or mail-enabled security group @@ -219,7 +275,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -229,13 +285,33 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsSimulation +The IsSimulation switch specifies the policy is created in simulation mode. You don't need to specify a value with this switch. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -263,7 +339,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -273,7 +349,7 @@ Accept wildcard characters: False ``` ### -ModernGroupLocationException -The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude when you're using the value All for the ModernGroupLocation parameter. +The ModernGroupLocationException parameter specifies the Microsoft 365 Groups to exclude from the policy when you use the value All for the ModernGroupLocation parameter. You can use any value that uniquely identifies the Microsoft 365 Group. For example: @@ -288,7 +364,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -298,7 +374,7 @@ Accept wildcard characters: False ``` ### -OneDriveLocation -The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +The OneDriveLocation parameter specifies the OneDrive sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -306,7 +382,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -316,7 +392,7 @@ Accept wildcard characters: False ``` ### -OneDriveLocationException -This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. +This parameter specifies the OneDrive sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -324,7 +400,59 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +**Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. + +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +The PriorityCleanup switch specifies whether to create a [Priority Cleanup](https://learn.microsoft.com/purview/priority-cleanup) policy to expedite the deletion of sensitive content, overriding any existing retention settings or eDiscovery holds. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -340,7 +468,7 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -363,7 +491,38 @@ Therefore, before you lock a retention policy, it's critical that you understand Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetainCloudAttachment +**Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. + +The RetainCloudAttachment parameter specifies that this is a cloud attachment policy. Valid values are: + +- $true: The policy is a cloud attachment policy. +- $false: The policy is not a cloud attachment policy. This is the default value. + +For the value $true, you can only use the following location parameters: + +- SharePointLocation and SharePointLocationException +- OneDriveLocation and OneDriveLocationException +- ModernGroupLocation and ModernGroupLocationException + +A tag that uses a cloud attachment policy to create a rule can be a record label or a regulatory label. You can't use a publishing tag for a cloud attachment policy to create a rule; only apply tags are supported. + +The RetainCloudAttachment parameter is not available on the Set-RetentionCompliancePolicy cmdlet. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -373,17 +532,17 @@ Accept wildcard characters: False ``` ### -SharePointLocation -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. +SharePoint sites can't be added to the policy until they have been indexed. If no sites are specified, then no sites are placed on hold. ```yaml Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -393,7 +552,7 @@ Accept wildcard characters: False ``` ### -SharePointLocationException -This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +This parameter specifies the SharePoint sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -401,7 +560,23 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipPriorityCleanupConfirmation +{{ Fill SkipPriorityCleanupConfirmation Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -426,7 +601,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -442,7 +617,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -466,7 +641,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -488,7 +663,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -513,7 +688,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -536,7 +711,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -546,13 +721,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -566,12 +741,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md index ad7f473874..c7471abe72 100644 --- a/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/New-RetentionComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-retentioncompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-retentioncompliancerule +applicable: Security & Compliance title: New-RetentionComplianceRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-RetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-RetentionComplianceRule cmdlet to create new retention rules in the Microsoft 365 compliance center. +Use the New-RetentionComplianceRule cmdlet to create new retention rules in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +27,9 @@ New-RetentionComplianceRule -ApplyComplianceTag -Policy ] [-ExpirationDateOption ] + [-IRMRiskyUserProfiles ] [-MachineLearningModelIDs ] + [-PriorityCleanup] [-RetentionComplianceAction ] [-WhatIf] [] @@ -43,6 +45,7 @@ New-RetentionComplianceRule [-Name] -Policy [-Confirm] [-ContentMatchQuery ] [-ExpirationDateOption ] + [-PriorityCleanup] [-RetentionComplianceAction ] [-WhatIf] [] @@ -53,6 +56,7 @@ New-RetentionComplianceRule [-Name] -Policy New-RetentionComplianceRule -Policy -PublishComplianceTag [-Confirm] [-ExpirationDateOption ] + [-PriorityCleanup] [-RetentionComplianceAction ] [-WhatIf] [] @@ -61,19 +65,44 @@ New-RetentionComplianceRule -Policy -PublishComplianceTag ## DESCRIPTION Retention policy tags are associated with a retention policy. When a retention policy is applied to a mailbox, tags associated with the policy are available to the mailbox user. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -113,9 +113,18 @@ Accept wildcard characters: False ### -IsDefault This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +The IsDefault switch specifies that this retention policy is the default retention policy. You don't need to specify a value with this switch. -To set the default retention policy for new mailboxes, use the RetentionPolicy parameter on the Set-MailboxPlan cmdlet. +When you use this switch, you'll get a warning that this retention policy will replace the current default retention policy (the policy where the IsDefault property value is currently True) as the default. By default, the default retention policy is named Default MRM Policy. + +**Note**: Changing which retention policy is the default might or might not affect new and existing mailboxes based on the value of the RetentionPolicy parameter on all mailbox plans: + +- $null (blank): Changes to which retention policy is the default are continually reflected in new and existing mailboxes. +- A retention policy is specified: The value of the RetentionPolicy parameter for all mailbox plans should be $null (blank) or match the Exchange retention policy that's configured as default policy for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. For more information see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). + +If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. + +Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. ```yaml Type: SwitchParameter @@ -133,7 +142,7 @@ Accept wildcard characters: False ### -IsDefaultArbitrationMailbox This parameter is available only in the cloud-based service. -The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. +The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -201,12 +210,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md index f9e13b64a4..a320464cfa 100644 --- a/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/New-RetentionPolicyTag.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-retentionpolicytag +online version: https://learn.microsoft.com/powershell/module/exchange/new-retentionpolicytag applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-RetentionPolicyTag schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-RetentionPolicyTag cmdlet to create a retention tag. -For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). +For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -71,7 +71,7 @@ Retention tags are used to apply message retention settings to folders and items Retention tags support a display of the tag name and an optional comment in localized languages. Language culture codes from the CultureInfo class are used for this purpose. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,7 +120,7 @@ This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: RecipientIdParameter Parameter Sets: RetentionPolicy Aliases: Applicable: Exchange Server 2010 @@ -243,7 +243,7 @@ This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: Boolean Parameter Sets: RetentionPolicy Aliases: Applicable: Exchange Server 2010 @@ -517,12 +517,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md index eca8cf7a15..37d991b855 100644 --- a/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-RoleAssignmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-roleassignmentpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-roleassignmentpolicy +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-RoleAssignmentPolicy schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-RoleAssignmentPolicy cmdlet to create management role assignment policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,17 +34,18 @@ New-RoleAssignmentPolicy [-Name] ## DESCRIPTION When you create an assignment policy, you can assign it to users using the New-Mailbox, Set-Mailbox, or Enable-Mailbox cmdlets. If you make the new assignment policy the default assignment policy, it's assigned to all new mailboxes that don't have an explicit assignment policy assigned to them. -You can add management roles to the new assignment policy when you create it, or you can create the assignment policy and add roles later. You must assign at least one management role to the new assignment policy for it to apply permissions to a mailbox. Without any roles assigned to the new assignment policy, users assigned to it won't be able to manage their mailbox configuration. To assign a management role after the assignment policy has been created, use the New-ManagementRoleAssignment cmdlet. For more information, see [Manage role assignment policies](https://docs.microsoft.com/Exchange/permissions/role-assignment-policies). +You can add management roles to the new assignment policy when you create it, or you can create the assignment policy and add roles later. You must assign at least one management role to the new assignment policy for it to apply permissions to a mailbox. Without any roles assigned to the new assignment policy, users assigned to it won't be able to manage their mailbox configuration. To assign a management role after the assignment policy has been created, use the New-ManagementRoleAssignment cmdlet. For more information, see [Manage role assignment policies](https://learn.microsoft.com/Exchange/permissions/role-assignment-policies). -For more information about assignment policies, see [Understanding management role assignment policies](https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). +For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell New-RoleAssignmentPolicy -Name "End User Policy" + Set-Mailbox -Identity Joe -RoleAssignmentPolicy "End User Policy" ``` @@ -60,6 +61,7 @@ This example creates an assignment policy using the IsDefault switch. ### Example 3 ```powershell New-RoleAssignmentPolicy -Name "Limited End User Policy" -Roles "MyPersonalInformation", "MyDistributionGroupMembership", "MyVoiceMail" -IsDefault + Get-Mailbox -ResultSize Unlimited | Set-Mailbox -RoleAssignmentPolicy "Limited End User Policy" ``` @@ -78,7 +80,7 @@ The Name parameter specifies the name of the new assignment policy. If the assig Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -97,7 +99,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -113,7 +115,7 @@ The Description parameter specifies the description that's displayed when the ro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -143,7 +145,7 @@ Accept wildcard characters: False ``` ### -IsDefault -The IsDefault switch makes the assignment policy the default assignment policy. You don't have to specify a value with this switch. +The IsDefault switch makes the assignment policy the default assignment policy. You don't need to specify a value with this switch. New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. @@ -153,7 +155,7 @@ Setting an assignment policy as default doesn't change the role assignment on ex Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -165,13 +167,13 @@ Accept wildcard characters: False ### -Roles The Roles parameter specifies the management roles to assign to the role assignment policy when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. -For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://docs.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). +For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://learn.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). ```yaml Type: RoleIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -187,7 +189,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -201,12 +203,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-RoleGroup.md b/exchange/exchange-ps/exchange/New-RoleGroup.md index 68d1c43c69..308719a319 100644 --- a/exchange/exchange-ps/exchange/New-RoleGroup.md +++ b/exchange/exchange-ps/exchange/New-RoleGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-rolegroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-rolegroup +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: New-RoleGroup schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-RoleGroup cmdlet to create management role groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -66,9 +66,9 @@ You don't have to add members or assign management roles to the role group when When you create a role group, you can create the group and add members to it directly, or you can create a linked role group. A linked role group links the role group to a universal security group (USG) in another forest. Creating a linked role group is useful if your servers running Exchange reside in a resource forest and your users and administrators reside in a separate user forest. If you create a linked role group, you can't add members directly to it. You must add the members to the USG in the foreign forest. -For more information about role groups, see [Understanding management role groups](https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). +For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -96,6 +96,7 @@ This example creates a role group and enables Isabel to add or remove members to ### Example 4 ```powershell $Credentials = Get-Credential + New-RoleGroup -Name "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Administrators" -CustomRecipientWriteScope "Toronto Recipients" -Roles "Mail Recipients" ``` @@ -106,6 +107,7 @@ The first command retrieves the credentials using the Get-Credential cmdlet and ### Example 5 ```powershell $RoleGroup = Get-RoleGroup "Recipient Management" + New-RoleGroup "Limited Recipient Management" -Roles $RoleGroup.Roles ``` @@ -113,7 +115,7 @@ This example takes an existing role group and copies the roles from that role gr The first command stores the existing role group in a variable, and the second command creates the custom role group. -This example uses variables to store information. For more information about variables, see [About Variables](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_variables). +This example uses variables to store information. For more information about variables, see [About Variables](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_variables). ### Example 6 ```powershell @@ -124,6 +126,24 @@ This example removes the role assignment between the Distribution Groups managem ## PARAMETERS +### -Name +The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks ("). + +**Note**: If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LinkedDomainController This parameter is available only in on-premises Exchange. @@ -164,24 +184,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks ("). - -**Note**: If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection - -Required: True -Position: 1 -Default value: None -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. @@ -192,7 +194,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -246,7 +248,7 @@ The Description parameter specifies the description that's displayed when the ro Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -256,13 +258,13 @@ Accept wildcard characters: False ``` ### -DisplayName -The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter can have a maximum length of 256 characters. +The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter has a maximum length of 256 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -292,13 +294,15 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -308,7 +312,7 @@ Accept wildcard characters: False ``` ### -Id -This parameter is available only in Security & Compliance Center PowerShell. +This parameter is available only in Security & Compliance PowerShell. This parameter is reserved for internal Microsoft use. @@ -316,7 +320,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: Default Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -330,7 +334,7 @@ This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -374,7 +378,7 @@ If you use the Members parameter, you can't use the LinkedForeignGroup, LinkedDo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -404,13 +408,13 @@ Accept wildcard characters: False ### -Roles The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. -For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://docs.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). +For a list of built-in management roles that you can assign to a role group, see [Built-in management roles](https://learn.microsoft.com/exchange/built-in-management-roles-exchange-2013-help). ```yaml Type: RoleIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -456,7 +460,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -464,7 +468,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -478,12 +482,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md index 59a97c4f37..4fd4b16fbf 100644 --- a/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md +++ b/exchange/exchange-ps/exchange/New-RoutingGroupConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-routinggroupconnector +online version: https://learn.microsoft.com/powershell/module/exchange/new-routinggroupconnector applicable: Exchange Server 2010 title: New-RoutingGroupConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the New-RoutingGroupConnector cmdlet to establish a connection between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group when the organization is running more than one version of Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ The New-RoutingGroupConnector cmdlet creates a new routing group connector betwe To create the routing group connector, you must specify the source servers from the originating routing group and the target servers in the destination routing group. The routing group connector is created in the routing group of which the source server is a member. By using the Bidirectional parameter, you can specify whether the connector is used for one-way or two-way mail flow. If you specify a two-way connector, a reciprocal connector is created in the target routing group. The source and target servers must be Exchange 2010 Hub Transport servers or Exchange 2003 bridgehead servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -206,12 +206,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-RpcClientAccess.md b/exchange/exchange-ps/exchange/New-RpcClientAccess.md index 700a2c6f64..183a022952 100644 --- a/exchange/exchange-ps/exchange/New-RpcClientAccess.md +++ b/exchange/exchange-ps/exchange/New-RpcClientAccess.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-rpcclientaccess +online version: https://learn.microsoft.com/powershell/module/exchange/new-rpcclientaccess applicable: Exchange Server 2010 title: New-RpcClientAccess schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the New-RpcClientAccess cmdlet to create configuration information for the Exchange RPC Client Access service on a Client Access server. This set up task is performed by default on new installations of the Client Access server role on Microsoft Exchange Server 2010. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ New-RpcClientAccess -Server ## DESCRIPTION After you run this command, you must start the Exchange RPC Client Access service on the Exchange Client Access server to enable RPC client access. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -178,12 +178,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md index a56bf839f1..7bd53126c9 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-safeattachmentpolicy +applicable: Exchange Online title: New-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -16,19 +16,18 @@ This cmdlet is available only in the cloud-based service. Use the New-SafeAttachmentPolicy cmdlet to create safe attachment policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` New-SafeAttachmentPolicy [-Name] [-Action ] - [-ActionOnError ] [-AdminDisplayName ] [-Confirm] [-Enable ] + [-MakeBuiltInProtection] + [-QuarantineTag ] [-RecommendedPolicyType ] [-Redirect ] [-RedirectAddress ] @@ -37,13 +36,13 @@ New-SafeAttachmentPolicy [-Name] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). -New safe attachment policies that you create using this cmdlet aren't applied to users and aren't visible in the admin center. You need to use the SafeAttachmentPolicy parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets to associate the policy with a rule to create a complete Safe Attachments policy that's visible in the admin center. +New safe attachment policies that you create using this cmdlet aren't applied to users and aren't visible in the Microsoft Defender portal. You need to use the SafeAttachmentPolicy parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets to associate the policy with a rule to create a complete Safe Attachments policy that's visible in the Defender portal. A safe attachment policy can be assigned to only one safe attachment rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,7 +67,7 @@ The Name parameter specifies a unique name for the safe attachment policy. If th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -80,14 +79,13 @@ Accept wildcard characters: False ### -Action The Action parameter specifies the action for the safe attachment policy. Valid values are: -- Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the admin center. +- Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the Microsoft Defender portal. - Block: Block the email message that contains the malware attachment. This is the default value. -- Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. -- DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [How Dynamic Delivery works](https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). +- DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [Dynamic Delivery in Safe Attachments policies](https://learn.microsoft.com/defender-office-365/safe-attachments-about#dynamic-delivery-in-safe-attachments-policies). -The value of this parameter is meaningful only if the value of the Enable parameter is also $true (the default value is $false). +The value of this parameter is meaningful only when the value of the Enable parameter is $true (the default value is $false). -To specify no action for the safe attachment policy (corresponds to **Off** for the **Safe Attachments unknown malware response** property of the policy in the admin center), don't use the Enable parameter (the default value is $false). +To specify no action for the safe attachment policy (corresponds to the value **Off** for the **Safe Attachments unknown malware response** policy setting in the Defender portal), use the value $false for the Enable parameter. The results of all actions are available in message trace. @@ -95,26 +93,7 @@ The results of all actions are available in message trace. Type: SafeAttachmentAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActionOnError -The ActionOnError parameter specifies the error handling option for Safe Attachments scanning (what to do if attachment scanning times out or an error occurs). Valid values are: - -- $true: This is the default value. The action specified by the Action parameter is applied to messages even when the attachments aren't successfully scanned. This value is required when the Redirect parameter value is $true. Otherwise, messages might be lost. -- $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -130,7 +109,7 @@ The AdminDisplayName parameter specifies a description for the policy. If the va Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -149,7 +128,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -162,15 +141,57 @@ Accept wildcard characters: False The Enable parameter works with the Action parameter to specify the action for the safe attachment policy. Valid values are: - $true: The Action parameter specifies the action for the Safe Attachment policy. -- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. This value corresponds to **Off** for the **Safe Attachments unknown malware response** property of the policy in the admin center. +- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. This value corresponds to the **Off** selection for the **Safe Attachments unknown malware response** setting of the policy in the Microsoft Defender portal. -To enable or disable a complete Safe Attachments policy in the admin center (the combination of the rule and the corresponding associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. +To enable or disable a complete Safe Attachments policy in the Microsoft Defender portal (the combination of the rule and the corresponding associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MakeBuiltInProtection +The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this switch yourself. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineTag +The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware by Safe Attachments. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the built-in quarantine policy named AdminOnlyAccessPolicy is used. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware by Safe Attachments as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -180,13 +201,13 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType -The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this parameter yourself. +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -196,16 +217,16 @@ Accept wildcard characters: False ``` ### -Redirect -The Redirect parameter specifies whether to deliver messages that were identified by Safe Attachments as containing malware attachments to another email address. Valid values are: +The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: -- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is required when the ActionOnError parameter value is $true. Otherwise, messages might be lost. +- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is meaningful only when the value of the Action parameter is Allow. - $false: Messages that contain malware attachments aren't delivered to another email address. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -215,13 +236,15 @@ Accept wildcard characters: False ``` ### -RedirectAddress -The RedirectAddress parameter specifies the email address to deliver messages that were identified by Safe Attachments as containing malware attachments when the Redirect parameter is set to the value $true. +The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. + +The value of this parameter is meaningful only when value of the Redirect parameter is $true and the value of the Action parameter is Allow. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -237,7 +260,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -251,12 +274,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md index 81c360461d..373513e1c0 100644 --- a/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/New-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-safeattachmentrule +applicable: Exchange Online title: New-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-SafeAttachmentRule cmdlet to create safe attachment rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,9 +41,12 @@ You need to specify at least one condition for the rule. A safe attachment policy can be assigned only to one safe attachment rule. -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Safe Attachments policy settings](https://learn.microsoft.com/defender-office-365/safe-attachments-about#safe-attachments-policy-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -69,7 +70,7 @@ The Name parameter specifies a unique name for the safe attachment rule. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -93,7 +94,7 @@ You can't specify a safe attachment policy that's already associated with anothe Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -109,7 +110,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -128,7 +129,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -140,7 +141,7 @@ Accept wildcard characters: False ### -Enabled The Enabled parameter specifies whether the rule is enabled. Valid values are: -- $true: The rule is enabled. Ths is the default value. +- $true: The rule is enabled. This is the default value. - $false: The rule is disabled. In the properties of the rule, the value of this parameter is visible in the State property. @@ -149,7 +150,7 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -159,13 +160,13 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -190,7 +191,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -200,7 +201,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -217,7 +218,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -241,7 +242,7 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -251,13 +252,13 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -282,7 +283,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -292,7 +293,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -309,7 +310,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -325,7 +326,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -339,12 +340,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md index 40abce4221..07d98d9dab 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-safelinkspolicy +applicable: Exchange Online title: New-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-SafeLinksPolicy cmdlet to create Safe Links policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,42 +27,41 @@ New-SafeLinksPolicy [-Name] [-Confirm] [-CustomNotificationText ] [-DeliverMessageAfterScan ] - [-DoNotAllowClickThrough ] + [-DisableUrlRewrite ] [-DoNotRewriteUrls ] - [-DoNotTrackUserClicks ] [-EnableForInternalSenders ] [-EnableOrganizationBranding ] + [-EnableSafeLinksForEmail ] + [-EnableSafeLinksForOffice ] [-EnableSafeLinksForTeams ] - [-ExcludedUrls ] - [-IsEnabled ] + [-MakeBuiltInProtection] [-RecommendedPolicyType ] [-ScanUrls ] [-TrackClicks ] [-UseTranslatedNotificationText ] [-WhatIf] - [-WhiteListedUrls ] [] ``` ## DESCRIPTION -Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links to see if they lead to malicious web sites. When a user clicks a link, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. New policies that you create using this cmdlet aren't applied to users and aren't visible in admin centers. You need to use the SafeLinksPolicy parameter on the New-SafeLinksRule or Set-SafeLinksRule cmdlets to associate the policy with a rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-SafeLinksPolicy -Name "Marketing Block URL" -IsEnabled $true -TrackClicks $true +New-SafeLinksPolicy -Name "Marketing Block URL" -EnableSafeLinksForEmail $true -AllowClickThrough $false ``` This example creates a new Safe Links policy named Marketing Block URL with the following options: - The policy is enabled. -- Users aren't allowed to click through to the original URL. This is the default value of the DoNotAllowClickThrough parameter, so you don't need to specify it. -- User clicks on URLs are tracked in URL trace. +- Users aren't allowed to click through to the original URL. +- User clicks on URLs are tracked. This is the default value of the TrackClicks parameter, so you don't need to specify it. ## PARAMETERS @@ -75,7 +72,7 @@ The Name parameter specifies a unique name for the Safe Links policy. If the val Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -91,7 +88,7 @@ The AdminDisplayName parameter specifies a description for the policy. If the va Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -101,13 +98,18 @@ Accept wildcard characters: False ``` ### -AllowClickThrough -This parameter has been deprecated. Use the DoNotAllowClickThrough parameter instead. +The AllowClickThrough parameter specifies whether users are allowed to click through to the original URL on warning pages. Valid values are: + +- $true: The user is allowed to click through to the original URL. +- $false: The user isn't allowed to click through to the original URL. + +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -126,7 +128,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -142,7 +144,7 @@ The custom notification text specifies the customized notification text to show Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -154,14 +156,14 @@ Accept wildcard characters: False ### -DeliverMessageAfterScan The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: -- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. -- $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. +- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. This is the default value. +- $false: If Safe Links scanning can't complete, deliver the message anyway. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -170,17 +172,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DoNotAllowClickThrough -The DoNotAllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: +### -DisableUrlRewrite +The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: -- $true: The user isn't allowed to click through to the original URL. -- $false: The user is allowed to click through to the original URL. This is the default value. +- $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). +- $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. This is the default value. + +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -196,13 +200,13 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). +For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://learn.microsoft.com/defender-office-365/safe-links-about#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -211,17 +215,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DoNotTrackUserClicks -The DoNotTrackUserClicks parameter specifies whether to track user clicks related to Safe Links protection of links in email messages. Valid values are: +### -EnableForInternalSenders +The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: -- $true: User clicks in email messages aren't tracked. -- $false: User clicks in email messages are tracked. This is the default value. +- $true: The policy is applied to internal and external senders. This is the default value. +- $false: The policy is applied only to external senders. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -230,17 +234,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableForInternalSenders -The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: +### -EnableOrganizationBranding +The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: -- $true: The policy is applied to internal and external senders. -- $false: The policy is applied only to external senders. This is the default value. +- $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. +- $false: Organization branding is not displayed on Safe Links warning and notification pages. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -249,17 +253,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOrganizationBranding -The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: +### -EnableSafeLinksForEmail +The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: -- $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://docs.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. -- $false: Organization branding is not displayed on Safe Links warning and notification pages. +- $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for email. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -268,19 +272,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSafeLinksForTeams -**Note**: As of March 2020, this parameter is in Preview and is available or functional only for members of the Microsoft Teams Technology Adoption Program (TAP). +### -EnableSafeLinksForOffice +The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: -The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: +- $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Office apps. -- $true: Safe Links is enabled for Teams. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. -- $false: Safe Links isn't enabled for Teams. This is the default value. +Note that this protection applies to links in Office documents, not links in email messages. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -289,14 +293,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedUrls -This parameter has been deprecated. Use the DoNotRewriteUrls parameter instead. +### -EnableSafeLinksForTeams +The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: + +- $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Teams. ```yaml -Type: String[] +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -305,17 +312,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsEnabled -The IsEnabled parameter specifies whether to enable Safe Links protection for email messages. Valid values are: - -- $true: Enable Safe Links protection for email messages. Rewrite URLs and check against a list of known malicious links whenever a user clicks a link in an email message. -- $false: Disable Safe Links protection for email messages. Don't rewrite URLs and do not check clicked links in email messages. This is the default value. +### -MakeBuiltInProtection +The MakeBuiltInProtection switch is used for Built-in protection policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this switch yourself. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -325,13 +329,13 @@ Accept wildcard characters: False ``` ### -RecommendedPolicyType -The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies). Don't use this parameter yourself. +The RecommendedPolicyType parameter is used for Standard and Strict policy creation as part of [Preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies). Don't use this parameter yourself. ```yaml Type: RecommendedPolicyType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -343,14 +347,14 @@ Accept wildcard characters: False ### -ScanUrls The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: -- $true: Real-time scanning of clicked links in email messages, including links that point to files, is enabled. -- $false: Real-time scanning of clicked links in email messages, including links that point to files, is disabled. This is the default value. +- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. +- $false: Real-time scanning of clicked links, including links that point to files, is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -360,13 +364,16 @@ Accept wildcard characters: False ``` ### -TrackClicks -This parameter has been deprecated. Use the DoNotTrackUserClicks parameter instead. +The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links. Valid values are: + +- $true: User clicks messages are tracked. This is the default value. +- $false: User clicks messages aren't tracked. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -385,7 +392,7 @@ The UseTranslatedNotificationText specifies whether to use Microsoft Translator Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -401,23 +408,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhiteListedUrls -This parameter has been deprecated. Use the DoNotRewriteUrls parameter instead. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -431,12 +422,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SafeLinksRule.md b/exchange/exchange-ps/exchange/New-SafeLinksRule.md index 67543e3144..33a08f67c7 100644 --- a/exchange/exchange-ps/exchange/New-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/New-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-safelinksrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-safelinksrule +applicable: Exchange Online title: New-SafeLinksRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the New-SafeLinksRule cmdlet to create Safe Links rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +41,10 @@ You need to specify at least one condition for the rule. Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Recipient filters in Safe Links policies](https://learn.microsoft.com/defender-office-365/safe-links-about#recipient-filters-in-safe-links-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -56,7 +57,32 @@ This example creates a new Safe Links rule named Research Department URL Rule wi - The rule is associated with the Safe Links policy named Research Block URL. - The rule applies to members of the group named Research Department. +- Because we aren't using the Priority parameter, the default priority is used. - The rule doesn't apply to members of the group named Research Department Managers. +- The rule is enabled (we aren't using the Enabled parameter, and the default value is `$true`). + +### Example 2 +```powershell +New-SafeLinksRule -Name "Contoso All" -SafeLinksPolicy "Contoso All" -RecipientDomainIs (Get-AcceptedDomain).Name +``` + +This example creates a Safe Links rule named Contoso All with the following conditions: + +- The rule is associated with the Safe Links policy named Contoso All. +- The rule applies to recipients in all accepted domains in the organization. +- Because we aren't using the Priority parameter, the default priority is used. +- The rule is enabled (we aren't using the Enabled parameter, and the default value is `$true`). + +### Example 3 +```powershell +$Data = Import-Csv -Path "C:\Data\SafeLinksDomains.csv" + +$SLDomains = $Data.Domains + +New-SafeLinksRule -Name "Contoso All" -SafeLinksPolicy "Contoso All" -RecipientDomainIs $SLDomains +``` + +This example is similar to Example 2, but in this example, the rule applies to recipients in the domains specified in a .csv file. ## PARAMETERS @@ -67,7 +93,7 @@ The Name parameter specifies a unique name for the Safe Links rule. If the value Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -91,7 +117,7 @@ You can't specify a Safe Links policy that's already associated with another Saf Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: Named @@ -107,7 +133,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -126,7 +152,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -147,7 +173,7 @@ In the properties of the rule, the value of this parameter is visible in the Sta Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -157,13 +183,13 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -188,7 +214,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -198,7 +224,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -215,7 +241,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -239,7 +265,7 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -249,13 +275,13 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -280,7 +306,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -290,7 +316,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -307,7 +333,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -323,7 +349,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -337,12 +363,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md index 06479c9844..2f54d72235 100644 --- a/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md +++ b/exchange/exchange-ps/exchange/New-SearchDocumentFormat.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-searchdocumentformat +online version: https://learn.microsoft.com/powershell/module/exchange/new-searchdocumentformat applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-SearchDocumentFormat schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-SearchDocumentFormat cmdlet to add a format-specific filter to those used by Exchange search. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ New-SearchDocumentFormat [-Identity] -Extension -SentTo [-Comment ] [-Confirm] + [-DomainController ] [-Enabled ] + [-Force] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-SecOpsOverridePolicy -Name SecOpsOverridePolicy -SendTo secops@contoso.com +New-SecOpsOverridePolicy -Name SecOpsOverridePolicy -SentTo secops@contoso.com ``` This example creates the SecOps mailbox override policy with the specified settings. @@ -50,7 +52,7 @@ The Name parameter specifies the name for the SecOps mailbox override policy. Re Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: True Position: 0 @@ -68,7 +70,7 @@ You can specify multiple email addresses separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: True Position: Named @@ -84,7 +86,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -103,7 +105,23 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -122,7 +140,25 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -132,13 +168,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -152,12 +188,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/New-SecOpsOverrideRule.md deleted file mode 100644 index eb60e38594..0000000000 --- a/exchange/exchange-ps/exchange/New-SecOpsOverrideRule.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-secopsoverriderule -applicable: Security & Compliance Center -title: New-SecOpsOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# New-SecOpsOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the New-SecOpsOverrideRule cmdlet to create SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -New-SecOpsOverrideRule [-Name] -Policy - [-Comment ] - [-Confirm] - [-SentTo ] - [-WhatIf] - [] -``` - -## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -## EXAMPLES - -### Example 1 -```powershell -New-SecOpsOverrideRule -Name SecOpsOverrideRule -Policy SecOpsOverridePolicy -``` - -This example creates the SecOps mailbox override rule with the specified settings. - -## PARAMETERS - -### -Name -The Name parameter specifies the name for the policy. Regardless of the value you specify, the name will be SecOpsOverrideRule\ where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -The Policy parameter specifies the phishing simulation override policy that's associated with the rule. You can use any value that uniquely identifies the policy. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: Default, PublishComplianceTag, ComplianceTag, SetRawXml -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SentTo -This parameter is reserved for internal Microsoft use. - -```yaml -Type: MultiValuedProperty -Parameter Sets: Default -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SendConnector.md b/exchange/exchange-ps/exchange/New-SendConnector.md index 576dc5357d..bb0b4fa218 100644 --- a/exchange/exchange-ps/exchange/New-SendConnector.md +++ b/exchange/exchange-ps/exchange/New-SendConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-sendconnector +online version: https://learn.microsoft.com/powershell/module/exchange/new-sendconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-SendConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-SendConnector cmdlet to create a new Send connector. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -105,7 +105,7 @@ New-SendConnector [-Name] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,6 +122,7 @@ This example creates the Send connector named MySendConnector with the following ### Example 2 ```powershell $CredentialObject = Get-Credential + New-SendConnector -Name "Secure Email to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth ``` @@ -172,7 +173,7 @@ If you specify a non-SMTP address space type on a Send connector configured in t - The SmartHosts parameter must be set to a value that specifies a smart host. - The DNSRoutingEnabled parameter must be set to $false. -Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://docs.microsoft.com/exchange/foreign-connectors-exchange-2013-help). +Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://learn.microsoft.com/exchange/foreign-connectors-exchange-2013-help). ```yaml Type: MultiValuedProperty @@ -190,7 +191,7 @@ Accept wildcard characters: False ### -AuthenticationCredential The AuthenticationCredential parameter specifies the username and password that's required to use the connector. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -206,7 +207,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -303,14 +304,16 @@ Accept wildcard characters: False ``` ### -Custom -The Custom parameter specifies the Custom usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom parameter, you can't use any of the following parameters: +The Custom switch specifies the Custom usage type. You don't need to specify a value with this switch. + +The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom switch, you can't use any of the following parameters: - Internal - Internet - Partner - Usage -For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://docs.microsoft.com/Exchange/mail-flow/connectors/send-connectors). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: SwitchParameter @@ -430,7 +433,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -516,14 +521,16 @@ Accept wildcard characters: False ``` ### -Internal -The Internal parameter specifies the Internal usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internal parameter, you can't use any of the following parameters: +The Internal switch specifies the Internal usage type. You don't need to specify a value with this switch. + +The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internal switch, you can't use any of the following parameters: - Custom - Internet - Partner - Usage -For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://docs.microsoft.com/Exchange/mail-flow/connectors/send-connectors). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: SwitchParameter @@ -539,14 +546,16 @@ Accept wildcard characters: False ``` ### -Internet -The Internet parameter specifies the Internet usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internet parameter, you can't use any of the following parameters: +The Internet switch specifies the Internet usage type. You don't need to specify a value with this switch. + +The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internet switch, you can't use any of the following parameters: - Custom - Internal - Partner - Usage -For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://docs.microsoft.com/Exchange/mail-flow/connectors/send-connectors). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: SwitchParameter @@ -655,14 +664,16 @@ Accept wildcard characters: False ``` ### -Partner -The Partner parameter specifies the Partner usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Partner parameter, you can't use any of the following parameters: +The Partner switch specifies the Partner usage type. You don't need to specify a value with this switch. + +The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Partner switch, you can't use any of the following parameters: - Custom - Internal - Internet - Usage -For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://docs.microsoft.com/Exchange/mail-flow/connectors/send-connectors). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: SwitchParameter @@ -896,7 +907,7 @@ If you use the Usage parameter, you can't use any of the following parameters: - Internet - Partner -For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://docs.microsoft.com/Exchange/mail-flow/connectors/send-connectors). +For more information about Send connector usage types, permissions, and authentication methods, see [Send connectors](https://learn.microsoft.com/Exchange/mail-flow/connectors/send-connectors). ```yaml Type: UsageType @@ -948,12 +959,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-ServicePrincipal.md b/exchange/exchange-ps/exchange/New-ServicePrincipal.md new file mode 100644 index 0000000000..6e59edbe3e --- /dev/null +++ b/exchange/exchange-ps/exchange/New-ServicePrincipal.md @@ -0,0 +1,185 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-serviceprincipal +applicable: Exchange Online, Security & Compliance, Exchange Online Protection +title: New-ServicePrincipal +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-ServicePrincipal + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-ServicePrincipal cmdlet to create service principals in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-ServicePrincipal -AppId -ObjectId + -ServiceId + [-Confirm] + [-DisplayName ] + [-Organization ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Service principals exist in Microsoft Entra ID to define what apps can do, who can access the apps, and what resources the apps can access. In Exchange Online, service principals are references to the service principals in Microsoft Entra ID. To assign Exchange Online role-based access control (RBAC) roles to service principals in Microsoft Entra ID, you use the service principal references in Exchange Online. The **\*-ServicePrincipal** cmdlets in Exchange Online PowerShell let you view, create, and remove these service principal references. + +For more information, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-ServicePrincipal -AppId 71487acd-ec93-476d-bd0e-6c8b31831053 -ObjectId 6233fba6-0198-4277-892f-9275bf728bcc +``` + +This example create a new service principal in Exchange Online with the specified AppId and ObjectId values. + +## PARAMETERS + +### -AppId +The AppId parameter specifies the unique AppId GUID value for the service principal. For example, ca73fffa-cedb-4b84-860f-d7fb8aa8a6c1. + +A valid value for this parameter is available in the following locations: + +- The AppId property in the output of the [Get-MgServicePrincipal](https://learn.microsoft.com/powershell/module/microsoft.graph.applications/get-mgserviceprincipal) cmdlet in Microsoft Graph PowerShell. +- The Application ID property from Enterprise applications in the Microsoft Entra admin center: . + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ObjectId +The ObjectId parameter specifies the unique ObjectId GUID value for the service principal. For example, 7c7599b2-23af-45e3-99ff-0025d148e929. + +A valid value for this parameter is available in the following locations: + +- The Id property in the output of the [Get-MgServicePrincipal](https://learn.microsoft.com/powershell/module/microsoft.graph.applications/get-mgserviceprincipal) cmdlet in Microsoft Graph PowerShell. +- The Object ID property from Enterprise applications in the Microsoft Entra admin center: . + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceId +This parameter is being deprecated. Use the ObjectId parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the friendly name of the service principal. If the name contains spaces, enclose the name in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SettingOverride.md b/exchange/exchange-ps/exchange/New-SettingOverride.md index ac1cd69ff7..6ffa158c1c 100644 --- a/exchange/exchange-ps/exchange/New-SettingOverride.md +++ b/exchange/exchange-ps/exchange/New-SettingOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-settingoverride +online version: https://learn.microsoft.com/powershell/module/exchange/new-settingoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-SettingOverride schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-SettingOverride cmdlet to create setting overrides that store Exchange customizations in Active Directory instead of in text files on the server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ New-SettingOverride [-Name] -Component -Parameters -Domains ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,44 +53,48 @@ This example creates a default sharing policy, which is applied to all mailboxes ## PARAMETERS -### -Domains -The Domains parameter specifies the domains to which this sharing policy applies and the sharing policy actions. Values for this parameter take the format: 'Domain: SharingPolicyAction'. - -The following sharing policy action values can be used: - -- CalendarSharingFreeBusySimple: Share free/busy hours only -- CalendarSharingFreeBusyDetail: Share free/busy hours, subject and location -- CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location and the body of the message or calendar item -- ContactsSharing: Share contacts only - -Separate multiple domains with a comma, for example, 'mail.contoso.com: CalendarSharingFreeBusySimple', 'mail.fabrikam.com: CalendarSharingFreeBusyDetail, ContactsSharing'. - -A domain doesn't include subdomains. You must configure each subdomain separately. +### -Name +The Name parameter specifies the name of the new sharing policy. ```yaml -Type: MultiValuedProperty +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the name of the new sharing policy. +### -Domains +The Domains parameter specifies the domains and the associated sharing options for those domains in the sharing policy. Values for this parameter use the basic syntax: `'Domain: SharingPolicyAction'`. + +You can use the following values for `Domain`: + +- A domain: For example, `mail.contoso.com`. A domain doesn't include subdomains. You must configure each subdomain separately. +- \*: Share with external federated organizations. For example, another Microsoft 365 organization or an on-premises Exchange organization. +- Anonymous: Share with external, non-federated organizations and individuals with internet access. + +You can use the following values for `SharingPolicyAction`: + +- CalendarSharingFreeBusySimple: Share free/busy hours only +- CalendarSharingFreeBusyDetail: Share free/busy hours, subject and location +- CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location and the body of the message or calendar item +- ContactsSharing: Share contacts only + +You can specify multiple `'Domain: SharingPolicyAction'` values separated by commas, and you can specify multiple `SharingPolicyAction` values for the same domain separated by commas. For example, `'mail.contoso.com: CalendarSharingFreeBusySimple', 'mail.fabrikam.com: CalendarSharingFreeBusyDetail, ContactsSharing'`. ```yaml -Type: String +Type: MultiValuedProperty Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -114,9 +120,9 @@ Accept wildcard characters: False ``` ### -Default -The Default switch specifies that this sharing policy is the default sharing policy for all mailboxes. If no sharing policy has been applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you can set the default policy as disabled. +The Default switch specifies that this sharing policy is the default sharing policy for all mailboxes. You don't need to specify a value with this switch. -You don't have to specify a value with this switch. +If no sharing policy has been applied to a mailbox, the default policy is automatically applied. If you want to disable sharing across your organization, you can set the default policy as disabled. ```yaml Type: SwitchParameter @@ -188,12 +194,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-SiteMailbox.md b/exchange/exchange-ps/exchange/New-SiteMailbox.md index 36837dd659..21fd001892 100644 --- a/exchange/exchange-ps/exchange/New-SiteMailbox.md +++ b/exchange/exchange-ps/exchange/New-SiteMailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-sitemailbox +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-SiteMailbox schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # New-SiteMailbox ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. The New-SiteMailbox cmdlet is used by the Microsoft SharePoint and Microsoft Exchange user interfaces to create site mailboxes. We recommend that you don't use this cmdlet; instead use SharePoint to create the site mailbox. This cmdlet should only be used for diagnostic and troubleshooting purposes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ New-SiteMailbox [[-DisplayName] ] -SharePointUrl ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The DisplayName parameter specifies the display name that displays in the user's Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -73,7 +73,7 @@ The SharePointUrl parameter specifies the SharePoint URL where the site mailbox Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -89,7 +89,7 @@ The Alias parameter specifies the alias of the site mailbox. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -108,7 +108,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -118,8 +118,6 @@ Accept wildcard characters: False ``` ### -Database -This parameter is available only in on-premises Exchange. - The Database parameter specifies the mailbox database that holds the mailbox data for the site mailbox. You can use any value that uniquely identifies the database. For example: - Name @@ -140,8 +138,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -158,15 +154,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -This parameter specifies whether to test that the site mailbox provisioning is working independently of the SharePoint deployment. We recommend that you never use this parameter for production site mailboxes. +This switch tests that site mailbox provisioning is working independently of the SharePoint deployment. We recommend that you never use this switch for production site mailboxes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -182,7 +178,7 @@ The Name parameter specifies the name of the site mailbox. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -198,7 +194,7 @@ The OrganizationalUnit parameter specifies the organizational unit in which the Type: OrganizationalUnitIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,8 +204,6 @@ Accept wildcard characters: False ``` ### -OverrideRecipientQuotas -This parameter is available only in on-premises Exchange. - This parameter is reserved for internal Microsoft use. ```yaml @@ -232,7 +226,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -246,12 +240,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md index f0c613a177..2766674f44 100644 --- a/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/exchange/New-SiteMailboxProvisioningPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-sitemailboxprovisioningpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-sitemailboxprovisioningpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-SiteMailboxProvisioningPolicy schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # New-SiteMailboxProvisioningPolicy ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. Use the New-SiteMailboxProvisioningPolicy cmdlet to create provisioning policies for site mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ New-SiteMailboxProvisioningPolicy [-Name] ## DESCRIPTION Site mailboxes allow access to both Microsoft SharePoint documents and Exchange email using the same client interface. Site mailbox provisioning policies apply settings to new site mailboxes that you create. You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. The default site mailbox provisioning policy is named Default. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -115,7 +115,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -273,7 +273,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -287,12 +287,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md index bde44567f2..ed8687d950 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewPolicyV2.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-supervisoryreviewpolicyv2 -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-supervisoryreviewpolicyv2 +applicable: Security & Compliance title: New-SupervisoryReviewPolicyV2 schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-SupervisoryReviewPolicyV2 ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-SupervisoryReviewPolicyV2 cmdlet to create supervisory review policies in the Microsoft 365 compliance center. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. +Use the New-SupervisoryReviewPolicyV2 cmdlet to create supervisory review policies in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,12 +26,15 @@ New-SupervisoryReviewPolicyV2 [-Name] -Reviewers [-Confirm] [-Enabled ] [-Force] + [-PolicyRBACScopes ] + [-PreservationPeriodInDays ] + [-UserReportingWorkloads ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -51,7 +54,7 @@ The Name parameter specifies the unique name for the supervisory review policy. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -67,7 +70,7 @@ The Reviewers parameter specifies the SMTP addresses of the reviewers for the su Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -83,7 +86,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -102,7 +105,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -118,7 +121,7 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -128,13 +131,63 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreservationPeriodInDays +{{ Fill PreservationPeriodInDays Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserReportingWorkloads +{{ Fill UserReportingWorkloads Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -144,13 +197,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -164,12 +217,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md index dbb8764a47..c4b9d1a57f 100644 --- a/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/New-SupervisoryReviewRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-supervisoryreviewrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-supervisoryreviewrule +applicable: Security & Compliance title: New-SupervisoryReviewRule schema: 2.0.0 author: chrisda @@ -12,30 +12,43 @@ ms.reviewer: # New-SupervisoryReviewRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-SupervisoryReviewRule cmdlet to create supervisory review rules in the Microsoft 365 compliance center. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. +Use the New-SupervisoryReviewRule cmdlet to create supervisory review rules in the Microsoft Purview compliance portal. Supervisory review lets you define policies that capture communications in your organization so they can be examined by internal or external reviewers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` New-SupervisoryReviewRule [-Name] -Policy + [-AdvancedRule ] [-CcsiDataModelOperator ] [-Condition ] [-Confirm] [-ContentContainsSensitiveInformation ] [-ContentMatchesDataModel ] [-ContentSources ] + [-DayXInsights ] + [-ExceptIfFrom ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRevieweeIs ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-From ] + [-IncludeAdaptiveScopes ] + [-InPurviewFilter ] [-Ocr ] + [-PolicyRBACScopes ] [-SamplingRate ] + [-SentTo ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -60,7 +73,7 @@ The Name parameter specifies the unique name for the supervisory review rule. Th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -80,7 +93,7 @@ The Policy parameter specifies the supervisory review policy that's assigned to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -89,6 +102,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AdvancedRule +{{ Fill AdvancedRule Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CcsiDataModelOperator {{ Fill CcsiDataModelOperator Description }} @@ -96,7 +125,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -122,7 +151,7 @@ The Condition parameter specifies the conditions and exceptions for the rule. Th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -141,7 +170,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -157,7 +186,7 @@ Accept wildcard characters: False Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -173,7 +202,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -189,7 +218,167 @@ Accept wildcard characters: False Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DayXInsights +{{ Fill DayXInsights Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +{{ Fill ExceptIfFrom Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +{{ Fill ExceptIfRecipientDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRevieweeIs +{{ Fill ExceptIfRevieweeIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +{{ Fill ExceptIfSenderDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +{{ Fill ExceptIfSentTo Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +{{ Fill ExceptIfSubjectOrBodyContainsWords Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +{{ Fill From Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAdaptiveScopes +{{ Fill IncludeAdaptiveScopes Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPurviewFilter +{{ Fill InPurviewFilter Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -205,7 +394,23 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -221,7 +426,23 @@ The SamplingRate parameter specifies the percentage of communications for review Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +{{ Fill SentTo Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -231,13 +452,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -251,12 +472,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SweepRule.md b/exchange/exchange-ps/exchange/New-SweepRule.md index 60ee1bf3f5..6aa53c55aa 100644 --- a/exchange/exchange-ps/exchange/New-SweepRule.md +++ b/exchange/exchange-ps/exchange/New-SweepRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-sweeprule +online version: https://learn.microsoft.com/powershell/module/exchange/new-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-SweepRule schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the New-SweepRule cmdlet to create Sweep rules in mailboxes. Sweep rules run a regular intervals to help keep your Inbox clean. +Use the New-SweepRule cmdlet to create Sweep rules in mailboxes. Sweep rules run at regular intervals to help keep your Inbox clean. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ New-SweepRule [-Name] -Provider ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -189,6 +189,8 @@ Accept wildcard characters: False ``` ### -ExceptIfFlagged +This parameter is available only in on-premises Exchange. + The ExceptIfFlagged parameter specifies an exception for the Sweep rule that looks messages with a message flag applied. Valid values are: - $true: The rule action isn't applied to messages that have a message flag applied. @@ -212,7 +214,7 @@ The typical message flag values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,6 +224,8 @@ Accept wildcard characters: False ``` ### -ExceptIfPinned +This parameter is available only in on-premises Exchange. + The PinMessage parameter specifies an exception for the Sweep rule that looks for pinned messages. Valid values are: - $true: The rule action isn't applied to messages that are pinned to the top of the Inbox. @@ -231,7 +235,7 @@ The PinMessage parameter specifies an exception for the Sweep rule that looks fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -421,12 +425,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md index 1293ffb5ca..8084e8b744 100644 --- a/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/exchange/New-SyncMailPublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-syncmailpublicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/new-syncmailpublicfolder applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: New-SyncMailPublicFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. The New-SyncMailPublicFolder cmdlet is used by the Import-MailPublicFoldersForMigration.ps1 and Sync-MailPublicFolders.ps1 scripts to create mail-enabled public folder recipient objects in Exchange Online (the scripts synchronize mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,7 +62,7 @@ New-SyncMailPublicFolder [-Name] [-Alias] -EntryId ## DESCRIPTION This cmdlet is only used by the Import-MailPublicFoldersForMigration.ps1 and Sync-MailPublicFolders.ps1 scripts. Don't run this cmdlet in the Exchange Management Shell or in Exchange Online PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -94,15 +94,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -513,16 +518,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -619,10 +624,7 @@ Accept wildcard characters: False ``` ### -HiddenFromAddressListsEnabled -The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: - -- $true: The recipient isn't visible in address lists. -- $false: The recipient is visible in address lists. This is the default value. +The HiddenFromAddressListsEnabled switch specifies that this recipient is not visible in address lists. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -819,12 +821,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-SystemMessage.md b/exchange/exchange-ps/exchange/New-SystemMessage.md index 4f679b857a..05d97b7970 100644 --- a/exchange/exchange-ps/exchange/New-SystemMessage.md +++ b/exchange/exchange-ps/exchange/New-SystemMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-systemmessage +online version: https://learn.microsoft.com/powershell/module/exchange/new-systemmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-SystemMessage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-SystemMessage cmdlet to create custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ New-SystemMessage -Language -QuotaMessageType - ## DESCRIPTION NDRs are issued to the senders of email messages that haven't reached their intended recipients. Quota messages are issued to users whose mailboxes or public folders have reached the specific warning, prohibit send, or prohibit receive quotas. Custom NDRs and quota messages replace the default messages that are included with Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,7 +109,7 @@ Accept wildcard characters: False ``` ### -Language -The Language parameter specifies the language of the message (for example, en for English or ja for Japanese). For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +The Language parameter specifies the language of the message (for example, en for English or ja for Japanese). For the list of supported language codes, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). You need to use this parameter with the DsnCode or QuotaMessageType parameters. @@ -131,7 +131,7 @@ The QuotaMessageType parameter specifies the quota for the custom system message Mailbox size quotas: -- ProhibitSendReceiveMailBox: A mailbox exceeds its ProhibitSendReceiveQuota limit. +- ProhibitSendReceiveMailbox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. - WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. @@ -193,7 +193,7 @@ The following HTML tags are available: - `` and `` (italic) - `
` (line break) - `

` and `

` (paragraph) -- `` and `` (hyperlink). Note: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). +- `` and `` (hyperlink). **Note**: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). Use the following escape codes for these special characters: @@ -277,12 +277,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md new file mode 100644 index 0000000000..18775fc30b --- /dev/null +++ b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicy.md @@ -0,0 +1,194 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicy +applicable: Exchange Online +title: New-TeamsProtectionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-TeamsProtectionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-TeamsProtectionPolicy cmdlet to create Microsoft Teams protection policies. + +**Note**: If the policy already exists (the Get-TeamsProtectionPolicy cmdlet returns output), you can't use this cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-TeamsProtectionPolicy [-Name] + [-Confirm] + [-HighConfidencePhishQuarantineTag ] + [-MalwareQuarantineTag ] + [-Organization ] + [-WhatIf] + [-ZapEnabled ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-TeamsProtectionPolicy -Name "Teams Protection Policy" +``` + +This example creates the Teams protection policy with the default values. + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name of the Teams protection policy. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy in an organization is Teams Protection Policy. We recommend using this value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidencePhishQuarantineTag +The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as high confidence phishing by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareQuarantineTag +The MalwareQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as malware by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZapEnabled +The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are: + +- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value. +- $false: ZAP for malware and high confidence phishing messages in Teams is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md new file mode 100644 index 0000000000..b2a9f0c731 --- /dev/null +++ b/exchange/exchange-ps/exchange/New-TeamsProtectionPolicyRule.md @@ -0,0 +1,252 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/new-teamsprotectionpolicyrule +applicable: Exchange Online +title: New-TeamsProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# New-TeamsProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the New-TeamsProtectionPolicyRule cmdlet to create Microsoft Teams protection policy rules. + +**Note**: If the rule already exists (the Get-TeamsProtectionPolicyRule cmdlet returns output), you can't use this cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +New-TeamsProtectionPolicyRule [-Name] -TeamsProtectionPolicy + [-Comments ] + [-Confirm] + [-Enabled ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Organization ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use this cmdlet only if the following statements are true: + +- The Teams protection policy rule doesn't exist (the Get-TeamsProtectionPolicyRule cmdlet returns no output). +- The Teams protection policy exists (the Get-TeamsProtectionPolicy cmdlet returns output). + +> [!IMPORTANT] +> Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Configure ZAP for Teams protection in Defender for Office 365 Plan 2](https://learn.microsoft.com/defender-office-365/mdo-support-teams-about#configure-zap-for-teams-protection-in-defender-for-office-365-plan-2). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +New-TeamsProtectionPolicyRule -Name "Teams Protection Policy Rule" -TeamsProtectionPolicy "Teams Protection Policy" -ExceptIfSentToMemberOf research@contoso.onmicrosoft.com +``` + +This example creates the Teams protection policy rule with members of the group named Research excluded from ZAP for Teams protection. + +## PARAMETERS + +### -Name +The Name parameter specifies the unique name of the Teams protection policy rule. If the value contains spaces, enclose the value in quotation marks. The default name of the Teams protection policy rule in an organization is Teams Protection Policy Rule. We recommend using this value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsProtectionPolicy +The TeamsProtectionPolicy parameter specifies the Teams protection policy that's associated with this rule. The only available policy is named Teams Protection Policy. + +```yaml +Type: TeamsProtectionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception to ZAP for Teams protection that looks for Teams messages sent to members of distribution groups or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for Teams messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md index bd18970552..6ef2975372 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListItems.md @@ -1,103 +1,123 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-tenantallowblocklistitems -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-tenantallowblocklistitems +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: New-TenantAllowBlockListItems schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: -ROBOTS: NOINDEX --- # New-TenantAllowBlockListItems ## SYNOPSIS -**Note**: The features described in this topic are in Preview, are subject to change, and are not available in all organizations. - This cmdlet is available only in the cloud-based service. -Use the New-TenantAllowBlockListItems cmdlet to add entries to the Tenant Allow/Block List in the Microsoft 365 Defender portal. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the New-TenantAllowBlockListItems cmdlet to add entries to the Tenant Allow/Block List in the Microsoft Defender portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### Expiration ``` -New-TenantAllowBlockListItems -Action -Entries -ListType - [-ExpirationDate ] +New-TenantAllowBlockListItems -Entries -ListType [-ExpirationDate ] + [-Allow] + [-Block] + [-ListSubType ] + [-LogExtraDetails] [-Notes ] [-OutputJson] + [-RemoveAfter ] + [-SubmissionID ] [] ``` ### NoExpiration ``` -New-TenantAllowBlockListItems -Action -Entries -ListType - [-NoExpiration] +New-TenantAllowBlockListItems -Entries -ListType [-NoExpiration] + [-Allow] + [-Block] + [-ListSubType ] + [-LogExtraDetails] [-Notes ] [-OutputJson] + [-RemoveAfter ] + [-SubmissionID ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -New-TenantAllowBlockListItems -ListType Url -Action Block -Entries ~contoso.com~ +New-TenantAllowBlockListItems -ListType Url -Block -Entries ~contoso.com~ ``` This example adds a URL block entry for contoso.com and all subdomains (for example, contoso.com, www.contoso.com, xyz.abc.contoso.com, and www.contoso.com/b). Because we didn't use the ExpirationDate or NoExpiration parameters, the entry expires after 30 days. ### Example 2 ```powershell -New-TenantAllowBlockListItems -ListType FileHash -Action Allow -Entries "768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3","2c0a35409ff0873cfa28b70b8224e9aca2362241c1f0ed6f622fef8d4722fd9a" -NoExpiration +New-TenantAllowBlockListItems -ListType FileHash -Block -Entries "768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3","2c0a35409ff0873cfa28b70b8224e9aca2362241c1f0ed6f622fef8d4722fd9a" -NoExpiration ``` -This example adds a file allow entry for the specified files that never expires. +This example adds a file block entry for the specified files that never expires. -## PARAMETERS +### Example 3 +```powershell +New-TenantAllowBlockListItems -Allow -ListType Url -ListSubType AdvancedDelivery -Entries *.fabrikam.com -NoExpiration +``` -### -Action -The Action parameter specifies the action type for the entry. Valid values are: +This example adds a URL allow entry for the specified third-party phishing simulation URL with no expiration. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -- Allow -- Block +### Example 4 +```powershell +New-TenantAllowBlockListItems -Allow -ListType Url -Entries abcd.fabrikam.com -RemoveAfter 45 +``` -```yaml -Type: ItemAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection +This example adds a URL allow entry for the specified domain with expiration as 45 days after last used date. This allow entry permits URLs identified as bulk, spam, high confidence spam, and phishing (not high confidence phishing). -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +For URLs identified as malware or high-confidence phishing, you need to submit the URLs Microsoft to create allow entries. For instructions, see [Report good URLs to Microsoft](https://learn.microsoft.com/defender-office-365/submissions-admin#report-good-urls-to-microsoft). + +## PARAMETERS ### -Entries -The Entries parameter specifies the URL or files that you want to add to the Tenant Allow/Block List based on the value of the ListType parameter: +The Entries parameter specifies the values that you want to add to the Tenant Allow/Block List based on the ListType parameter value: + +- FileHash: Use the SHA256 hash value of the file. You can find the SHA256 hash value by running the following command in PowerShell: `Get-FileHash -Path "\" -Algorithm SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. +- Sender: A domain or email address value. For example, `contoso.com` or `michelle@contoso.com`. +- URL: Use IPv4 or IPv6 addresses or hostnames. Wildcards (\* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see [URL syntax for the Tenant Allow/Block List](https://learn.microsoft.com/defender-office-365/tenant-allow-block-list-urls-configure#url-syntax-for-the-tenant-allowblock-list). +- IP: IPv6 addresses only: -- URLs: Use IPv4 or IPv6 addresses or hostnames. Wildcards (* and ~) are supported in hostnames. Protocols, TCP/UDP ports, or user credentials are not supported. For details, see [URL syntax for the Tenant Allow/Block List](https://docs.microsoft.com/microsoft-365/security/office-365-security/tenant-allow-block-list#url-syntax-for-the-tenant-allowedblocked-list). -- Files: Use the SHA256 hash value of the file. In Windows, you can find the SHA256 hash value by running the following command in a Command Prompt: `certutil.exe -hashfile "\" SHA256`. An example value is `768a813668695ef2483b2bde7cf5d1b2db0423a0d3e63e498f3ab6f2eb13ea3`. + • Single IPv6 addresses in colon-hexadecimal format (for example, 2001:0db8:85a3:0000:0000:8a2e:0370:7334). + + • Single IPv6 addresses in zero-compression format (for example, 2001:db8::1 for 2001:0db8:0000:0000:0000:0000:0000:0001). + + • CIDR IPv6 ranges from 1 to 128 (for example, 2001:0db8::/32). To enter multiple values, use the following syntax: `"Value1","Value2",..."ValueN"`. -You can't mix URL and file values or allow and block actions in the same command. You can't modify existing URL or file values after you create the entry (there's no Entries parameter on the Set-TenantAllowBlockListItems cmdlet). +Entry limits for each list subtype (sender, URL, file, or IP address): + +- **Exchange Online Protection**: The maximum number of allow entries is 500, and the maximum number of block entries is 500. +- **Defender for Office 365 Plan 1**: The maximum number of allow entries is 1000, and the maximum number of block entries is 1000. +- **Defender for Office 365 Plan 2**: The maximum number of allow entries is 5000, and the maximum number of block entries is 10000. + +The maximum number of characters in a file entry is 64 and the maximum number of characters in a URL entry is 250. + +You can't mix value types (sender, URL, file, or IP address) or allow and block actions in the same command. + +In most cases, you can't modify the sender, URL, file, or IP address values after you create the entry. The only exception is URL allow entries for phishing simulations (ListType = URL, ListSubType = AdvancedDelivery). ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -107,20 +127,20 @@ Accept wildcard characters: False ``` ### -ExpirationDate -The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). +The ExpirationDate parameter set the expiration date of the entry in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, `"2021-05-06 14:30:00z"`. -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). -You can't use this parameter with the NoExpiration switch. +You can't use this parameter with the NoExpiration or RemoveAfter parameters. ```yaml Type: DateTime Parameter Sets: Expiration Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -133,13 +153,15 @@ Accept wildcard characters: False The ListType parameter specifies the type of entry to add. Valid values are: - FileHash +- Sender - Url +- IP ```yaml Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -151,13 +173,19 @@ Accept wildcard characters: False ### -NoExpiration The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. -You can't use this switch with the ExpirationDate parameter. +This switch is available to use in the following scenarios: + +- With the Block switch. +- With the Allow switch where the ListType parameter value is URL and the ListSubType parameter value is AdvancedDelivery. +- With the Allow switch where the ListType parameter value is IP. + +You can't use this switch with the ExpirationDate or RemoveAfter parameter. ```yaml Type: SwitchParameter Parameter Sets: NoExpiration Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -166,6 +194,81 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Allow +The Allow switch specifies that you're creating an allow entry. You don't need to specify a value with this switch. + +You can't use this switch with the Block switch. + +**Note**: See [Allow entries in the Tenant Allow/Block List](https://learn.microsoft.com/defender-office-365/tenant-allow-block-list-about#allow-entries-in-the-tenant-allowblock-list), before you try to create an allow entry. + +You can also use allow entries for third-party phishing simulation URLs with no expiration. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Block +The Allow switch specifies that you're creating a block entry. You don't need to specify a value with this switch. + +You can't use this switch with the Allow switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListSubType +The ListSubType parameter specifies the subtype for this entry. Valid values are: + +- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +- Tenant: This is the default value. + +```yaml +Type: ListSubType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LogExtraDetails +{{ Fill LogExtraDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Notes The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). @@ -173,7 +276,29 @@ The Notes parameters specifies additional information about the object. If the v Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAfter +The RemoveAfter parameter enables the **Remove on** \> **45 days after last used date** feature for an allow entry. The LastUsedDate property is populated when the bad entity in the allow entry is encountered by the filtering system during mail flow or time of click. The allow entry is kept for 45 days after the filtering system determines that the entity is clean. + +The only valid value for this parameter is 45. + +You can use this parameter with the Allow switch when the ListType parameter value is Sender, FileHash, or Url. + +You can't use this parameter with the ExpirationDate or NoExpirationDate parameters. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -191,7 +316,23 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubmissionID +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -205,12 +346,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md index 2257623a36..48976dd565 100644 --- a/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/New-TenantAllowBlockListSpoofItems.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-tenantallowblocklistspoofitems -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/new-tenantallowblocklistspoofitems +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: New-TenantAllowBlockListSpoofItems schema: 2.0.0 author: chrisda @@ -14,17 +14,14 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the New-TenantAllowBlockListSpoofItems cmdlet to create spoof entries in the Tenant Allow/Block List. +Use the New-TenantAllowBlockListSpoofItems cmdlet to create spoofed sender entries in the Tenant Allow/Block List. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -New-TenantAllowBlockListSpoofItems [-Identity] -Action - -SendingInfrastructure -SpoofedUser -SpoofType +New-TenantAllowBlockListSpoofItems [-Identity] -Action -SendingInfrastructure -SpoofedUser -SpoofType [-Confirm] [-WhatIf] [] @@ -33,26 +30,27 @@ New-TenantAllowBlockListSpoofItems [-Identity] /24 (for example, 192.168.100.100/24). Use the IP address if the source IP address has no PTR record. +- An IP address using the syntax: \/24 (for example, 192.168.100.100/24). Use the IP address if the source IP address has no PTR record. /24 is the only available and maximum subnet depth. +- A verified DKIM domain. ```yaml Type: String Parameter Sets: (All) Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -80,15 +80,18 @@ Accept wildcard characters: True ``` ### -SpoofedUser -The SpoofedUser parameter specifies the spoofed sender's email address or domain for the spoof entry. +The SpoofedUser parameter specifies the email address or domain for the spoofed sender entry. - For domains outside your organization (cross-org), use the domain of the email address that appears in the From field of the message. - For domains inside your organization (intra-org), use the full email address that appears in the From field of the message. +For spoofed senders, the maximum number of entries is 1024. + ```yaml Type: String Parameter Sets: (All) Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -98,7 +101,7 @@ Accept wildcard characters: True ``` ### -SpoofType -The SpoofType parameter specifies whether this is an internal or external spoof entry. Valid values are: +The SpoofType parameter specifies whether this is an internal or external spoofed sender entry. Valid values are: - External - Internal @@ -107,6 +110,7 @@ The SpoofType parameter specifies whether this is an internal or external spoof Type: String Parameter Sets: (All) Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -116,7 +120,7 @@ Accept wildcard characters: False ``` ### -Action -The Action parameter specifies whether is is an allowed or blocked spoof entry. Valid values are: +The Action parameter specifies whether is an allowed or blocked spoofed sender entry. Valid values are: - Allow - Block @@ -125,6 +129,7 @@ The Action parameter specifies whether is is an allowed or blocked spoof entry. Type: String Parameter Sets: (All) Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -143,6 +148,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -158,6 +164,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -171,12 +178,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md index 48e0eeca24..4b540a9784 100644 --- a/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/New-ThrottlingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-throttlingpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-throttlingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-ThrottlingPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-ThrottlingPolicy cmdlet to create a non-default user throttling policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -175,9 +175,9 @@ New-ThrottlingPolicy [-Name] ## DESCRIPTION By default, there is one default throttling policy named `GlobalThrottlingPolicy_` with a throttling scope of Global. Microsoft Exchange Setup creates a default client throttling policy as part of the Client Access server role. You should not replace, re-create, or remove the existing default throttling policy. However, you can create additional throttling policies with the scope of Organization or Regular to change your user throttling settings. You can also edit policies with the scope of Organization and Regular that you've created using the Set-ThrottlingPolicy cmdlet. -For more information about how to control how resources are consumed by individual users, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). +For more information about how to control how resources are consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -678,7 +678,7 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywords -The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://docs.microsoft.com/powershell/module/exchange/search-mailbox). +The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchange/search-mailbox). ```yaml Type: Unlimited @@ -774,7 +774,7 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxStatsSearchMailboxes -The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). +The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: Unlimited @@ -1472,13 +1472,11 @@ Accept wildcard characters: False ``` ### -IsServiceAccount -The IsServiceAccount switch specifies whether you want the user accounts associated with this policy to be moderated by the per-user thresholds specified by this policy, and also by additional throttling based on the health of system resources, such as overall CPU usage. +The IsServiceAccount switch specifies that the user accounts associated with this policy are moderated by per-user thresholds and the health of system resources (for example, overall CPU usage). You don't need to specify a value with this switch. -This value is set to $false by default. +You might want to use this switch if you intend to associate this policy with user accounts that require higher throttling limits (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). -You may want to set this value to $true if you intend to associate this policy with user accounts that require higher throttling limits. An account that might require higher throttling limits is a service account that performs a lot of non-interactive work (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). - -By setting the IsServiceAccount switch to $true, work done by these accounts is moderated by the higher user throttling settings that you configure using the user throttling policy, but is slowed if resources start getting unhealthy. +By using this switch, work done by these accounts is moderated by the higher user throttling settings that you configure using the user throttling policy, but is slowed if resources start getting unhealthy. ```yaml Type: SwitchParameter @@ -2669,7 +2667,7 @@ The ThrottlingPolicyScope parameter specifies the scope of the throttling policy - Organization: Specifies a custom policy that applies to all users in your organization. - Global: Reserved for the default throttling policy. -For more information about throttling policy scopes, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). +For more information about throttling policy scopes, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). ```yaml Type: ThrottlingPolicyScopeType @@ -2705,12 +2703,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-TransportRule.md b/exchange/exchange-ps/exchange/New-TransportRule.md index 887edcfca1..97c913ad9b 100644 --- a/exchange/exchange-ps/exchange/New-TransportRule.md +++ b/exchange/exchange-ps/exchange/New-TransportRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-transportrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: New-TransportRule schema: 2.0.0 @@ -16,7 +16,13 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the New-TransportRule cmdlet to create transport rules (mail flow rules) in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: + +- The action of a rule without conditions or exceptions is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. + +- Rules that use Active Directory or Microsoft Entra ID properties as conditions or exceptions work only on senders or recipients in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,15 +32,15 @@ New-TransportRule [-Name] [-ADComparisonAttribute ] [-ADComparisonOperator ] [-AddManagerAsRecipientType ] - [-AddToRecipients ] - [-AnyOfCcHeader ] - [-AnyOfCcHeaderMemberOf ] - [-AnyOfRecipientAddressContainsWords ] - [-AnyOfRecipientAddressMatchesPatterns ] - [-AnyOfToCcHeader ] - [-AnyOfToCcHeaderMemberOf ] - [-AnyOfToHeader ] - [-AnyOfToHeaderMemberOf ] + [-AddToRecipients ] + [-AnyOfCcHeader ] + [-AnyOfCcHeaderMemberOf ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] + [-AnyOfToCcHeader ] + [-AnyOfToCcHeaderMemberOf ] + [-AnyOfToHeader ] + [-AnyOfToHeaderMemberOf ] [-ApplyClassification ] [-ApplyHtmlDisclaimerFallbackAction ] [-ApplyHtmlDisclaimerLocation ] @@ -42,94 +48,94 @@ New-TransportRule [-Name] [-ApplyOME ] [-ApplyRightsProtectionCustomizationTemplate ] [-ApplyRightsProtectionTemplate ] - [-AttachmentContainsWords ] - [-AttachmentExtensionMatchesWords ] + [-AttachmentContainsWords ] + [-AttachmentExtensionMatchesWords ] [-AttachmentHasExecutableContent ] [-AttachmentIsPasswordProtected ] [-AttachmentIsUnsupported ] - [-AttachmentMatchesPatterns ] - [-AttachmentNameMatchesPatterns ] + [-AttachmentMatchesPatterns ] + [-AttachmentNameMatchesPatterns ] [-AttachmentProcessingLimitExceeded ] - [-AttachmentPropertyContainsWords ] + [-AttachmentPropertyContainsWords ] [-AttachmentSizeOver ] - [-BetweenMemberOf1 ] - [-BetweenMemberOf2 ] - [-BlindCopyTo ] + [-BetweenMemberOf1 ] + [-BetweenMemberOf2 ] + [-BlindCopyTo ] [-Comments ] [-Confirm] - [-ContentCharacterSetContainsWords ] - [-CopyTo ] + [-ContentCharacterSetContainsWords ] + [-CopyTo ] [-DeleteMessage ] - [-Disconnect ] [-DlpPolicy ] + [-Disconnect ] [-DomainController ] [-Enabled ] [-ExceptIfADComparisonAttribute ] [-ExceptIfADComparisonOperator ] - [-ExceptIfAnyOfCcHeader ] - [-ExceptIfAnyOfCcHeaderMemberOf ] - [-ExceptIfAnyOfRecipientAddressContainsWords ] - [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] - [-ExceptIfAnyOfToCcHeader ] - [-ExceptIfAnyOfToCcHeaderMemberOf ] - [-ExceptIfAnyOfToHeader ] - [-ExceptIfAnyOfToHeaderMemberOf ] - [-ExceptIfAttachmentContainsWords ] - [-ExceptIfAttachmentExtensionMatchesWords ] + [-ExceptIfAnyOfCcHeader ] + [-ExceptIfAnyOfCcHeaderMemberOf ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] + [-ExceptIfAnyOfToCcHeader ] + [-ExceptIfAnyOfToCcHeaderMemberOf ] + [-ExceptIfAnyOfToHeader ] + [-ExceptIfAnyOfToHeaderMemberOf ] + [-ExceptIfAttachmentContainsWords ] + [-ExceptIfAttachmentExtensionMatchesWords ] [-ExceptIfAttachmentHasExecutableContent ] [-ExceptIfAttachmentIsPasswordProtected ] [-ExceptIfAttachmentIsUnsupported ] - [-ExceptIfAttachmentMatchesPatterns ] - [-ExceptIfAttachmentNameMatchesPatterns ] + [-ExceptIfAttachmentMatchesPatterns ] + [-ExceptIfAttachmentNameMatchesPatterns ] [-ExceptIfAttachmentProcessingLimitExceeded ] - [-ExceptIfAttachmentPropertyContainsWords ] + [-ExceptIfAttachmentPropertyContainsWords ] [-ExceptIfAttachmentSizeOver ] - [-ExceptIfBetweenMemberOf1 ] - [-ExceptIfBetweenMemberOf2 ] - [-ExceptIfContentCharacterSetContainsWords ] - [-ExceptIfFrom ] - [-ExceptIfFromAddressContainsWords ] - [-ExceptIfFromAddressMatchesPatterns ] - [-ExceptIfFromMemberOf ] + [-ExceptIfBetweenMemberOf1 ] + [-ExceptIfBetweenMemberOf2 ] + [-ExceptIfContentCharacterSetContainsWords ] + [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] + [-ExceptIfFromMemberOf ] [-ExceptIfFromScope ] [-ExceptIfHasClassification ] [-ExceptIfHasNoClassification ] [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsMessageHeader ] - [-ExceptIfHeaderContainsWords ] + [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesMessageHeader ] - [-ExceptIfHeaderMatchesPatterns ] - [-ExceptIfManagerAddresses ] + [-ExceptIfHeaderMatchesPatterns ] + [-ExceptIfManagerAddresses ] [-ExceptIfManagerForEvaluatedUser ] - [-ExceptIfMessageContainsDataClassifications ] + [-ExceptIfMessageContainsDataClassifications ] [-ExceptIfMessageSizeOver ] [-ExceptIfMessageTypeMatches ] - [-ExceptIfRecipientADAttributeContainsWords ] - [-ExceptIfRecipientADAttributeMatchesPatterns ] - [-ExceptIfRecipientAddressContainsWords ] - [-ExceptIfRecipientAddressMatchesPatterns ] - [-ExceptIfRecipientDomainIs ] - [-ExceptIfRecipientInSenderList ] + [-ExceptIfRecipientADAttributeContainsWords ] + [-ExceptIfRecipientADAttributeMatchesPatterns ] + [-ExceptIfRecipientAddressContainsWords ] + [-ExceptIfRecipientAddressMatchesPatterns ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRecipientInSenderList ] [-ExceptIfSCLOver ] - [-ExceptIfSenderADAttributeContainsWords ] - [-ExceptIfSenderADAttributeMatchesPatterns ] - [-ExceptIfSenderDomainIs ] - [-ExceptIfSenderInRecipientList ] + [-ExceptIfSenderADAttributeContainsWords ] + [-ExceptIfSenderADAttributeMatchesPatterns ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSenderInRecipientList ] [-ExceptIfSenderIpRanges ] [-ExceptIfSenderManagementRelationship ] - [-ExceptIfSentTo ] - [-ExceptIfSentToMemberOf ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] [-ExceptIfSentToScope ] - [-ExceptIfSubjectContainsWords ] - [-ExceptIfSubjectMatchesPatterns ] - [-ExceptIfSubjectOrBodyContainsWords ] - [-ExceptIfSubjectOrBodyMatchesPatterns ] + [-ExceptIfSubjectContainsWords ] + [-ExceptIfSubjectMatchesPatterns ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-ExceptIfSubjectOrBodyMatchesPatterns ] [-ExceptIfWithImportance ] [-ExpiryDate ] - [-From ] - [-FromAddressContainsWords ] - [-FromAddressMatchesPatterns ] - [-FromMemberOf ] + [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] + [-FromMemberOf ] [-FromScope ] [-GenerateIncidentReport ] [-GenerateNotification ] @@ -137,51 +143,52 @@ New-TransportRule [-Name] [-HasNoClassification ] [-HasSenderOverride ] [-HeaderContainsMessageHeader ] - [-HeaderContainsWords ] + [-HeaderContainsWords ] [-HeaderMatchesMessageHeader ] - [-HeaderMatchesPatterns ] - [-IncidentReportContent ] + [-HeaderMatchesPatterns ] + [-IncidentReportContent ] [-IncidentReportOriginalMail ] [-LogEventText ] - [-ManagerAddresses ] + [-ManagerAddresses ] [-ManagerForEvaluatedUser ] - [-MessageContainsDataClassifications ] + [-MessageContainsDataClassifications ] [-MessageSizeOver ] [-MessageTypeMatches ] [-Mode ] [-ModerateMessageByManager ] - [-ModerateMessageByUser ] + [-ModerateMessageByUser ] [-NotifySender ] [-PrependSubject ] [-Priority ] [-Quarantine ] - [-RecipientADAttributeContainsWords ] - [-RecipientADAttributeMatchesPatterns ] - [-RecipientAddressContainsWords ] - [-RecipientAddressMatchesPatterns ] + [-RecipientADAttributeContainsWords ] + [-RecipientADAttributeMatchesPatterns ] + [-RecipientAddressContainsWords ] + [-RecipientAddressMatchesPatterns ] [-RecipientAddressType ] - [-RecipientDomainIs ] - [-RecipientInSenderList ] - [-RedirectMessageTo ] + [-RecipientDomainIs ] + [-RecipientInSenderList ] + [-RedirectMessageTo ] [-RejectMessageEnhancedStatusCode ] [-RejectMessageReasonText ] [-RemoveHeader ] [-RemoveOME ] [-RemoveOMEv2 ] + [-RemoveRMSAttachmentEncryption ] [-RouteMessageOutboundConnector ] [-RouteMessageOutboundRequireTls ] [-RuleErrorAction ] [-RuleSubType ] [-SCLOver ] - [-SenderADAttributeContainsWords ] - [-SenderADAttributeMatchesPatterns ] + [-SenderADAttributeContainsWords ] + [-SenderADAttributeMatchesPatterns ] [-SenderAddressLocation ] - [-SenderDomainIs ] - [-SenderInRecipientList ] + [-SenderDomainIs ] + [-SenderInRecipientList ] [-SenderIpRanges ] [-SenderManagementRelationship ] - [-SentTo ] - [-SentToMemberOf ] + [-SentTo ] + [-SentToMemberOf ] [-SentToScope ] [-SetAuditSeverity ] [-SetHeaderName ] @@ -190,10 +197,10 @@ New-TransportRule [-Name] [-SmtpRejectMessageRejectStatusCode ] [-SmtpRejectMessageRejectText ] [-StopRuleProcessing ] - [-SubjectContainsWords ] - [-SubjectMatchesPatterns ] - [-SubjectOrBodyContainsWords ] - [-SubjectOrBodyMatchesPatterns ] + [-SubjectContainsWords ] + [-SubjectMatchesPatterns ] + [-SubjectOrBodyContainsWords ] + [-SubjectOrBodyMatchesPatterns ] [-UseLegacyRegex ] [-WhatIf] [-WithImportance ] @@ -205,7 +212,7 @@ In on-premises Exchange organizations, rules created on Mailbox servers are stor The search for words or text patterns in the subject or other header fields in the message occurs after the message has been decoded from the MIME content transfer encoding method that was used to transmit the binary message between SMTP servers in ASCII text. You can't use conditions or exceptions to search for the raw (typically, Base64) encoded values of the subject or other header fields in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -242,7 +249,7 @@ Accept wildcard characters: False ### -ActivationDate The ActivationDate parameter specifies when the rule starts processing messages. The rule won't take any action on messages until the specified date/time. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -260,7 +267,7 @@ Accept wildcard characters: False ### -ADComparisonAttribute This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ADComparisonAttribute parameter specifies a condition that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. @@ -312,7 +319,7 @@ Accept wildcard characters: False ### -ADComparisonOperator This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ADComparisonOperator parameter specifies the comparison operator for the ADComparisonAttribute parameter. Valid values are: @@ -335,7 +342,7 @@ Accept wildcard characters: False ### -AddManagerAsRecipientType This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The AddManagerAsRecipientType parameter specifies an action that delivers or redirects messages to the user that's defined in the sender's Manager attribute. Valid values are: @@ -391,7 +398,7 @@ Accept wildcard characters: False ### -AnyOfCcHeader This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfCcHeader parameter specifies a condition that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: @@ -424,7 +431,7 @@ Accept wildcard characters: False ### -AnyOfCcHeaderMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfCcHeaderMemberOf parameter specifies a condition that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. For example: @@ -505,7 +512,7 @@ Accept wildcard characters: False ### -AnyOfToCcHeader This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfToCcHeader parameter specifies a condition that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. For example: @@ -538,7 +545,7 @@ Accept wildcard characters: False ### -AnyOfToCcHeaderMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfToCcHeaderMemberOf parameter specifies a condition that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. For example: @@ -571,7 +578,7 @@ Accept wildcard characters: False ### -AnyOfToHeader This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfToHeader parameter specifies a condition that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. For example: @@ -604,7 +611,7 @@ Accept wildcard characters: False ### -AnyOfToHeaderMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfToHeaderMemberOf parameter specifies a condition that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. For example: @@ -637,7 +644,7 @@ Accept wildcard characters: False ### -ApplyClassification This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ApplyClassification parameter specifies an action that applies a message classification to messages. Use the Get-MessageClassification cmdlet to see the message classification objects that are available. @@ -659,13 +666,20 @@ Accept wildcard characters: False ### -ApplyHtmlDisclaimerFallbackAction This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be applied to a message (for example, encrypted or signed messages where the contents can't be altered). Valid values are: + +- Wrap: This is the default value. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. + + If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules. + + If the process of inserting the original message as an attachment in the new message fails, the original message isn't delivered. The original message is returned to the sender in an NDR. -The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be added to a message. Valid values are: + In Microsoft 365, don't use this value in rules that affect incoming messages from external senders. Use the value Reject instead. The effects of the value Wrap interfere with Safe Attachments scanning of messages from external senders. -- Wrap: The original message is wrapped in a new message envelope, and the disclaimer is used as the message body for the new message. This is the default value. Subsequent mail flow rules are applied to the new message envelope, not to the original message. Therefore, configure a rule with this action at a lower priority (a higher priority number) than other rules. If the original message can't be wrapped in a new message envelope, the original message isn't delivered. The message is returned to the sender in an non-delivery report (also known as an NDR or bounce message). -- Ignore: The rule is ignored and the message is delivered without the disclaimer. -- Reject: The message is rejected. +- Ignore: The rule is ignored and the original message is delivered without the disclaimer. +- Reject: The original message is returned to the sender in an NDR. If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Wrap is used. @@ -685,7 +699,7 @@ Accept wildcard characters: False ### -ApplyHtmlDisclaimerLocation This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ApplyHtmlDisclaimerLocation parameter specifies where to insert the HTML disclaimer text in the body of messages. Valid values are: @@ -710,10 +724,38 @@ Accept wildcard characters: False ### -ApplyHtmlDisclaimerText This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ApplyHtmlDisclaimerText parameter specifies an action that adds the disclaimer text to messages. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. +This parameter also supports the following tokens that use values from the sender: + +- %%City%% +- %%Company%% +- %%CountryOrRegion%% +- %%Department%% +- %%DisplayName%% +- %%Fax%% +- %%FirstName%% +- %%HomePhone%% +- %%Initials%% +- %%LastName%% +- %%Manager%% +- %%MobilePhone%% +- %%Notes%% +- %%Office%% +- %%Pager%% +- %%Phone%% +- %%PostalCode%% +- %%PostOfficeBox%% +- %%StateOrProvince%% +- %%StreetAddress%% +- %%Title%% +- %%UserPrincipalName%% +- %%WindowsEmailAddress%% + +The maximum number of characters is 5000. + You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the text in the message body (the default value is Append), and the ApplyHtmlDisclaimerFallbackAction parameter to specify what to do if the disclaimer can't be added to the message (the default value is Wrap). ```yaml @@ -734,7 +776,7 @@ This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. -The ApplyOME parameter specifies an action that encrypts messages and their attachments by using Office 365 Message Encryption. Valid values are: +The ApplyOME parameter specifies an action that encrypts messages and their attachments by using Microsoft Purview Message Encryption. Valid values are: - $true: The message and attachments are encrypted. - $false: The message and attachments aren't encrypted. @@ -775,7 +817,7 @@ Accept wildcard characters: False ### -ApplyRightsProtectionTemplate This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ApplyRightsProtectionTemplate parameter specifies an action that applies rights management service (RMS) templates to messages. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). @@ -783,7 +825,7 @@ To use this action, you need to have an Active Directory Rights Management Servi Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. -For more information, see [Transport protection rules](https://docs.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). +For more information, see [Transport protection rules](https://learn.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). ```yaml Type: RmsTemplateIdParameter @@ -801,7 +843,7 @@ Accept wildcard characters: False ### -AttachmentContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentContainsWords parameter specifies a condition that looks for words in message attachments. Only supported attachment types are checked. @@ -823,10 +865,12 @@ Accept wildcard characters: False ### -AttachmentExtensionMatchesWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentExtensionMatchesWords parameter specifies a condition that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. +**Note:** Nested attachment extensions (files inside the original attachments) are also inspected. To see all attachment extensions that were evaluated for a specific message, use the Test-TextExtraction cmdlet. + ```yaml Type: Word[] Parameter Sets: (All) @@ -843,13 +887,15 @@ Accept wildcard characters: False ### -AttachmentHasExecutableContent This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. -The AttachmentHasExecutableContent parameter specifies a condition that looks for executable content in message attachments. Valid values are: +The AttachmentHasExecutableContent parameter specifies a condition that inspects messages where an attachment is an executable file. Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. +The system inspects the file properties rather than relying on the file's extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + ```yaml Type: Boolean Parameter Sets: (All) @@ -866,9 +912,9 @@ Accept wildcard characters: False ### -AttachmentIsPasswordProtected This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. -The AttachmentIsPasswordProtected parameter specifies a condition that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The AttachmentIsPasswordProtected parameter specifies a condition that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z), and .pdf files. Valid values are: - $true: Look for password protected attachments. - $false: Don't look for password protected attachments. @@ -889,14 +935,18 @@ Accept wildcard characters: False ### -AttachmentIsUnsupported This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. -The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: +The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. -For more information, see [Register Filter Pack IFilters with Exchange 2013](https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exchange 2010, to extend the list of supported file types, see [Register Filter Pack IFilters](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean @@ -914,7 +964,7 @@ Accept wildcard characters: False ### -AttachmentMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentMatchesPatterns parameter specifies a condition that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. @@ -938,7 +988,7 @@ Accept wildcard characters: False ### -AttachmentNameMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -958,7 +1008,7 @@ Accept wildcard characters: False ### -AttachmentProcessingLimitExceeded This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentProcessingLimitExceeded parameter specifies a condition that looks for messages where attachment scanning didn't complete. Valid values are: @@ -983,7 +1033,7 @@ Accept wildcard characters: False ### -AttachmentPropertyContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentPropertyContainsWords parameter specifies a condition that looks for words in the properties of attached Office documents. This condition helps integrate mail flow rules (transport rules) with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a third-party classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: @@ -1054,7 +1104,7 @@ Accept wildcard characters: False ### -BetweenMemberOf1 This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The BetweenMemberOf1 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. For example: @@ -1083,7 +1133,7 @@ Accept wildcard characters: False ### -BetweenMemberOf2 This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The BetweenMemberOf2 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. For example: @@ -1176,7 +1226,7 @@ Accept wildcard characters: False ### -ContentCharacterSetContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ContentCharacterSetContainsWords parameter specifies a condition that looks for character set names in messages. @@ -1248,7 +1298,7 @@ Accept wildcard characters: False ``` ### -Disconnect -This parameter is available or functional only on Edge Transport servers in on-premises Exchange. +This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -1271,7 +1321,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy -The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). +**Note**: This parameter is functional only in on-premises Exchange. + +The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). ```yaml Type: String @@ -1328,9 +1380,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonAttribute -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfADComparisonAttribute parameter specifies an exception that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. @@ -1380,9 +1432,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonOperator -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfADComparisonOperator parameter specifies the comparison operator for the ExceptIfADComparisonAttribute parameter. Valid values are: @@ -1403,9 +1455,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfCcHeader parameter specifies an exception that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: @@ -1436,9 +1488,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfCcHeaderMemberOf parameter specifies an exception that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. For example: @@ -1469,7 +1521,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1493,7 +1545,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1517,9 +1569,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfToCcHeader parameter specifies an exception that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. For example: @@ -1550,9 +1602,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfToCcHeaderMemberOf parameter specifies an exception that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. For example: @@ -1583,9 +1635,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfToHeader parameter specifies an exception that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. For example: @@ -1616,9 +1668,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfToHeaderMemberOf parameter specifies an exception that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. For example: @@ -1649,9 +1701,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentContainsWords parameter specifies an exception that looks for words in message attachments. Only supported attachment types are checked. @@ -1671,12 +1723,14 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentExtensionMatchesWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. +**Note:** Nested attachment extensions (files inside the original attachments) are also inspected. To see all attachment extensions that were evaluated for a specific message, use the Test-TextExtraction cmdlet. + ```yaml Type: Word[] Parameter Sets: (All) @@ -1691,15 +1745,17 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentHasExecutableContent -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that looks for executable content in message attachments. Valid values are: +The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that inspects messages where an attachment is an executable file. Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + ```yaml Type: Boolean Parameter Sets: (All) @@ -1714,11 +1770,11 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsPasswordProtected -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z), and .pdf files. Valid values are: - $true: Look for password protected attachments. - $false: Don't look for password protected attachments. @@ -1737,16 +1793,20 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsUnsupported -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: +The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. -For more information, see [Register Filter Pack IFilters with Exchange 2013](https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the ExceptIfAttachmentIsUnsupported exception is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exchange 2010, to extend the list of supported file types, see [Register Filter Pack IFilters](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean @@ -1762,9 +1822,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentMatchesPatterns parameter specifies an exception that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. @@ -1786,9 +1846,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentNameMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -1806,9 +1866,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentProcessingLimitExceeded -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentProcessingLimitExceeded parameter specifies an exception that looks for messages where attachment scanning didn't complete. Valid values are: @@ -1831,9 +1891,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentPropertyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentPropertyContainsWords parameter specifies an exception that looks for words in the properties of attached Office documents. This condition helps integrate rules with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a third-party classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: @@ -1870,7 +1930,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1900,9 +1960,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf1 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfBetweenMemberOf1 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. For example: @@ -1929,9 +1989,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf2 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfBetweenMemberOf2 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. For example: @@ -1958,9 +2018,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfContentCharacterSetContainsWords parameter specifies an exception that looks for character set names in messages. @@ -1980,9 +2040,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfFrom parameter specifies an exception that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: @@ -2011,7 +2071,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2033,7 +2093,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2041,6 +2101,8 @@ The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that loo You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). +**Note**: Trying to search for empty From addresses using this parameter doesn't work. + ```yaml Type: Pattern[] Parameter Sets: (All) @@ -2055,9 +2117,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfFromMemberOf parameter specifies an exception that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: @@ -2086,13 +2148,13 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -2109,9 +2171,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfHasClassification parameter specifies an exception that looks for messages with the specified message classification. @@ -2135,9 +2197,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasNoClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfHasNoClassification parameter specifies an exception that looks for messages with or without any message classifications. Valid values are: @@ -2158,9 +2220,11 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfHasSenderOverride parameter specifies an exception that looks for messages where the sender chose to override a DLP policy. Valid values are: @@ -2181,7 +2245,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2201,7 +2265,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2225,7 +2289,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2245,7 +2309,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2267,9 +2331,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerAddresses -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. For example: @@ -2298,9 +2362,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerForEvaluatedUser -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfManagerForEvaluatedUser parameter specifies an exception that looks for users in the Manager attribute of senders or recipients. Valid values are: @@ -2323,15 +2387,17 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageContainsDataClassifications -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +**Note:** This parameter is functional only in on-premises Exchange. -In on-premises Exchange, this exception is only available on Mailbox servers. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfMessageContainsDataClassifications parameter specifies an exception that looks for sensitive information types in the body of messages, and in any attachments. This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. -For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). +For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). ```yaml Type: Hashtable[] @@ -2347,7 +2413,7 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2377,17 +2443,17 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). -- Encrypted: Encrypted messages. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this exception **will not** match during mail flow rule evaluation. +- Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. -- PermissionControlled: Messages that have specific permissions configured. +- PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). - Voicemail: Voice mail messages forwarded by Unified Messaging service. - Signed: Digitally signed messages. - ApprovalRequest: Moderation request messages sent to moderators. @@ -2407,9 +2473,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -2463,9 +2529,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -2517,9 +2583,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -2537,9 +2603,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -2559,13 +2625,13 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the ExceptIfRecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". ```yaml Type: Word[] @@ -2599,11 +2665,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -This parameter is available or functional only in on-premises Exchange. - -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -This exception is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: @@ -2626,9 +2690,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderADAttributeContainsWords parameter specifies an exception that looks for words in Active Directory attributes of message senders. @@ -2682,9 +2746,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in Active Directory attributes of message senders by using regular expressions. @@ -2736,13 +2800,13 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -2778,9 +2842,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIpRanges -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderIpRanges parameter specifies an exception that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: @@ -2790,6 +2854,8 @@ The ExceptIfSenderIpRanges parameter specifies an exception that looks for sende You can specify multiple values separated by commas. +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -2804,9 +2870,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderManagementRelationship -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderManagementRelationship parameter specifies an exception that looks for the relationship between the sender and recipients in messages. Valid values are: @@ -2827,9 +2893,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: @@ -2856,7 +2922,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: @@ -2883,16 +2949,16 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSentToScope parameter specifies an exception that looks for the location of a recipient. Valid values are: -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. ```yaml Type: ToUserScope @@ -2908,13 +2974,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSubjectContainsWords parameter specifies an exception that looks for words in the Subject field of messages. -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. ```yaml Type: Word[] @@ -2930,7 +2998,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2950,13 +3018,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception that looks for words in the Subject field or body of messages. -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. ```yaml Type: Word[] @@ -2972,7 +3042,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2992,9 +3062,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfWithImportance parameter specifies an exception that looks for messages with the specified importance level. Valid values are: @@ -3016,11 +3086,11 @@ Accept wildcard characters: False ``` ### -ExpiryDate -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -3038,7 +3108,7 @@ Accept wildcard characters: False ### -From This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The From parameter specifies a condition that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: @@ -3097,6 +3167,8 @@ The FromAddressMatchesPatterns parameter specifies a condition that looks for te You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). +**Note**: Trying to search for empty From addresses using this parameter doesn't work. + ```yaml Type: Pattern[] Parameter Sets: (All) @@ -3113,7 +3185,7 @@ Accept wildcard characters: False ### -FromMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The FromMemberOf parameter specifies a condition that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: @@ -3148,7 +3220,7 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -3167,7 +3239,7 @@ Accept wildcard characters: False ### -GenerateIncidentReport This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The GenerateIncidentReport parameter specifies where to send the incident report that's defined by the IncidentReportContent parameter. You can use any value that uniquely identifies the recipient. For example: @@ -3178,7 +3250,7 @@ The GenerateIncidentReport parameter specifies where to send the incident report - Email address - GUID -An incident report is generated for messages that violate a DLP policy in your organization. +**Note**: An incident report isn't generated for notifications or other incident reports that are generated by DLP or mail flow rules. ```yaml Type: RecipientIdParameter @@ -3196,9 +3268,9 @@ Accept wildcard characters: False ### -GenerateNotification This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. -The GenerateNotification parameter specifies an action that sends a notification message to recipients. For example, you can use this parameter to notify recipients that a message was rejected by the rule, or marked as spam and delivered to their Junk Email folder. +The GenerateNotification parameter specifies an action that sends a notification message to recipients that match the conditions of the rule. For example, you can use this parameter to notify recipients that a message was rejected by the rule, or marked as spam and delivered to their Junk Email folder. Each matched recipient receives a separate notification. This parameter supports plain text, HTML tags and the following keywords that use values from the original message: @@ -3209,6 +3281,8 @@ This parameter supports plain text, HTML tags and the following keywords that us - %%Headers%% - %%MessageDate%% +The maximum number of characters is 5120. + ```yaml Type: DisclaimerText Parameter Sets: (All) @@ -3225,7 +3299,7 @@ Accept wildcard characters: False ### -HasClassification This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The HasClassification parameter specifies a condition that looks for messages with the specified message classification. @@ -3251,7 +3325,7 @@ Accept wildcard characters: False ### -HasNoClassification This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The HasNoClassification parameter specifies a condition that looks for messages with or without any message classifications. Valid values are: @@ -3272,9 +3346,11 @@ Accept wildcard characters: False ``` ### -HasSenderOverride +**Note:** This parameter is functional only in on-premises Exchange. + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The HasSenderOverride parameter specifies a condition that looks for messages where the sender chose to override a DLP policy. Valid values are: @@ -3383,9 +3459,9 @@ Accept wildcard characters: False ### -IncidentReportContent This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. -The IncidentReportContent parameter specifies the message properties that are included in the incident report that's generated when a message violates a DLP policy. Valid values are: +The IncidentReportContent parameter specifies the message properties that are included in the incident report. Valid values are: - Sender: The sender of the message. - Recipients: The recipients in the To field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. @@ -3393,10 +3469,8 @@ The IncidentReportContent parameter specifies the message properties that are in - CC: The recipients in the Cc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. - BCC: The recipients in the Bcc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. - Severity: The audit severity of the rule that was triggered. If the message was processed by more than one rule, the highest severity is displayed. -- Override: The override if the sender chose to override a PolicyTip. If the sender provided a justification, the first 100 characters of the justification is also included. - RuleDetections: The list of rules that the message triggered. - FalsePositive: The false positive if the sender marked the message as a false positive for a PolicyTip. -- DataClassifications: The list of sensitive information types that were detected in the message. - IdMatch: The sensitive information type that was detected, the exact matched content from the message, and the 150 characters before and after the matched sensitive information. - AttachOriginalMail: The entire original message as an attachment. @@ -3426,7 +3500,7 @@ This parameter has been deprecated and is no longer used. Use the IncidentReport This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The IncidentReportOriginalMail parameter specifies whether to include the original message with the incident report. This parameter is used together with the GenerateIncidentReport parameter. Valid values are: @@ -3447,7 +3521,7 @@ Accept wildcard characters: False ``` ### -LogEventText -This parameter is available or functional only on Edge Transport servers in on-premises Exchange. +This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3477,7 +3551,7 @@ Accept wildcard characters: False ### -ManagerAddresses This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. For example: @@ -3508,7 +3582,7 @@ Accept wildcard characters: False ### -ManagerForEvaluatedUser This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ManagerForEvaluatedUser parameter specifies a condition that looks for users in the Manager attribute of senders or recipients. Valid values are: @@ -3531,15 +3605,17 @@ Accept wildcard characters: False ``` ### -MessageContainsDataClassifications +**Note:** This parameter is functional only in on-premises Exchange. + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The MessageContainsDataClassifications parameter specifies a condition that looks for sensitive information types in the body of messages, and in any attachments. This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. -For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). +For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). You can specify the notification options by using the NotifySender parameter. @@ -3589,15 +3665,15 @@ Accept wildcard characters: False ### -MessageTypeMatches This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). -- Encrypted: Encrypted messages. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this condition **will not** match during mail flow rule evaluation. +- Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. -- PermissionControlled: Messages that have specific permissions configured. +- PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). - Voicemail: Voice mail messages forwarded by Unified Messaging service. - Signed: Digitally signed messages. - ApprovalRequest: Moderation request messages sent to moderators. @@ -3619,8 +3695,8 @@ Accept wildcard characters: False ### -Mode The Mode parameter specifies how the rule operates. Valid values are: -- Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. -- AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. +- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. +- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. - Enforce: All actions specified in the rule are taken. This is the default value. ```yaml @@ -3639,7 +3715,7 @@ Accept wildcard characters: False ### -ModerateMessageByManager This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ModerateMessageByManager parameter specifies an action that forwards messages for approval to the user that's specified in the sender's Manager attribute. After the manager approves the message, it's delivered to the recipients. Valid values are: @@ -3664,7 +3740,7 @@ Accept wildcard characters: False ### -ModerateMessageByUser This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ModerateMessageByUser parameter specifies an action that forwards messages for approval to the specified users. After one of the users approves the message, it's delivered to the recipients. You can use ay value that uniquely identifies the user. For example: @@ -3693,9 +3769,11 @@ Accept wildcard characters: False ``` ### -NotifySender +**Note:** This parameter is functional only in on-premises Exchange. + This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The NotifySender parameter specifies an action that notifies the sender when messages violate DLP policies. Valid values are: @@ -3709,6 +3787,8 @@ For all values except NotifyOnly, you can specify an enhanced status code and a If you use this parameter, you also need to specify a condition that looks for sensitive information types in messages by using the MessageContainsDataClassifications parameter. +This action is applicable to messages sent by internal users only. External senders will not receive notifications. + ```yaml Type: NotifySenderType Parameter Sets: (All) @@ -3778,6 +3858,8 @@ The Quarantine parameter specifies an action that quarantines messages. - In on-premises Exchange, messages are delivered to the quarantine mailbox that you've configured as part of Content filtering. If the quarantine mailbox isn't configured, the message is returned to the sender in an NDR. - In Microsoft 365, messages are delivered to the hosted quarantine. +If this action is in a rule that's not the last rule in the list, rule evaluation stops after this rule is run. When the message is released from quarantine, the remaining rules in the list aren't evaluated. + ```yaml Type: Boolean Parameter Sets: (All) @@ -3794,7 +3876,7 @@ Accept wildcard characters: False ### -RecipientADAttributeContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The RecipientADAttributeContainsWords parameter specifies a condition that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -3850,7 +3932,7 @@ Accept wildcard characters: False ### -RecipientADAttributeMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The RecipientADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -3904,7 +3986,7 @@ Accept wildcard characters: False ### -RecipientAddressContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The RecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -3924,7 +4006,7 @@ Accept wildcard characters: False ### -RecipientAddressMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -3948,8 +4030,8 @@ This parameter is available only in the cloud-based service. The RecipientAddressType parameter specifies how conditions and exceptions check recipient email addresses. Valid values are: -- Original: The rule checks only the recipient's primary SMTP email address. -- Resolved: The rule checks the recipient's primary SMTP email address and all proxy addresses. This is the default value +- Original: The rule checks the original address in the To field of the message. +- Resolved: The rule checks the recipient's primary SMTP email address without checking any proxy addresses. This is the default value. ```yaml Type: RecipientAddressType @@ -3967,11 +4049,11 @@ Accept wildcard characters: False ### -RecipientDomainIs This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the RecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". ```yaml Type: Word[] @@ -4036,7 +4118,7 @@ Accept wildcard characters: False ### -RejectMessageEnhancedStatusCode This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The RejectMessageEnhancedStatusCode parameter specifies the enhanced status code that's used when the rule rejects messages. Valid values are 5.7.1 or between 5.7.900 and 5.7.999. @@ -4062,10 +4144,14 @@ Accept wildcard characters: False ### -RejectMessageReasonText This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks ("). +In Exchange 2013 or later, the maximum number of characters is 256. + +In the cloud-based service, the maximum number of characters is 1024. + You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message). If you use this parameter with the RejectMessageEnhancedStatusCode parameter, the custom explanation text value is set to "Delivery not authorized, message refused". @@ -4110,7 +4196,7 @@ This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. -The RemoveOME parameter specifies an action that removes the previous version of Office 365 Message Encryption from messages and their attachments. Valid values are: +The RemoveOME parameter specifies an action that removes the previous version of Microsoft Purview Message Encryption from messages and their attachments. Valid values are: - $true: The message and attachments are decrypted. - $false: The message and attachments aren't decrypted. @@ -4133,7 +4219,7 @@ This parameter is available only in the cloud-based service. This parameter specifies an action or part of an action for the rule. -The RemoveOMEv2 parameter specifies an action that removes Office 365 Message Encryption from messages and their attachments. Valid values are: +The RemoveOMEv2 parameter specifies an action that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: - $true: The message and attachments are decrypted. - $false: The message and attachments aren't decrypted. @@ -4151,6 +4237,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoveRMSAttachmentEncryption +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RemoveRMSAttachmentEncryption parameter specifies an action that removes Microsoft Purview Message Encryption from encrypted attachments in email. The attachments were already encrypted before they were attached to the message. The message itself doesn't need to be encrypted. Valid values are: + +- $true: The encrypted attachments are decrypted. +- $false: The encrypted attachments aren't decrypted. + + This parameter also requires the value $true for the RemoveOMEv2 parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RouteMessageOutboundConnector This parameter is available only in the cloud-based service. @@ -4178,7 +4289,7 @@ Accept wildcard characters: False ### -RouteMessageOutboundRequireTls This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The RouteMessageOutboundRequireTls parameter specifies an action that uses Transport Layer Security (TLS) encryption to deliver messages outside your organization. Valid values are: @@ -4220,8 +4331,8 @@ Accept wildcard characters: False ### -RuleSubType The RuleSubType parameter specifies the rule type. Valid values are: -- Dlp: The rule is associated with a DLP policy. -- None: The rule is a regular rule that isn't associated with a DLP policy. +- Dlp: The rule is associated with a DLP policy. This value is meaningful only in on-premises Exchange. +- None: The rule is a regular transport rule. This is the default value. ```yaml Type: RuleSubType @@ -4237,11 +4348,9 @@ Accept wildcard characters: False ``` ### -SCLOver -This parameter is available or functional only in on-premises Exchange. - This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -This exception is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. The SCLOver parameter specifies a condition that looks for the SCL value of messages. Valid values are: @@ -4266,7 +4375,7 @@ Accept wildcard characters: False ### -SenderADAttributeContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderADAttributeContainsWords parameter specifies a condition that looks for words in Active Directory attributes of message senders. @@ -4322,7 +4431,7 @@ Accept wildcard characters: False ### -SenderADAttributeMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in Active Directory attributes of message senders by using regular expressions. @@ -4376,11 +4485,11 @@ Accept wildcard characters: False ### -SenderAddressLocation The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). +- Header: Only examine senders in the message headers. For example, in on-premises Exchange the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). - Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - HeaderOrEnvelope: Examine senders in the message header and the message envelope. -Note that message envelope searching is only available for the following conditions and exceptions: +Message envelope searching is available only for the following conditions and exceptions: - From and ExceptIfFrom - FromAddressContainsWords and ExceptIfFromAddressContainsWords @@ -4404,11 +4513,11 @@ Accept wildcard characters: False ### -SenderDomainIs This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -4446,7 +4555,7 @@ Accept wildcard characters: False ### -SenderIpRanges This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderIpRanges parameter specifies a condition that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: @@ -4456,6 +4565,8 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose You can specify multiple values separated by commas. +In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -4472,7 +4583,7 @@ Accept wildcard characters: False ### -SenderManagementRelationship This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderManagementRelationship parameter specifies a condition that looks for the relationship between the sender and recipients in messages. Valid values are: @@ -4495,7 +4606,7 @@ Accept wildcard characters: False ### -SentTo This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: @@ -4524,7 +4635,7 @@ Accept wildcard characters: False ### -SentToMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: @@ -4555,14 +4666,14 @@ Accept wildcard characters: False ### -SentToScope This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SentToScope parameter specifies a condition that looks for the location of recipients. Valid values are: -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. ```yaml Type: ToUserScope @@ -4580,7 +4691,7 @@ Accept wildcard characters: False ### -SetAuditSeverity This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The SetAuditSeverity parameter specifies an action that sets the severity level of the incident report and the corresponding entry that's written to the message tracking log when messages violate DLP policies. Valid values are: @@ -4666,7 +4777,7 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectStatusCode -This parameter is available or functional only on Edge Transport servers in on-premises Exchange. +This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4688,7 +4799,7 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectText -This parameter is available or functional only on Edge Transport servers in on-premises Exchange. +This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4739,7 +4850,9 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The SubjectContainsWords parameter specifies a condition that looks for words in the Subject field of messages. -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. ```yaml Type: Word[] @@ -4781,7 +4894,9 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The SubjectOrBodyContainsWords parameter specifies a condition that looks for words in the Subject field or body of messages. -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. ```yaml Type: Word[] @@ -4854,7 +4969,7 @@ Accept wildcard characters: False ### -WithImportance This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The WithImportance parameter specifies a condition that looks for messages with the specified importance level. Valid values are: @@ -4880,12 +4995,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-UMAutoAttendant.md b/exchange/exchange-ps/exchange/New-UMAutoAttendant.md index 2dc3b15a96..7f9922c4c4 100644 --- a/exchange/exchange-ps/exchange/New-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/New-UMAutoAttendant.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-umautoattendant +online version: https://learn.microsoft.com/powershell/module/exchange/new-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: New-UMAutoAttendant schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-UMAutoAttendant cmdlet to create a Unified Messaging (UM) auto attendant. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ The New-UMAutoAttendant cmdlet creates one or more UM auto attendants. UM auto a After this task is completed, a UM auto attendant is created. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -212,12 +212,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md index 1b262f4d3b..4fa9e1f46e 100644 --- a/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/exchange/New-UMCallAnsweringRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-umcallansweringrule +online version: https://learn.microsoft.com/powershell/module/exchange/new-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 title: New-UMCallAnsweringRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-UMCallAnsweringRule cmdlet to create a call answering rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,7 +53,7 @@ You can also specify the following actions: After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -251,7 +251,7 @@ Accept wildcard characters: False ``` ### -Mailbox -The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is created. You can use any value that uniquely identifies the mailbox. For example: +The Mailbox parameter specifies the UM-enabled mailbox where the call answering rule is created. You can use any value that uniquely identifies the mailbox. For example: - Name - Alias @@ -356,12 +356,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-UMDialPlan.md b/exchange/exchange-ps/exchange/New-UMDialPlan.md index f810bf781b..5b47dbb7ad 100644 --- a/exchange/exchange-ps/exchange/New-UMDialPlan.md +++ b/exchange/exchange-ps/exchange/New-UMDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-umdialplan +online version: https://learn.microsoft.com/powershell/module/exchange/new-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: New-UMDialPlan schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-UMDialPlan cmdlet to create a Unified Messaging (UM) dial plan to establish a link between UM IP gateways, UM hunt groups, and Mailbox servers to enable communication between Unified Messaging components. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ After the new UM dial plan is created, a UM IP gateway and a Mailbox server must After this task is completed, a new UM dial plan is created. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,8 +68,8 @@ This example creates the unsecured UM dial plan MyUMDialPlan that supports E.164 ## PARAMETERS -### -CountryOrRegionCode -The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America and 44 is the code used for the United Kingdom. +### -Name +The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters. ```yaml Type: String @@ -78,14 +78,14 @@ Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as 64 characters. +### -CountryOrRegionCode +The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is located. For example, 1 is the code used for North America and 44 is the code used for the United Kingdom. ```yaml Type: String @@ -94,7 +94,7 @@ Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -268,12 +268,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-UMHuntGroup.md b/exchange/exchange-ps/exchange/New-UMHuntGroup.md index 7418a98898..c471f60d1e 100644 --- a/exchange/exchange-ps/exchange/New-UMHuntGroup.md +++ b/exchange/exchange-ps/exchange/New-UMHuntGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-umhuntgroup +online version: https://learn.microsoft.com/powershell/module/exchange/new-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: New-UMHuntGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-UMHuntGroup cmdlet to create a Unified Messaging (UM) hunt group used to link incoming calls to a specific UM dial plan. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ The New-UMHuntGroup cmdlet creates a UM hunt group in Active Directory. Running After this task is completed, a new UM hunt group is created. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -174,12 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-UMIPGateway.md b/exchange/exchange-ps/exchange/New-UMIPGateway.md index 82df48987f..3e03d94273 100644 --- a/exchange/exchange-ps/exchange/New-UMIPGateway.md +++ b/exchange/exchange-ps/exchange/New-UMIPGateway.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-umipgateway +online version: https://learn.microsoft.com/powershell/module/exchange/new-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: New-UMIPGateway schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-UMIPGateway cmdlet to create a Unified Messaging (UM) IP gateway. A UM IP gateway is used to connect Unified Messaging servers to an IP gateway or a Session Initiation Protocol (SIP)-enabled IP Private Branch eXchange (PBX). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ A UM IP gateway has organization-wide scope and references a single physical IP This cmdlet is scheduled to be removed from Exchange Online on December 1, 2019. For more information, see this [blog post](https://techcommunity.microsoft.com/t5/Exchange-Team-Blog/New-date-for-discontinuation-of-support-for-Session-Border/ba-p/607853). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,33 +62,33 @@ This example creates the UM IP gateway MyUMIPGateway that enables a Mailbox serv ## PARAMETERS -### -Address -The Address parameter specifies the IP address configured on the IP gateway or SIP-enabled IP PBX. +### -Name +The Name parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters. ```yaml -Type: UMSmartHost +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The Name parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters. +### -Address +The Address parameter specifies the IP address configured on the IP gateway or SIP-enabled IP PBX. ```yaml -Type: String +Type: UMSmartHost Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -188,12 +188,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md index 2446aa5dd8..3ab4d1f26f 100644 --- a/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/New-UMMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-ummailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/new-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: New-UMMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-UMMailboxPolicy cmdlet to create a Unified Messaging (UM) mailbox policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The New-UMMailboxPolicy cmdlet creates a UM mailbox policy that has organization After this task is completed, a new UM mailbox policy is created. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -134,12 +134,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md index d3b2b99a1a..2196b0f833 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/New-UnifiedAuditLogRetentionPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-unifiedauditlogretentionpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/new-unifiedauditlogretentionpolicy +applicable: Security & Compliance title: New-UnifiedAuditLogRetentionPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # New-UnifiedAuditLogRetentionPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the New-UnifiedAuditLogRetentionPolicy cmdlet to create audit log retention policies in the Microsoft 365 Defender portal or the Microsoft 365 compliance center. +Use the New-UnifiedAuditLogRetentionPolicy cmdlet to create audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ New-UnifiedAuditLogRetentionPolicy [-Name] -Priority -Retention ``` ## DESCRIPTION -Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see [Manage audit log retention policies](https://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). +Audit log retention policies are used to specify a retention duration for audit logs for that are generated by admin and user activity. An audit log retention policy can specify the retention duration based on the type of audited activities, the Microsoft 365 service that activities are performed in, or the users who performed the activities. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -47,7 +47,7 @@ This example creates an audit log retention policy that retains all audit logs r ### Example 2 ```powershell -New-UnifiedAuditLogRetentionPolicy -Name "SearchQueryPerformed by app@sharepoint" -Description "90 day retention policy for noisy SharePoint events" -RecordTypes SharePoint -Operations SearchQueryPerformed -UserIds "app@sharepoint" -RetentionDuration ThreeMonths -Priority 10000 +New-UnifiedAuditLogRetentionPolicy -Name "SearchQueryPerformed by app@sharepoint" -Description "90 day retention policy for noisy SharePoint events" -RecordTypes SharePoint -Operations SearchQueryPerformed -UserIds "app@sharepoint" -RetentionDuration ThreeMonths -Priority 10000 ``` This example creates an audit log retention policy that retains all audit logs for the SearchQueryPerformed activity performed by the app@sharepoint service account for 90 days. @@ -61,7 +61,7 @@ The Name parameter specifies a unique name for the audit log retention policy. T Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -71,13 +71,17 @@ Accept wildcard characters: False ``` ### -Priority -The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A lower integer value indicates a higher priority, the value 1 is the highest priority, and policies can't have the same priority value. Any custom audit log retention policy that you create will take precedence over the default audit log retention policy. For more information, see [Manage audit log retention policies](https://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). +The Priority parameter specifies a priority value for the policy that determines the order of policy processing. A higher integer value indicates a lower priority. The value 1 is the highest priority, and the value 10000 is the lowest priority. No two policies can have the same priority value. + +This parameter is required when you create an audit log retention policy, and you must use a unique priority value. + +Any custom audit log retention policy that you create will take precedence over the default audit log retention policy. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -100,7 +104,7 @@ Type: UnifiedAuditLogRetentionDuration Parameter Sets: (All) Aliases: Accepted values: ThreeMonths, SixMonths, NineMonths, TwelveMonths, TenYears -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -119,7 +123,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -135,7 +139,7 @@ The Description parameter specifies a description for the audit log retention po Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -145,7 +149,7 @@ Accept wildcard characters: False ``` ### -Operations -The Operations parameter specifies the audit log operations that are retained by the policy. For a list of the available values for this parameter, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). +The Operations parameter specifies the audit log operations that are retained by the policy. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -155,7 +159,7 @@ If you use this parameter, you must also use the RecordTypes parameter to specif Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -165,7 +169,7 @@ Accept wildcard characters: False ``` ### -RecordTypes -The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see [AuditLogRecordType](https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). +The RecordTypes parameter specifies the audit logs of a specific record type that are retained by the policy. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). You can specify multiple values separated by commas. If you specify more than one value, you can't use the Operations parameter. @@ -173,7 +177,7 @@ You can specify multiple values separated by commas. If you specify more than on Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -191,7 +195,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -201,13 +205,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -221,12 +225,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-UnifiedGroup.md b/exchange/exchange-ps/exchange/New-UnifiedGroup.md index 2dfa5d7280..7490a242d1 100644 --- a/exchange/exchange-ps/exchange/New-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/New-UnifiedGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-unifiedgroup -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/new-unifiedgroup +applicable: Exchange Online, Exchange Online Protection title: New-UnifiedGroup schema: 2.0.0 author: chrisda @@ -16,9 +16,9 @@ This cmdlet is available only in the cloud-based service. Use the New-UnifiedGroup cmdlet to create Microsoft 365 Groups in your cloud-based organization. To add members, owners, and subscribers to Microsoft 365 Groups, use the Add-UnifiedGroupLinks cmdlet. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: You can't use this cmdlet to create Microsoft 365 Groups if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see [Create group](https://learn.microsoft.com/graph/api/group-post-groups). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,6 +37,7 @@ New-UnifiedGroup [-DisplayName ] [-ExecutingUser ] [-ExoErrorAsWarning] [-HiddenGroupMembershipEnabled] + [-IsMemberAllowedToEditContent ] [-Language ] [-ManagedBy ] [-Members ] @@ -125,7 +126,7 @@ New-UnifiedGroup -DlIdentity ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -147,7 +148,7 @@ For Microsoft 365 Groups, the DisplayName value is used in the unique Name prope Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -176,7 +177,7 @@ Microsoft 365 Groups don't have ReportToManager and ReportToOriginator parameter Type: DistributionGroupIdParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -189,7 +190,7 @@ Accept wildcard characters: False The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Valid values are: - Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. This is the default value. -- Private: The group content and conversations are only available to members of the group, and joining the group requires approval from a group owner. +- Private: The group content and conversations are available only to members of the group, and joining the group requires approval from a group owner. You can change the privacy type at any point in the lifecycle of the group. @@ -199,7 +200,7 @@ You can change the privacy type at any point in the lifecycle of the group. Type: ModernGroupTypeInfo Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -209,13 +210,18 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: + +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. If you don't use the Alias parameter when you create a Microsoft 365 Group, the value of the DisplayName parameter is used for the Alias value. Spaces are removed, unsupported characters are converted to question marks (?), and numbers may be added to maintain the uniqueness of the Alias value. -When you create a Microsoft 365 Group without using the EmailAddresses parameter, the Alias value is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a Microsoft 365 Group without using the EmailAddresses parameter, the Alias value is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. The Alias value is appended with the ExternalDirectoryObjectId property value and used as the Name property value for the Microsoft 365 Group (`_`). @@ -223,7 +229,7 @@ The Alias value is appended with the ExternalDirectoryObjectId property value an Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -236,7 +242,7 @@ Accept wildcard characters: False The AlwaysSubscribeMembersToCalendarEvents switch controls the default subscription settings of new members that are added to the Microsoft 365 Group. - If you use this switch without a value, all future members that are added to the group will have their subscriptions set to ReplyAndEvents. -- If you use this exact syntax: -AlwaysSubscribeMembersToCalendarEvents:$false, all future members that are added to the group will have their subscriptions set to ReplyOnly. +- If you use this exact syntax: `-AlwaysSubscribeMembersToCalendarEvents:$false`, all future members that are added to the group will have their subscriptions set to ReplyOnly. Group members can change their own subscription settings, which can override your intended use of this switch. @@ -246,7 +252,7 @@ The AutoSubscribeNewMembers switch overrides this switch. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -264,7 +270,7 @@ You need to use this switch with the SubscriptionEnabled switch. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -280,7 +286,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -299,7 +305,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -321,7 +327,7 @@ You can only use this switch with the DlIdentity parameter. Type: SwitchParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -341,7 +347,7 @@ The DataEncryptionPolicy parameter specifies the data encryption policy that's a Type: DataEncryptionPolicyIdParameter Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -359,7 +365,7 @@ You can only use this switch with the DlIdentity parameter. Type: SwitchParameter Parameter Sets: DlMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -369,16 +375,15 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the Microsoft 365 Group, including the primary SMTP address. In cloud-based organizations, the primary SMTP address and other proxy addresses for Microsoft 365 Groups are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the Microsoft 365 Group. -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. -- X400: X.400 addresses in on-premises Exchange. -- X500: X.500 addresses in on-premises Exchange. +- SPO: SharePoint email address. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -390,7 +395,7 @@ To specify the primary SMTP email address, you can use any of the following meth Type: ProxyAddressCollection Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -406,7 +411,7 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -418,13 +423,13 @@ Accept wildcard characters: False ### -ExoErrorAsWarning The ExoErrorAsWarning switch specifies that Exchange Online errors that you encounter while creating the Microsoft 365 Group are treated as warnings, not errors. You don't need to specify a value with this switch. -Creating Microsoft 365 Groups involves background operations in Azure Active Directory and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Azure Active Directory is synchronized back to Exchange Online. +Creating Microsoft 365 Groups involves background operations in Microsoft Entra ID and Exchange Online. Errors that you might encounter in Exchange Online don't prevent the creation of the group (and therefore aren't really errors), because the group object in Microsoft Entra ID is synchronized back to Exchange Online. ```yaml Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -436,15 +441,31 @@ Accept wildcard characters: False ### -HiddenGroupMembershipEnabled The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the Microsoft 365 Group from users who aren't members of the group. You don't need to specify a value with this switch. -You can use this setting to help comply with regulations that require you to hide group membership from outsiders (for example, a Microsoft 365 Group group that represents students enrolled in a class). +You can use this setting to help comply with regulations that require you to hide group membership from outsiders (for example, a Microsoft 365 Group that represents students enrolled in a class). -**Note**: You can't change this setting after you create the group. If you create the group with hidden membership, you can't edit the group later to reveal the membership to the group. +**Note**: You can't change this setting after you create the group. If you create the group with hidden membership, you can't edit the group later to reveal the membership to the group, or vice-versa. In addition, any Microsoft 365 Groups with this setting will not be supported in sensitivity labeling policies. ```yaml Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsMemberAllowedToEditContent +{{ Fill IsMemberAllowedToEditContent Description }} + +```yaml +Type: System.Boolean +Parameter Sets: Identity +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -456,13 +477,13 @@ Accept wildcard characters: False ### -Language The Language parameter specifies the language preference for the Microsoft 365 Group. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -472,13 +493,13 @@ Accept wildcard characters: False ``` ### -MailboxRegion -This parameter is reserved for internal Microsoft use. +The MailboxRegion parameter specifies the preferred data location (PDL) for the Microsoft 365 Group in multi-geo environments. ```yaml Type: String Parameter Sets: Identity Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -494,7 +515,7 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -519,7 +540,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -537,7 +558,7 @@ Previously, if you specified a value for this parameter, a random GUID value was Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -553,7 +574,7 @@ The Notes parameter specifies the description of the Microsoft 365 Group. If the Type: String Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -578,7 +599,7 @@ The owner you specify for this parameter must be a mailbox or mail user (a mail- Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -594,7 +615,7 @@ The PrimarySmtpAddress parameter specifies the primary return email address that Type: SmtpAddress Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -613,7 +634,7 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -623,15 +644,15 @@ Accept wildcard characters: False ``` ### -SensitivityLabelId -This parameter is available only in the cloud-based service. +The SensitivityLabelId parameter specifies the GUID value of the sensitivity label that's assigned to the Microsoft 365 Group. -{{ Fill SensitivityLabelId Description }} +**Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. ```yaml Type: System.Guid Parameter Sets: Identity, SegmentationOption, ProvisioningOptions Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -647,7 +668,7 @@ The SubscriptionEnabled switch specifies whether subscriptions to conversations Type: SwitchParameter Parameter Sets: SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -663,7 +684,7 @@ This parameter has been deprecated and is no longer used. Type: SwitchParameter Parameter Sets: Identity, ProvisioningOptions, SegmentationOption Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -679,7 +700,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -693,12 +714,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md index ee0f1ed2f7..f99ae64e15 100644 --- a/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/New-WebServicesVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-webservicesvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/new-webservicesvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-WebServicesVirtualDirectory schema: 2.0.0 @@ -18,7 +18,7 @@ Use the New-WebServicesVirtualDirectory cmdlet to create Exchange Web Services v You can create multiple virtual directories by using this cmdlet. However, you can create only one Exchange Web Services virtual directory for each website. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,7 +52,7 @@ New-WebServicesVirtualDirectory [-ApplicationRoot ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -268,7 +268,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -341,7 +343,7 @@ Accept wildcard characters: False ``` ### -MRSProxyEnabled -The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Mailbox server. MRSProxy is a service that runs on Mailbox servers in a remote forest and helps to proxy a mailbox move. For more information, see [Mailbox moves in Exchange Server](https://docs.microsoft.com/Exchange/recipients/mailbox-moves). +The MRSProxyEnabled parameter specifies whether to enable MRSProxy for the Mailbox server. MRSProxy is a service that runs on Mailbox servers in a remote forest and helps to proxy a mailbox move. For more information, see [Mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/recipients/mailbox-moves). ```yaml Type: Boolean @@ -359,7 +361,7 @@ Accept wildcard characters: False ### -MRSProxyMaxConnections This parameter is available only in Exchange Server 2010. -The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). +The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). ```yaml Type: Unlimited @@ -526,12 +528,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md index 2adaa02f18..c18e6668eb 100644 --- a/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/exchange/New-X400AuthoritativeDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/new-x400authoritativedomain +online version: https://learn.microsoft.com/powershell/module/exchange/new-x400authoritativedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: New-X400AuthoritativeDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the New-X400AuthoritativeDomain cmdlet to create and specify the X.400 authoritative domain for the organization. The X.400 authoritative domain defines the standard fields for the namespace appended to the recipient identity for all mailboxes assigned an X.400 address. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -64,7 +64,7 @@ organizational unit name - Abbreviation: OU1 to OU4 - Maximum character length: 32 -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -201,12 +201,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md index be6cb2dc95..655b0da6f5 100644 --- a/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Preview-QuarantineMessage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/preview-quarantinemessage -applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/preview-quarantinemessage +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Preview-QuarantineMessage schema: 2.0.0 author: chrisda @@ -16,19 +16,19 @@ This cmdlet is available only in the cloud-based service. Use the Preview-QuarantineMessage cmdlet to preview the contents of quarantined messages in your cloud-based organization. This cmdlet doesn't work on files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Preview-QuarantineMessage -Identity + [-EntityType ] + [-RecipientAddress ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -66,17 +66,50 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientAddress +The RecipientAddress parameter filters the results by the recipient's email address. You can specify multiple values separated by commas. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Redirect-Message.md b/exchange/exchange-ps/exchange/Redirect-Message.md index faf6e3d2cd..1a0354a5bc 100644 --- a/exchange/exchange-ps/exchange/Redirect-Message.md +++ b/exchange/exchange-ps/exchange/Redirect-Message.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/redirect-message +online version: https://learn.microsoft.com/powershell/module/exchange/redirect-message applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Redirect-Message schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Redirect-Message cmdlet to drain the active messages from all the delivery queues on a Mailbox server, and transfer those messages to another Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ When a message queue is drained, the active messages in the queues on the source - Messages in the poison message queue aren't drained. - The source server won't accept new messages while the queues are drained. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,12 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md index 5ddc21b679..17f3d5590b 100644 --- a/exchange/exchange-ps/exchange/Release-QuarantineMessage.md +++ b/exchange/exchange-ps/exchange/Release-QuarantineMessage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/release-quarantinemessage -applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/release-quarantinemessage +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Release-QuarantineMessage schema: 2.0.0 author: chrisda @@ -18,9 +18,7 @@ Use the Release-QuarantineMessage cmdlet to release messages from quarantine in For files that were quarantined by Safe Attachments for SharePoint, OneDrive, and Microsoft Teams, you can unblock the files in the respective team sites and document libraries by using the Release-QuarantineMessage cmdlet so users can access, share, and download the files. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,6 +28,7 @@ Release-QuarantineMessage -User [-Identities ] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -42,6 +41,7 @@ Release-QuarantineMessage [-Identities ] [-Identity [-ReleaseToAll] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -52,8 +52,10 @@ Release-QuarantineMessage [-Identities ] [-Identity ``` Release-QuarantineMessage -Identities [-Identity ] + [-ActionType ] [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -65,6 +67,7 @@ Release-QuarantineMessage -Identities Release-QuarantineMessage -Identity [-AllowSender] [-Confirm] + [-EntityType ] [-Force] [-ReportFalsePositive] [-WhatIf] @@ -74,7 +77,7 @@ Release-QuarantineMessage -Identity ## DESCRIPTION Consider the following scenario: john@gmail.com sends a message to faith@contoso.com and john@subsidiary.contoso.com. Gmail bifurcates this message into two copies that are both routed to quarantine as phishing in Microsoft. An admin releases both of these messages to admin@contoso.com. The first released message that reaches the admin mailbox is delivered. The second released message is identified as duplicate delivery and is skipped. Message are identified as duplicates if they have the same message ID and received time. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,10 +105,11 @@ This example releases all messages to all original recipients. ### Example 4 ```powershell $q = Get-QuarantineMessage -QuarantineTypes SPOMalware + $q[-1] | Release-QuarantineMessage -ReleaseToAll ``` -This example releases a file that was quarantined as part of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. The first command stores all quarantined files in the variable $q. The second command releases the last file in the list. For more information about elements in arrays and index numbers, see [Accessing and Using Array Elements](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_arrays#accessing-and-using-array-elements). +This example releases a file that was quarantined as part of Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. The first command stores all quarantined files in the variable $q. The second command releases the last file in the list. For more information about elements in arrays and index numbers, see [Accessing and Using Array Elements](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_arrays#accessing-and-using-array-elements). ## PARAMETERS @@ -120,7 +124,7 @@ When you use this parameter, the Identity parameter is required, but the value i Type: QuarantineMessageIdentity[] Parameter Sets: Identities Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -151,7 +155,7 @@ You can find the Identity value for a quarantined message by using the Get-Quara Type: QuarantineMessageIdentity Parameter Sets: Identities, OrgReleaseToAll, OrgReleaseToUser Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -164,7 +168,7 @@ Accept wildcard characters: False Type: QuarantineMessageIdentity Parameter Sets: IdentityOnly Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -176,7 +180,7 @@ Accept wildcard characters: False ### -ReleaseToAll The ReleaseToAll switch releases the quarantined message to all original recipients. You don't need to specify a value with this switch. -This parameter is required for the quarantine type SPOMalware. +This switch is required for the quarantine type SPOMalware. If you previously used the User parameter or the ReleaseToAll switch to release the quarantined message to some or all of the original recipients, those recipients are skipped when you use the ReleaseToAll switch again. @@ -186,7 +190,7 @@ You can't use the ReleaseToAll switch and the User parameter in the same command Type: SwitchParameter Parameter Sets: OrgReleaseToAll Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -206,7 +210,7 @@ If you previously used the ReleaseToAll switch to release the quarantined messag Type: String[] Parameter Sets: OrgReleaseToUser Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -215,6 +219,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ActionType +The ActionType parameter specifies the release action type. Valid values are: + +- Deny +- Release: Use this value to release messages or approve requests to release messages. +- Request + +```yaml +Type: ReleaseActionType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowSender The AllowSender switch specifies that all future messages from the sender won't be quarantined. You don't need to specify a value with this switch. @@ -224,7 +248,7 @@ If the message was quarantined because of a transport rule or blocked sender, me Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -243,7 +267,28 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +The EntityType parameter filters the results by EntityType. Valid values are: + +- Email +- SharePointOnline +- Teams (currently in Preview) +- DataLossPrevention + +```yaml +Type: Microsoft.Exchange.Management.FfoQuarantine.EntityType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -253,15 +298,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to attempt the re-release of previously released messages from quarantine. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -You need to use this switch whenever you attempt to re-release previously released messages from quarantine. +Use this switch whenever you attempt to re-release previously released messages from quarantine. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -271,15 +316,15 @@ Accept wildcard characters: False ``` ### -ReportFalsePositive -The ReportFalsePositive switch sends a notification message indicating the specified message was not spam. You don't need to specify a value with this switch. +The ReportFalsePositive switch specifies whether to report the message as a false positive to Microsoft (good message marked as bad). You don't need to specify a value with this switch. -This switch is only available for quarantined spam messages. +This switch is available only for quarantined spam messages. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -291,13 +336,13 @@ 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. -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -311,12 +356,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ADPermission.md b/exchange/exchange-ps/exchange/Remove-ADPermission.md index 09bd7a07de..13ca24fb1e 100644 --- a/exchange/exchange-ps/exchange/Remove-ADPermission.md +++ b/exchange/exchange-ps/exchange/Remove-ADPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-adpermission +online version: https://learn.microsoft.com/powershell/module/exchange/remove-adpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-ADPermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ADPermission cmdlet to remove permissions from an Active Directory object. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -63,9 +63,9 @@ Remove-ADPermission [[-Identity] ] -Instance + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +This example removes the existing rule for Defender for Office 365 protections in the Standard preset security policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md b/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md index 55947e9b3a..5339aa412e 100644 --- a/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Remove-AcceptedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-accepteddomain +online version: https://learn.microsoft.com/powershell/module/exchange/remove-accepteddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-AcceptedDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-AcceptedDomain cmdlet to remove an accepted domain. When you remove an accepted domain, the accepted domain object is deleted. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-AcceptedDomain [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md index c9df40f102..5ec58a6bb4 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-activesyncdevice +online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncdevice applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-ActiveSyncDevice schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Remove-ActiveSyncDevice cmdlet to remove mobile device partnerships that **Note**: In Exchange 2013 or later, use the Remove-MobileDevice cmdlet instead. If you have scripts that use Remove-ActiveSyncDevice, update them to use Remove-MobileDevice. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Remove-ActiveSyncDevice [-Identity] ## DESCRIPTION The Remove-ActiveSyncDevice cmdlet is useful for removing mobile devices that no longer synchronize successfully with the server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -134,12 +134,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md index 08799fef95..5e56ff683d 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncDeviceAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-activesyncdeviceaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncdeviceaccessrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-ActiveSyncDeviceAccessRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ActiveSyncDeviceAccessRule cmdlet to remove any existing device access rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-ActiveSyncDeviceAccessRule [-Identity] ## DESCRIPTION The Remove-ActiveSyncDeviceClass cmdlet cleans up the list of devices that are associated with your organization. Mobile phones and devices that are inactive or have been remote wiped are removed from the list and the Microsoft Exchange ActiveSync process regenerates the list with the current mobile phones and devices. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md index db1b77ed36..faa170542f 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-activesyncmailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncmailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-ActiveSyncMailboxPolicy schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Remove-ActiveSyncMailboxPolicy cmdlet to remove mobile device mailbox po **Note**: In Exchange 2013 or later, use the Remove-MobileDeviceMailboxPolicy cmdlet instead. If you have scripts that use Remove-ActiveSyncMailboxPolicy, update them to use Remove-MobileDeviceMailboxPolicy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Remove-ActiveSyncMailboxPolicy [-Identity] ## DESCRIPTION A mobile device mailbox policy is a group of settings that specifies how mobile phones connect to Exchange. Exchange supports multiple mobile device mailbox policies. If any users are assigned to the policy when you attempt to remove it, the command fails. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -112,7 +112,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -148,12 +150,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md index 7e5295f25b..a45a5a2bd8 100644 --- a/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-ActiveSyncVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-activesyncvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/remove-activesyncvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-ActiveSyncVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ActiveSyncVirtualDirectory cmdlet to remove existing Exchange ActiveSync virtual directories from Internet Information Services (IIS) virtual directories on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-ActiveSyncVirtualDirectory [-Identity] ## DESCRIPTION When the Exchange ActiveSync virtual directory is removed from a specified server and website, the virtual directory is also removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -136,12 +136,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ActivityAlert.md b/exchange/exchange-ps/exchange/Remove-ActivityAlert.md deleted file mode 100644 index 78238bcbc3..0000000000 --- a/exchange/exchange-ps/exchange/Remove-ActivityAlert.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-activityalert -applicable: Security & Compliance Center -title: Remove-ActivityAlert -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-ActivityAlert - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-ActivityAlert cmdlet to remove activity alerts from the Microsoft 365 Defender portal or the Microsoft 365 compliance center. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-ActivityAlert [-Identity] - [-Confirm] - [-ForceDeletion] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-ActivityAlert -Identity "All Mailbox Activities" -``` - -This example removes the activity alert named All Mailbox Activities. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the activity alert that you want to remove. You can use any value that uniquely identifies the activity alert. For example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDeletion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md b/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md new file mode 100644 index 0000000000..6716aabc5e --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AdaptiveScope.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-adaptivescope +applicable: Security & Compliance +title: Remove-AdaptiveScope +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AdaptiveScope + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Remove-AdaptiveScope cmdlet to remove adaptive scopes from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AdaptiveScope [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-AdaptiveScope -Identity "Project X" +``` + +This example removes the adaptive scope named Project X. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the adaptive scope that you want to remove. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the adaptive scope. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md index dc819b3e6e..f2bac7b9a2 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AddressBookPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-addressbookpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-addressbookpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-AddressBookPolicy schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-AddressBookPolicy cmdlet to delete an address book policy. You can't remove the address book policy if it's still assigned to a user's mailbox. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ You can't delete an address book policy if it's assigned to a user. To determine `Get-Mailbox -ResultSize unlimited -Filter "AddressBookPolicy -eq '$((Get-AddressBookPolicy "Murchison's Class").DistinguishedName)'"` -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AddressList.md b/exchange/exchange-ps/exchange/Remove-AddressList.md index 303c1ca999..a77eb38489 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressList.md +++ b/exchange/exchange-ps/exchange/Remove-AddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-addresslist +online version: https://learn.microsoft.com/powershell/module/exchange/remove-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-AddressList schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-AddressList cmdlet to remove existing address lists. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ You can use the Remove-AddressList cmdlet with the Get-AddressList cmdlet in the - Use the Get-AddressList cmdlet to get address list information, and then pipe the output to the Format-List cmdlet to get the GUID, distinguished name (DN), or path and name of an existing address list. - Use the Get-AddressList cmdlet to get a specific existing address list, and then pipe the output directly to the Remove-AddressList cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -149,12 +149,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md index d59aa84da6..8eb9950d2e 100644 --- a/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md +++ b/exchange/exchange-ps/exchange/Remove-AddressRewriteEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-addressrewriteentry +online version: https://learn.microsoft.com/powershell/module/exchange/remove-addressrewriteentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-AddressRewriteEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-AddressRewriteEntry cmdlet to remove an existing address rewrite entry that's no longer needed on an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -127,12 +127,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md index 01ebd3e427..6bff81fad7 100644 --- a/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AntiPhishPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-antiphishpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-antiphishpolicy applicable: Exchange Online, Exchange Online Protection title: Remove-AntiPhishPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-AntiPhishPolicy cmdlet to remove antiphish policies from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +29,7 @@ Remove-AntiPhishPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -84,7 +82,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -120,12 +120,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md b/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md index 6d99e389c7..77562bbd26 100644 --- a/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/Remove-AntiPhishRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-antiphishrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-antiphishrule applicable: Exchange Online, Exchange Online Protection title: Remove-AntiPhishRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-AntiPhishRule cmdlet to remove antiphish rules from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Remove-AntiPhishRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-App.md b/exchange/exchange-ps/exchange/Remove-App.md index 837b0ec17b..c24c1658e5 100644 --- a/exchange/exchange-ps/exchange/Remove-App.md +++ b/exchange/exchange-ps/exchange/Remove-App.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-app +online version: https://learn.microsoft.com/powershell/module/exchange/remove-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-App schema: 2.0.0 @@ -16,12 +16,13 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-App cmdlet to uninstall an app. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Remove-App [-Identity] + [-AppType ] [-Confirm] [-DomainController ] [-Mailbox ] @@ -34,7 +35,7 @@ Remove-App [-Identity] ## DESCRIPTION The Remove-App cmdlet requires that the specified app has already been installed (for example, that the app has been installed with the New-App cmdlet. Apps installed by default can't be uninstalled, but they can be disabled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,6 +64,24 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AppType +This parameter is available only in the cloud-based service. + +{{ Fill AppType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -128,7 +147,9 @@ Accept wildcard characters: False ``` ### -OrganizationApp -The OrganizationApp parameter specifies that the scope of the app is organizational. This is set to $false by default. This parameter is required if the targeted app is installed for the organization. +The OrganizationApp switch specifies that the scope of the app is organizational. You don't need to specify a value with this switch. + +This switch is required if the targeted app is installed for the organization. ```yaml Type: SwitchParameter @@ -180,12 +201,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md new file mode 100644 index 0000000000..c470a3f9f2 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionCompliancePolicy.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancepolicy +applicable: Security & Compliance +title: Remove-AppRetentionCompliancePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AppRetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Remove-AppRetentionCompliancePolicy to remove app retention compliance policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AppRetentionCompliancePolicy -Identity "Contoso Viva Engage" +``` + +This example removes the app retention compliance policy named Contoso Viva Engage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md new file mode 100644 index 0000000000..724cda7063 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-AppRetentionComplianceRule.md @@ -0,0 +1,125 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-appretentioncompliancerule +applicable: Security & Compliance +title: Remove-AppRetentionComplianceRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-AppRetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Remove-AppRetentionComplianceRule to remove app retention compliance rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-AppRetentionComplianceRule [-Identity] + [-Confirm] + [-ForceDeletion] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-AppRetentionComplianceRule -Identity "Contoso Viva Engage" +``` + +This example removes the app retention compliance policy rule Contoso Viva Engage. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance rule that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md index bcc5ed2c0e..9b1bae6a1a 100644 --- a/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-ApplicationAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-applicationaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection title: Remove-ApplicationAccessPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-ApplicationAccessPolicy cmdlet to remove application access policies. These changes may take up to 30 minutes to go live. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Remove-ApplicationAccessPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,7 +77,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work on this cmdlet. +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 @@ -99,12 +97,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md b/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md index 4e9e799880..a166c59fe8 100644 --- a/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md +++ b/exchange/exchange-ps/exchange/Remove-AttachmentFilterEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-attachmentfilterentry +online version: https://learn.microsoft.com/powershell/module/exchange/remove-attachmentfilterentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-AttachmentFilterEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-AttachmentFilterEntry cmdlet to remove an entry from the attachment filter list that's used by the Attachment Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-AttachmentFilterEntry [-Identity] ``` ## DESCRIPTION -On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://docs.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). +On Edge Transport servers, the Attachment Filtering agent blocks attachments in messages based on the content type and the file name of the attachment. The configuration of the Attachment Filtering agent determines how messages that contain the specified attachments are processed. For more information about how to configure the Attachment Filtering agent, see [Set-AttachmentFilterListConfig](https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig). On Edge Transport servers, you need to be a member of the local Administrators group to run this cmdlet. @@ -130,12 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md b/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md deleted file mode 100644 index 07a1995e52..0000000000 --- a/exchange/exchange-ps/exchange/Remove-AuditConfigurationPolicy.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-auditconfigurationpolicy -applicable: Exchange Online, Security & Compliance Center -title: Remove-AuditConfigurationPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-AuditConfigurationPolicy - -## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-AuditConfigurationPolicy cmdlet to remove audit configuration policies. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-AuditConfigurationPolicy [-Identity] - [-Confirm] - [-DomainController ] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-AuditConfigurationPolicy -Identity 8d4d2060-ee8e-46a8-8d72-24922956fba5 -``` - -This example removes the audit configuration policy named 8d4d2060-ee8e-46a8-8d72-24922956fba5. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the audit configuration policy that you want to remove. The name of the policy is a GUID value. For example, 8d4d2060-ee8e-46a8-8d72-24922956fba5. You can find the name value by running the following command: Get-AuditConfigurationPolicy | Format-List Name,Enabled,Workload,Priority,\*Location. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AuditConfigurationRule.md b/exchange/exchange-ps/exchange/Remove-AuditConfigurationRule.md deleted file mode 100644 index c48d415bf1..0000000000 --- a/exchange/exchange-ps/exchange/Remove-AuditConfigurationRule.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-auditconfigurationrule -applicable: Exchange Online, Security & Compliance Center -title: Remove-AuditConfigurationRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-AuditConfigurationRule - -## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-AuditConfigurationRule cmdlet to remove audit configuration rules. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-AuditConfigurationRule [-Identity] - [-Confirm] - [-DomainController ] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-AuditConfigurationRule 989a3a6c-dc40-4fa4-8307-beb3ece992e9 -``` - -This example removes the audit configuration rule named 989a3a6c-dc40-4fa4-8307-beb3ece992e9. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the audit configuration rule that you want to remove. The name of the rule is a GUID value. For example, 989a3a6c-dc40-4fa4-8307-beb3ece992e9. You can find the name value by running the following command: Get-AuditConfigurationRule | Format-List Name,Workload,AuditOperation,Policy. - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md b/exchange/exchange-ps/exchange/Remove-AuthRedirect.md index 8dfdeaf8b0..5472c1ac64 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthRedirect.md +++ b/exchange/exchange-ps/exchange/Remove-AuthRedirect.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-authredirect +online version: https://learn.microsoft.com/powershell/module/exchange/remove-authredirect applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-AuthRedirect schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-AuthRedirect cmdlet to remove OAuth redirection objects that are used for legacy Microsoft Exchange 2010 Client Access servers in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,13 +29,13 @@ Remove-AuthRedirect [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Remove-AuthRedirect AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE +Remove-AuthRedirect -Identity AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE ``` This example removes the existing OAuth redirection object named AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE. @@ -121,12 +121,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AuthServer.md b/exchange/exchange-ps/exchange/Remove-AuthServer.md index eb27901a44..826c25a07f 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthServer.md +++ b/exchange/exchange-ps/exchange/Remove-AuthServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-authserver +online version: https://learn.microsoft.com/powershell/module/exchange/remove-authserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-AuthServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-AuthServer cmdlet to remove an authorization server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-AuthServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md index 3a24e71c3f..7881265a05 100644 --- a/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AuthenticationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-authenticationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-authenticationpolicy applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-AuthenticationPolicy schema: 2.0.0 @@ -16,21 +16,21 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-AuthenticationPolicy cmdlet to remove authentication policies from your organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Remove-AuthenticationPolicy [-Identity] [-Confirm] + [-AllowLegacyExchangeTokens] + [-TenantId ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,6 +41,13 @@ Remove-AuthenticationPolicy -Identity "Engineering Group" This example removes the authentication policy named "Engineering Group". +### Example 2 +```powershell +Remove-AuthenticationPolicy -Identity "LegacyExchangeTokens" -AllowLegacyExchangeTokens +``` + +In Exchange Online, this example enables legacy Exchange tokens to be issued to Outlook add-ins. This switch applies to the entire organization. The Identity parameter is required, and its value must be set to "LegacyExchangeTokens". Specific authentication policies can't be applied. + ## PARAMETERS ### -Identity @@ -63,6 +70,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowLegacyExchangeTokens +This parameter is available only in the cloud-based service. + +The AllowLegacyExchangeTokens switch enables legacy Exchange tokens to be issued to Outlook add-ins for your organization. You don't need to specify a value with this switch. + +Legacy Exchange tokens include Exchange user identity and callback tokens. + +This switch applies to the entire organization. The Identity parameter is required, and its value must be set to "LegacyExchangeTokens". Specific authentication policies can't be applied. + +**Important**: + +- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes. +- It might take up to 24 hours for the change to take effect across your entire organization. +- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization will remain valid until they expire. +- As of February 17 2025, legacy Exchange tokens are blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: True +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. @@ -82,6 +118,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TenantId +This parameter is available only in the cloud-based service. + +{{ Fill TenantId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -103,12 +157,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md index 629ad7b69a..d6b2940550 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelpolicy +applicable: Security & Compliance title: Remove-AutoSensitivityLabelPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-AutoSensitivityLabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-AutoSensitivityLabelPolicy cmdlet to remove auto-labeling policies from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-AutoSensitivityLabelPolicy [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ The Identity parameter specifies the auto-labeling policy that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -71,7 +71,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +81,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md index a844a8d37b..f779597117 100644 --- a/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Remove-AutoSensitivityLabelRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-autosensitivitylabelrule +applicable: Security & Compliance title: Remove-AutoSensitivityLabelRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-AutoSensitivityLabelRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-AutoSensitivityLabelPolicy cmdlet to remove auto-labeling policy rules from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-AutoSensitivityLabelRule [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -71,7 +71,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +81,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md index 49eced377b..948dcc21f7 100644 --- a/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-AutodiscoverVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-autodiscovervirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/remove-autodiscovervirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-AutodiscoverVirtualDirectory schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Remove-AutodiscoverVirtualDirectory cmdlet to remove the an existing Autodiscover virtual directory from Internet Information Services (IIS). +Use the Remove-AutodiscoverVirtualDirectory cmdlet to remove an existing Autodiscover virtual directory from Internet Information Services (IIS). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-AutodiscoverVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md b/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md index 9e59b86187..97bf6ead5a 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md +++ b/exchange/exchange-ps/exchange/Remove-AvailabilityAddressSpace.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-availabilityaddressspace +online version: https://learn.microsoft.com/powershell/module/exchange/remove-availabilityaddressspace applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-AvailabilityAddressSpace schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-AvailabilityAddressSpace cmdlet to remove existing availability address space objects and the associated credentials that were used to share free/busy data across Exchange organizations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-AvailabilityAddressSpace [-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,7 +42,7 @@ This example removes the existing availability configuration. ## PARAMETERS ### -Identity -The Identity parameter specifies the availability configuration that you want to remove. The default name of the availability configuration you create by using the New-AvailabilityConfig is Availability Configuration. +The Identity parameter specifies the availability configuration that you want to remove. You don't need to use this parameter, because there's only one availability configuration object named Availability Configuration in any organization. ```yaml Type: AvailabilityConfigIdParameter @@ -99,12 +97,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md index f3097dbb89..8e66eefd7a 100644 --- a/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/exchange/Remove-AvailabilityReportOutage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-availabilityreportoutage +online version: https://learn.microsoft.com/powershell/module/exchange/remove-availabilityreportoutage applicable: Exchange Server 2010 title: Remove-AvailabilityReportOutage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-AvailabilityReportOutage cmdlet to remove existing outages that have been added with the New-AvailabilityReportOutage cmdlet. Other outages must be modified with the Set-AvailabilityReportOutage cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-AvailabilityReportOutage [-SiteName] -ReportDate ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,33 +44,33 @@ This example removes a manually injected site-scoped outage for a specified day. ## PARAMETERS -### -ReportDate -The ReportDate parameter specifies the date to query for the outage report. +### -SiteName +The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. ```yaml -Type: ExDateTime +Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: True Accept wildcard characters: False ``` -### -SiteName -The SiteName parameter specifies the name of the Active Directory site to associate the outage report with. +### -ReportDate +The ReportDate parameter specifies the date to query for the outage report. ```yaml -Type: String +Type: ExDateTime Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True Accept wildcard characters: False @@ -96,7 +96,9 @@ Accept wildcard characters: False ``` ### -Force -The Force parameter suppresses the warning or confirmation messages that appear during specific configuration changes. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -164,12 +166,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-BlockedConnector.md b/exchange/exchange-ps/exchange/Remove-BlockedConnector.md new file mode 100644 index 0000000000..6520e630b3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-BlockedConnector.md @@ -0,0 +1,82 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-blockedconnector +applicable: Exchange Online, Exchange Online Protection +title: Remove-BlockedConnector +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-BlockedConnector + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-BlockedConnector cmdlet to unblock inbound connectors that have been detected as potentially compromised. Blocked connectors are prevented from sending email. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-BlockedConnector -ConnectorId [-Reason ] [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-BlockedConnector -ConnectorId 159eb7c4-75d7-43e2-95fe-ced44b3e0a56 +``` + +This unblocks the specified blocked connector. + +## PARAMETERS + +### -ConnectorId +The ConnectorId parameter specifies the blocked connector that you want to unblock. The value is a GUID (for example, 159eb7c4-75d7-43e2-95fe-ced44b3e0a56). You can find this value from the output of the Get-BlockedConnector command. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Reason +The Reason parameter specifies comments about why you're unblocking the blocked connector. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md b/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md index 5d360dab08..ce007bf146 100644 --- a/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md +++ b/exchange/exchange-ps/exchange/Remove-BlockedSenderAddress.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-blockedsenderaddress +online version: https://learn.microsoft.com/powershell/module/exchange/remove-blockedsenderaddress applicable: Exchange Online, Exchange Online Protection title: Remove-BlockedSenderAddress schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Remove-BlockedSenderAddress cmdlet to unblock users in your Microsoft 36 **Note**: There's a limit to the number of times you can unblock a Microsoft 365 account. If you exceed the unblock limit for a user, you'll receive an error, and you'll need to contact support to unblock the user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-BlockedSenderAddress -SenderAddress ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,12 +79,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md index a9f708871c..c199b24fec 100644 --- a/exchange/exchange-ps/exchange/Remove-CalendarEvents.md +++ b/exchange/exchange-ps/exchange/Remove-CalendarEvents.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-calendarevents +online version: https://learn.microsoft.com/powershell/module/exchange/remove-calendarevents applicable: Exchange Server 2019, Exchange Online title: Remove-CalendarEvents schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-CalendarEvents cmdlet to cancel future meetings in user or resource mailboxes. Cancelling future meetings removes them from attendee and resource calendars (for example, you're going to remove the mailbox, or the user is going on a leave of absence). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,6 +26,7 @@ Remove-CalendarEvents [-Identity] -QueryWindowInDays ] + [-UseCustomRouting] [-WhatIf] [] ``` @@ -33,7 +34,7 @@ Remove-CalendarEvents [-Identity] -QueryWindowInDays ## DESCRIPTION You should also remove the case hold rule that corresponds to the removed policy by using the Remove-CaseHoldRule cmdlet. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -55,7 +55,7 @@ The Identity parameter specifies the case hold policy to remove. You can use any Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -74,7 +74,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -90,7 +90,7 @@ The ForceDeletion switch forces the removal of the policy. You don't need to spe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +100,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -120,12 +120,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md b/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md index fb5914ec75..cb7f9417bd 100644 --- a/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Remove-CaseHoldRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-caseholdrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-caseholdrule +applicable: Security & Compliance title: Remove-CaseHoldRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-CaseHoldRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-CaseHoldRule cmdlet to remove case hold rules from the Microsoft 365 compliance center. +Use the Remove-CaseHoldRule cmdlet to remove case hold rules from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-CaseHoldRule [-Identity] ## DESCRIPTION Removing a case hold rule causes the release of all Exchange mailbox and SharePoint site case holds that are associated with the rule. Removing a case hold rule also causes the corresponding case hold policy to become invalid, so you should remove it by using the Remove-CaseHoldPolicy cmdlet. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -55,7 +55,7 @@ The Identity parameter specifies the case hold rule to remove. You can use any v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -74,7 +74,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -90,7 +90,7 @@ The ForceDeletion switch forces the removal of the rule. You don't need to speci Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +100,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -120,12 +120,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md index 208f10589a..9e0c0ef4af 100644 --- a/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/Remove-ClassificationRuleCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-classificationrulecollection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-classificationrulecollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-ClassificationRuleCollection schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ClassificationRuleCollection to remove classification rule collections from your organization. -In Security & Compliance Center PowerShell, use the Remove-DlpSensitiveInformationTypeRulePackage cmdlet. +In Security & Compliance PowerShell, use the Remove-DlpSensitiveInformationTypeRulePackage cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-ClassificationRuleCollection [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md index 956c10cb8c..df3b17ddf9 100644 --- a/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-ClientAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-clientaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-ClientAccessRule schema: 2.0.0 @@ -12,11 +12,14 @@ ms.reviewer: # Remove-ClientAccessRule ## SYNOPSIS -This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Remove-ClientAccessRule cmdlet to remove client access rules. Client access rules help you control access to your cloud-based organization based on the properties of the connection. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +34,7 @@ Remove-ClientAccessRule [-Identity] ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md b/exchange/exchange-ps/exchange/Remove-ComplianceCase.md index 01601d7e54..a636d54a72 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceCase.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancecase -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancecase +applicable: Security & Compliance title: Remove-ComplianceCase schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceCase ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-ComplianceCase cmdlet to remove compliance cases from the Microsoft 365 compliance center or the Microsoft 365 compliance center. +Use the Remove-ComplianceCase cmdlet to remove compliance cases from the Microsoft Purview compliance portal or the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-ComplianceCase [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ The Identity parameter specifies the compliance case that you want to remove. Yo Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -71,7 +71,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -87,7 +87,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -97,13 +97,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -117,12 +117,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md index d521229077..2a22dd2318 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceCaseMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancecasemember -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancecasemember +applicable: Security & Compliance title: Remove-ComplianceCaseMember schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceCaseMember ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-ComplianceCaseMember cmdlet to remove a single member from an eDiscovery search in Security & Compliance Center. To replace all existing members, use the Update-ComplianceCaseMember cmdlet. +Use the Remove-ComplianceCaseMember cmdlet to remove a single member from an eDiscovery search in Security & Compliance. To replace all existing members, use the Update-ComplianceCaseMember cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-ComplianceCaseMember [-Case] -Member ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -50,7 +50,7 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -71,7 +71,7 @@ The Member parameter specifies the user that you want to remove from the eDiscov Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -90,7 +90,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +100,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -120,12 +120,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md index 46e5191bc7..fdca44b480 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceRetentionEventType.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Remove-ComplianceRetentionEventType -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-complianceretentioneventtype +applicable: Security & Compliance title: Remove-ComplianceRetentionEventType schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceRetentionEventType ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-ComplianceRetentionEventType cmdlet to remove retention event types in the Microsoft 365 compliance center. +Use the Remove-ComplianceRetentionEventType cmdlet to remove retention event types in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,13 +24,12 @@ For information about the parameter sets in the Syntax section below, see [Excha Remove-ComplianceRetentionEventType -Identity [-Confirm] [-ForceDeletion] - [-PreviewOnly] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,7 +53,7 @@ The Identity parameter specifies the retention event type that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -73,7 +72,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -89,23 +88,7 @@ The ForceDeletion switch forces the removal of the retention event type. You don Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewOnly -{{ Fill PreviewOnly Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,13 +98,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -135,12 +118,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md b/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md index fd5862fd2a..92fdcfc7a7 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesearch +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Remove-ComplianceSearch schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Remove-ComplianceSearch cmdlet to remove compliance searches from Exchange Server 2016 and from the Microsoft 365 compliance center. The searches must be stopped or completed. +Use the Remove-ComplianceSearch cmdlet to remove compliance searches from Exchange Server 2016 and from the Microsoft Purview compliance portal. The searches must be stopped or completed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,11 +28,11 @@ Remove-ComplianceSearch [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -59,7 +59,7 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -78,7 +78,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -88,7 +88,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -96,7 +96,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -110,12 +110,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md index e39b78add3..8140168e36 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSearchAction.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancesearchaction -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesearchaction +applicable: Security & Compliance title: Remove-ComplianceSearchAction schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceSearchAction ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-ComplianceSearch cmdlet to remove compliance search actions from the Microsoft 365 compliance center. +Use the Remove-ComplianceSearch cmdlet to remove compliance search actions from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-ComplianceSearchAction [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -51,7 +51,7 @@ The Identity parameter specifies the compliance search action that you want to r Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -70,7 +70,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +80,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,12 +100,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md index 846c5c68a0..8b38b2ba8a 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceSecurityFilter.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancesecurityfilter -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancesecurityfilter +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Remove-ComplianceSecurityFilter schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceSecurityFilter ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-ComplianceSecurityFilter cmdlet to remove compliance security filters from the Microsoft 365 compliance center. +Use the Remove-ComplianceSecurityFilter cmdlet to remove compliance security filters from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-ComplianceSecurityFilter -FilterName ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -48,7 +48,7 @@ The FilterName parameter specifies the name of the compliance security filter th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -67,7 +67,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -77,13 +77,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -97,12 +97,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md index 19c4ae051e..46c293ddf7 100644 --- a/exchange/exchange-ps/exchange/Remove-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Remove-ComplianceTag.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-compliancetag -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-compliancetag +applicable: Security & Compliance title: Remove-ComplianceTag schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ComplianceTag ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-ComplianceTag cmdlet to remove retention labels from the Microsoft 365 compliance center. Retention labels apply retention settings to content. +Use the Remove-ComplianceTag cmdlet to remove retention labels from the Microsoft Purview compliance portal. Retention labels apply retention settings to content. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,12 +24,13 @@ For information about the parameter sets in the Syntax section below, see [Excha Remove-ComplianceTag [-Identity] [-Confirm] [-ForceDeletion] + [-PriorityCleanup] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -53,7 +54,7 @@ The Identity parameter specifies the label that you want to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -72,7 +73,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -88,7 +89,23 @@ The ForceDeletion switch forces the removal of the label. You don't need to spec Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -104,7 +121,7 @@ The WhatIf switch causes the command to simulate its results. By using this swit Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -118,12 +135,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md b/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md index ae002a0b3b..88836574db 100644 --- a/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md +++ b/exchange/exchange-ps/exchange/Remove-ContentFilterPhrase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-contentfilterphrase +online version: https://learn.microsoft.com/powershell/module/exchange/remove-contentfilterphrase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-ContentFilterPhrase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ContentFilterPhrase cmdlet to remove one or all custom words that the Content Filter agent processes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Remove-ContentFilterPhrase [-Phrase ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -146,12 +146,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-DataClassification.md b/exchange/exchange-ps/exchange/Remove-DataClassification.md index a30245842a..c89fd96ca0 100644 --- a/exchange/exchange-ps/exchange/Remove-DataClassification.md +++ b/exchange/exchange-ps/exchange/Remove-DataClassification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dataclassification +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dataclassification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-DataClassification schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Remove-DataClassification ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Remove-DlpSensitiveInformationType](https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype) cmdlet in Security & Compliance Center PowerShell. +In Exchange Online, this cmdlet has been replaced by the [Remove-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Remove-DataClassification cmdlet to remove data classification rules that use document fingerprints. You can't use this cmdlet to remove built-in data classification rules. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Remove-DataClassification [-Identity] ## DESCRIPTION Classification rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md index 561cf44964..2311d1505f 100644 --- a/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Remove-DatabaseAvailabilityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroup +online version: https://learn.microsoft.com/powershell/module/exchange/remove-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-DatabaseAvailabilityGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-DatabaseAvailabilityGroup cmdlet to delete an empty database availability group (DAG). Before you can delete a DAG, you must first remove all Mailbox servers from the DAG. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-DatabaseAvailabilityGroup [-Identity] ``` ## DESCRIPTION -Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://docs.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). +Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://learn.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md index d0e852175d..12423d67fd 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccesspolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccesspolicy +applicable: Security & Compliance title: Remove-DeviceConditionalAccessPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DeviceConditionalAccessPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-DeviceConditionalAccessPolicy cmdlet to remove mobile device conditional access policies from Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,9 +35,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,7 +61,7 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -80,7 +80,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -90,13 +90,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -110,12 +110,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md index c275723978..08e72f3b32 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConditionalAccessRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccessrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconditionalaccessrule +applicable: Security & Compliance title: Remove-DeviceConditionalAccessRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DeviceConditionalAccessRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-DeviceConditionalAccessRule cmdlet to remove mobile device conditional access rules from Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,9 +35,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The Identity parameter specifies the mobile device conditional access rule that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +86,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -106,12 +106,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md index 355dd90c75..913547d5a2 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-deviceconfigurationpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconfigurationpolicy +applicable: Security & Compliance title: Remove-DeviceConfigurationPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DeviceConfigurationPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-DeviceConfigurationPolicy cmdlet to remove mobile device configuration policies from Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,9 +35,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,7 +61,7 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -80,7 +80,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -90,13 +90,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -110,12 +110,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md index 959ec546e0..d3ab49229c 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceConfigurationRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-deviceconfigurationrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-deviceconfigurationrule +applicable: Security & Compliance title: Remove-DeviceConfigurationRule schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-DeviceConfigurationRule cmdlet to remove mobile device configuration rules from Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,9 +35,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The Identity parameter specifies the mobile device configuration rule that you w Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +86,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -106,12 +106,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md index 8290022363..919b43271d 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceTenantPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-devicetenantpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-devicetenantpolicy +applicable: Security & Compliance title: Remove-DeviceTenantPolicy schema: 2.0.0 author: chrisda @@ -12,17 +12,17 @@ ms.reviewer: # Remove-DeviceTenantPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-DeviceTenantPolicy cmdlet to remove your organization's mobile device tenant policy from Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Remove-DeviceTenantPolicy [-Confirm] - [-Identity ] +Remove-DeviceTenantPolicy [-Identity ] + [-Confirm] [-WhatIf] [] ``` @@ -35,9 +35,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 @@ -49,17 +49,14 @@ This example removes your organization's mobile device tenant policy. ## PARAMETERS -### -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`. -- 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. +### -Identity +The Identity parameter specifies the name of the mobile device tenant policy that you want to remove, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. You can find this value by running the command: `Get-DeviceTenantPolicy | Format-List Name`. ```yaml -Type: SwitchParameter +Type: PolicyIdParameter Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -68,14 +65,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the mobile device tenant policy that you want to remove, but there's only one in your organization. The name of the policy is a GUID value. For example, a6958701-c82c-4064-ac11-64e40e7f4032. You can find this value by running the command: Get-DeviceTenantPolicy | Format-List Name. +### -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`. +- 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. ```yaml -Type: PolicyIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center +Aliases: cf +Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +85,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -105,12 +105,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md index 58db1e2f92..0fe5232d12 100644 --- a/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Remove-DeviceTenantRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-devicetenantrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-devicetenantrule +applicable: Security & Compliance title: Remove-DeviceTenantRule schema: 2.0.0 author: chrisda @@ -12,17 +12,17 @@ ms.reviewer: # Remove-DeviceTenantRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-DeviceTenantRule cmdlet to remove your organization's mobile device tenant rule from Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Remove-DeviceTenantRule [-Confirm] - [-Identity ] +Remove-DeviceTenantRule [-Identity ] + [-Confirm] [-WhatIf] [] ``` @@ -35,9 +35,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -50,17 +50,14 @@ This example removes the mobile device tenant rule from your organization. ## PARAMETERS -### -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`. -- 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. +### -Identity +The Identity parameter specifies the name of the mobile device tenant rule that you want to remove, but there's only one in your organization. The name of the rule is a GUID. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. You can find the name value by running the command `Get-DeviceTenantRule | Format-List Name`. ```yaml -Type: SwitchParameter +Type: PolicyIdParameter Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -69,14 +66,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the name of the mobile device tenant rule that you want to remove, but there's only one in your organization. The name of the rule is a GUID. For example, 7577c5f3-05a4-4f55-a0a3-82aab5e98c84. You can find the name value by running the command Get-DeviceTenantRule | Format-List Name. +### -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`. +- 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. ```yaml -Type: PolicyIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center +Aliases: cf +Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +86,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -106,12 +106,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroup.md b/exchange/exchange-ps/exchange/Remove-DistributionGroup.md index bf39b0c87c..b35ddb9a2a 100644 --- a/exchange/exchange-ps/exchange/Remove-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Remove-DistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-distributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/remove-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-DistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-DistributionGroup cmdlet to remove distribution groups and mail-enabled security groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-DistributionGroup [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,13 +68,13 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -128,9 +128,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -169,12 +169,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md index 97214b1b9d..0f323c30da 100644 --- a/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Remove-DistributionGroupMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-distributiongroupmember +online version: https://learn.microsoft.com/powershell/module/exchange/remove-distributiongroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-DistributionGroupMember schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-DistributionGroupMember cmdlet to remove a single member from distribution groups or mail-enabled security groups. To replace all members, use the Update-DistributionGroupMember cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Remove-DistributionGroupMember [-Identity] ## DESCRIPTION You can't use the Remove-DistributionGroupMember cmdlet to remove the member of a dynamic distribution group. A dynamic distribution group's membership is calculated from query results. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,13 +70,13 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -171,12 +171,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md index 84417a38d6..86f93677d8 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DlpCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpcompliancepolicy +applicable: Security & Compliance title: Remove-DlpCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-DlpCompliancePolicy cmdlet to remove Data Loss Prevention (DLP) policies from the Microsoft 365 compliance center. +Use the Remove-DlpCompliancePolicy cmdlet to remove data loss prevention (DLP) policies from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-DlpCompliancePolicy [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -60,7 +60,7 @@ The Identity parameter specifies the DLP policy that you want to remove. You can Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -79,7 +79,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -89,13 +89,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -109,12 +109,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md index 43aff25767..cbbfa8b856 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-DlpComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpcompliancerule +applicable: Security & Compliance title: Remove-DlpComplianceRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-DlpComplianceRule cmdlet to remove Data Loss Prevention (DLP) rules from the Microsoft 365 compliance center. +Use the Remove-DlpComplianceRule cmdlet to remove Data Loss Prevention (DLP) rules from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-DlpComplianceRule [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -53,7 +53,7 @@ The Identity parameter specifies the DLP rule that you want to remove. You can u Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -72,7 +72,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +82,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -102,12 +102,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md index 567ecade1d..f32281feb1 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Remove-DlpEdmSchema.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Remove-DlpEdmSchema -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpedmschema +applicable: Security & Compliance title: Remove-DlpEdmSchema schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpEdmSchema ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-DlpEdmSchema cmdlet to remove exact data match (EDM) data loss prevention (DLP) schemas from the Microsoft 365 compliance center. +Use the Remove-DlpEdmSchema cmdlet to remove exact data match (EDM) data loss prevention (DLP) schemas from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-DlpEdmSchema [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -51,7 +51,7 @@ The Identity parameter specifies the DLP EDM schema that you want to remove. You Type: EdmStorageIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -70,7 +70,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -80,13 +80,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,14 +100,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Create custom sensitive information types with Exact Data Match based classification](https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification) +[Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits) diff --git a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md index d3f0e873e4..9497d5484f 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Remove-DlpKeywordDictionary.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpkeyworddictionary -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpkeyworddictionary +applicable: Security & Compliance title: Remove-DlpKeywordDictionary schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpKeywordDictionary ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-DlpKeywordDictionary cmdlet to remove data loss prevention (DLP) keyword dictionaries from the Microsoft 365 compliance center. +Use the Remove-DlpKeywordDictionary cmdlet to remove data loss prevention (DLP) keyword dictionaries from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-DlpKeywordDictionary [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -55,7 +55,7 @@ The Identity parameter specifies the name of the DLP keyword dictionary that you Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -74,7 +74,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +84,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -104,12 +104,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md b/exchange/exchange-ps/exchange/Remove-DlpPolicy.md index d75ea75721..e7591b41e1 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-DlpPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlppolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlppolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-DlpPolicy schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Remove-DlpPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: This cmdlet has been retired from the cloud-based service. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/exchange-online-etrs-to-stop-supporting-dlp-policies/ba-p/3886713). Use the Remove-DlpCompliancePolicy and Remove-DlpComplianceRule cmdlets instead. -Use the Remove-DlpPolicy cmdlet to remove an existing data loss prevention (DLP) policy. +This cmdlet is functional only in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the Remove-DlpPolicy cmdlet to remove existing data loss prevention (DLP) policies that are based on transport rules (mail flow rules) from your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +31,7 @@ Remove-DlpPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -43,7 +45,11 @@ This example removes the existing DLP policy named Contoso PII. ## PARAMETERS ### -Identity -The Identity parameter specifies the DLP policy you want to remove. You can use any value that uniquely identifies the DLP policy. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy. +The Identity parameter specifies the DLP policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: DlpPolicyIdParameter @@ -78,8 +84,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -116,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md b/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md index 9b059e9dae..6ec3166bac 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md +++ b/exchange/exchange-ps/exchange/Remove-DlpPolicyTemplate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlppolicytemplate +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlppolicytemplate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-DlpPolicyTemplate schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Remove-DlpPolicyTemplate cmdlet to remove a data loss prevention (DLP) policy template from your organization. +Use the Remove-DlpPolicyTemplate cmdlet to remove data loss prevention (DLP) policy templates that are based on transport rules (mail flow rules) from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-DlpPolicyTemplate [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,12 +114,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md index b5f8bdecf3..248e930c45 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationType.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtype +applicable: Security & Compliance title: Remove-DlpSensitiveInformationType schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpSensitiveInformationType ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-DlpSensitiveInformationType cmdlet to remove sensitive information type rules that use document fingerprints. You can't use this cmdlet to remove built-in sensitive information type rules. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Remove-DlpSensitiveInformationType [-Identity] ## DESCRIPTION Sensitive information type rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -**Note**: A "ManagementObjectNotFoundException" error means there was a synchronization problem between the Microsoft 365 compliance center and Exchange Online. This happens when you try to remove data classifications that are being used in mail flow rules (also known as transport rules). You can remove the mail flow rule, wait for synchronization to finish, and then add the rule back. +**Note**: A "ManagementObjectNotFoundException" error means there was a synchronization problem between the Microsoft Purview compliance portal and Exchange Online. This happens when you try to remove data classifications that are being used in mail flow rules (also known as transport rules). You can remove the mail flow rule, wait for synchronization to finish, and then add the rule back. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -56,7 +56,7 @@ The Identity parameter specifies the sensitive information type rule that you wa Type: DataClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -75,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,13 +85,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -105,12 +105,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md index ad279c260d..dcf39f5bd5 100644 --- a/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md +++ b/exchange/exchange-ps/exchange/Remove-DlpSensitiveInformationTypeRulePackage.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-dlpsensitiveinformationtyperulepackage +applicable: Security & Compliance title: Remove-DlpSensitiveInformationTypeRulePackage schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-DlpSensitiveInformationTypeRulePackage ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-DlpSensitiveInformationTypeConfig cmdlet to remove data loss prevention (DLP) sensitive information type rule packages from the Microsoft 365 compliance center. +Use the Remove-DlpSensitiveInformationTypeConfig cmdlet to remove data loss prevention (DLP) sensitive information type rule packages from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,13 +30,14 @@ Remove-DlpSensitiveInformationTypeRulePackage [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -106,9 +106,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -147,12 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md deleted file mode 100644 index 71fbbc7c11..0000000000 --- a/exchange/exchange-ps/exchange/Remove-EOPDistributionGroup.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-eopdistributiongroup -applicable: Exchange Online Protection -title: Remove-EOPDistributionGroup -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Remove-EOPDistributionGroup cmdlet to delete distribution groups or mail-enabled security groups from standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Remove-DistributionGroup cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-EOPDistributionGroup [-ExternalDirectoryObjectId ] - [-Identity ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-EOPDistributionGroup -Identity "Security Team" -``` - -This example removes the existing Exchange Online Protection distribution group named Security Team. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to remove. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-EOPMailUser.md b/exchange/exchange-ps/exchange/Remove-EOPMailUser.md deleted file mode 100644 index 306bcf3fef..0000000000 --- a/exchange/exchange-ps/exchange/Remove-EOPMailUser.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-eopmailuser -applicable: Exchange Online Protection -title: Remove-EOPMailUser -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Remove-EOPMailUser cmdlet to remove mail users, also known as mail-enabled users, from standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Remove-MailUser cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-EOPMailUser [-ExternalDirectoryObjectId ] - [-Identity ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Remove-EOPMailUser -Identity "Ed Meadows" -``` - -This example removes the mail-enabled user named Ed Meadows. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the mail user that you want to delete. You can use any value that uniquely identifies the mail user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -```yaml -Type: MailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..ba11d899b1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-EOPProtectionPolicyRule.md @@ -0,0 +1,114 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: Remove-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-EOPProtectionPolicyRule cmdlet to remove rules from Exchange Online Protection (EOP) protections in preset security policies. The rules specify recipient conditions and exceptions for the protection, and also allow you to turn on and turn off the associated preset security policies. + +**Note**: Use this cmdlet to remove a rule only if you plan to immediately recreate the rule using the New-EOPProtectionPolicyRule cmdlet. The affected preset security policy won't function without a corresponding rule. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-EOPProtectionPolicyRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" +``` + +This example removes the existing rule for EOP protections in the Standard preset security policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md index fb9604e853..07f4762142 100644 --- a/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-EcpVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-ecpvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/remove-ecpvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-EcpVirtualDirectory schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Remove-EcpVirtualDirectory cmdlet to remove Exchange Control Panel (ECP) The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013 and Exchange 2016 servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-EcpVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,12 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md b/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md index 1117e1ce39..e792a7e0b9 100644 --- a/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md +++ b/exchange/exchange-ps/exchange/Remove-EdgeSubscription.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-edgesubscription +online version: https://learn.microsoft.com/powershell/module/exchange/remove-edgesubscription applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-EdgeSubscription schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-EdgeSubscription cmdlet to remove Edge Subscription from the Exchange organization and from the subscribed Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ When you remove an Edge Subscription, the following changes are made: - The Edge Transport server is removed from the list of source servers for any Send connector. - If the Edge Transport server is the only source server for any Send connector, the Send connector is removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -104,9 +104,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -If you don't specify the Force switch, the command will inform you that the removal of the replicated recipient data from AD LDS can take a long time and will give you the option to cancel the operation. +If you don't use this switch, the command will inform you that the removal of the replicated recipient data from AD LDS can take a long time and will give you the option to cancel the operation. ```yaml Type: SwitchParameter @@ -142,12 +142,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md index ed0996c047..8389a40fd5 100644 --- a/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-EmailAddressPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-emailaddresspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-EmailAddressPolicy schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Remove-EmailAddressPolicy cmdlet to remove existing email address policies and update the affected recipients. In Exchange Online, email address policies are only available for Microsoft 365 Groups. +Use the Remove-EmailAddressPolicy cmdlet to remove existing email address policies and update the affected recipients. In Exchange Online, email address policies are available only for Microsoft 365 Groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-EmailAddressPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md b/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md index f058034b55..e6a35f7f1c 100644 --- a/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md +++ b/exchange/exchange-ps/exchange/Remove-ExchangeCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-exchangecertificate +online version: https://learn.microsoft.com/powershell/module/exchange/remove-exchangecertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-ExchangeCertificate schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ExchangeCertificate cmdlet to remove existing Exchange certificates or pending certificate requests (also known as certificate signing requests or CSRs) from Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,11 +42,11 @@ Remove-ExchangeCertificate [[-Identity] ] ## DESCRIPTION You can't remove the certificate that's being used. If you want to replace the default certificate for the server with another certificate that has the same fully qualified domain name (FQDN), you must create the new certificate first, and then remove the old certificate. -There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://docs.microsoft.com/Exchange/architecture/client-access/certificates). +There are many factors to consider when you configure certificates for Transport Layer Security (TLS) and Secure Sockets Layer (SSL) services. You need to understand how these factors might affect your overall configuration. For more information, see [Digital certificates and encryption in Exchange Server](https://learn.microsoft.com/Exchange/architecture/client-access/certificates). -Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). To find out why you should disable the SSL protocol and switch to TLS, check out [Protecting you against the SSL 3.0 vulnerability](https://blogs.office.com/2014/10/29/protecting-ssl-3-0-vulnerability/). +Secure Sockets Layer (SSL) is being replaced by Transport Layer Security (TLS) as the protocol that's used to encrypt data sent between computer systems. They're so closely related that the terms "SSL" and "TLS" (without versions) are often used interchangeably. Because of this similarity, references to "SSL" in Exchange topics, the Exchange admin center and the Exchange Management Shell have often been used to encompass both the SSL and TLS protocols. Typically, "SSL" refers to the actual SSL protocol only when a version is also provided (for example, SSL 3.0). For more information, see [Exchange Server TLS configuration best practices](https://learn.microsoft.com/Exchange/exchange-tls-configuration). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -192,12 +192,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md new file mode 100644 index 0000000000..57130dbbe8 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ExoPhishSimOverrideRule.md @@ -0,0 +1,135 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-exophishsimoverriderule +applicable: Exchange Online +title: Remove-ExoPhishSimOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ExoPhishSimOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ExoPhishSimOverrideRule cmdlet to remove third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ExoPhishSimOverrideRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoPhishSimOverrideRule | Remove-ExoPhishSimOverrideRule +``` + +This example removes any phishing simulation override rules. + +### Example 2 +```powershell +Remove-ExoPhishSimOverrideRule -Identity "_Exe:PhishSimOverr:6fed4b63-3563-495d-a481-b24a311f8329" +``` + +This example removes the specified phishing simulation override rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the phishing simulation override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-ExoPhishSimOverrideRule cmdlet to find the values. The rule name syntax is `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md new file mode 100644 index 0000000000..b127bd5c6f --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ExoSecOpsOverrideRule.md @@ -0,0 +1,132 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-exosecopsoverriderule +applicable: Exchange Online +title: Remove-ExoSecOpsOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ExoSecOpsOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ExoSecOpsOverrideRule cmdlet to remove SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ExoSecOpsOverrideRule [-Identity] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoSecOpsOverrideRule| Remove-ExoSecOpsOverrideRule +``` + +This example removes any SecOps mailbox override rules. + +### Example 2 +```powershell +Remove-ExoSecOpsOverrideRule -Identity "_Exe:SecOpsOverrid:312c23cf-0377-4162-b93d-6548a9977efb" +``` + +This example removes the specified SecOps mailbox override rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the SecOps override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-ExoSecOpsMailboxRule cmdlet to find these values. The name of the rule uses the following syntax: `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md b/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md new file mode 100644 index 0000000000..d6b0f82b35 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-FeatureConfiguration.md @@ -0,0 +1,111 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-featureconfiguration +applicable: Security & Compliance +title: Remove-FeatureConfiguration +schema: 2.0.0 +--- + +# Remove-FeatureConfiguration + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. + +Use the Remove-FeatureConfiguration cmdlet to remove Microsoft Purview feature configurations within your organization, including: + +- Collection policies. +- Advanced label based protection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-FeatureConfiguration [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Remove-FeatureConfiguration -Identity "Engineering Group" +``` + +This example removes the specified feature configuration. + +## PARAMETERS + +### -Identity +The Identity policy specifies the feature configuration that you want to remove. You can use any value that uniquely identifies the configuration. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FederatedDomain.md b/exchange/exchange-ps/exchange/Remove-FederatedDomain.md index 88d1d80946..c0cbc63696 100644 --- a/exchange/exchange-ps/exchange/Remove-FederatedDomain.md +++ b/exchange/exchange-ps/exchange/Remove-FederatedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-federateddomain +online version: https://learn.microsoft.com/powershell/module/exchange/remove-federateddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-FederatedDomain schema: 2.0.0 @@ -18,9 +18,9 @@ Use the Remove-FederatedDomain cmdlet to remove a federated domain from the fede If you remove a domain configured for federated sharing, federated sharing for that domain is disabled. -For more information, see [Federation](https://docs.microsoft.com/exchange/federation-exchange-2013-help). +For more information, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Remove-FederatedDomain [[-Identity] ] -DomainName ## DESCRIPTION Federation trusts are set up with Microsoft Federation Gateway to enable calendar sharing and free/busy sharing with external Exchange organizations or individuals. The Remove-FederationTrust cmdlet removes a federation trust. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md index aebe23f105..6de6ae8679 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyAuthority.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertyauthority -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertyauthority +applicable: Security & Compliance title: Remove-FilePlanPropertyAuthority schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Remove-FilePlanPropertyAuthority ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-FilePlanPropertyAuthority cmdlet to remove file plan property authorities. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Remove-FilePlanPropertyAuthority [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -50,7 +50,7 @@ The Identity parameter specifies the custom file plan property authority that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -69,7 +69,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ The ForceDeletion switch forces the removal of the file plan property authority. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +95,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md index 3537eb32c3..e5e7d1c7fa 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertycategory -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertycategory +applicable: Security & Compliance title: Remove-FilePlanPropertyCategory schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Remove-FilePlanPropertyCategory ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-FilePlanPropertyCategory cmdlet to remove file plan property categories. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Remove-FilePlanPropertyCategory [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -50,7 +50,7 @@ The Identity parameter specifies the custom file plan property category that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -69,7 +69,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ The ForceDeletion switch forces the removal of the file plan property category. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +95,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md index 151a8caa43..70c1f29a20 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyCitation.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertycitation -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertycitation +applicable: Security & Compliance title: Remove-FilePlanPropertyCitation schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Remove-FilePlanPropertyCitation ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-FilePlanPropertyCitation cmdlet to remove file plan property citations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Remove-FilePlanPropertyCitation [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -50,7 +50,7 @@ The Identity parameter specifies the custom file plan property citation that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -69,7 +69,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ The ForceDeletion switch forces the removal of the file plan property citation. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +95,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md index 3d57e59203..630bbe64a4 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyDepartment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertydepartment -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertydepartment +applicable: Security & Compliance title: Remove-FilePlanPropertyDepartment schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Remove-FilePlanPropertyDepartment ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Removet-FilePlanPropertyDepartment cmdlet to remove file plan property departments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Remove-FilePlanPropertyDepartment [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -50,7 +50,7 @@ The Identity parameter specifies the custom file plan property department that y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -69,7 +69,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ The ForceDeletion switch forces the removal of the file plan property department Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +95,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md index 4fdcc3b57f..7548cc4cf3 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertyReferenceId.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertyreferenceid -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertyreferenceid +applicable: Security & Compliance title: Remove-FilePlanPropertyReferenceId schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Remove-FilePlanPropertyReferenceId ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the New-FilePlanPropertyReferenceId cmdlet to remove file plan property reference IDs. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Remove-FilePlanPropertyReferenceId [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -50,7 +50,7 @@ The Identity parameter specifies the custom file plan property reference ID that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -69,7 +69,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ The ForceDeletion switch forces the removal of the file plan property reference Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +95,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md index 7752e80c2d..5e45a1faf5 100644 --- a/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/Remove-FilePlanPropertySubCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-fileplanpropertysubcategory -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-fileplanpropertysubcategory +applicable: Security & Compliance title: Remove-FilePlanPropertySubCategory schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Remove-FilePlanPropertySubCategory ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-FilePlanPropertySubCategory cmdlet to remove file plan property subcategories. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Remove-FilePlanPropertySubCategory [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -50,7 +50,7 @@ The Identity parameter specifies the custom file plan property subcategory that Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -69,7 +69,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ The ForceDeletion switch forces the removal of the file plan property subcategor Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +95,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ForeignConnector.md b/exchange/exchange-ps/exchange/Remove-ForeignConnector.md index f0695b91c8..d43ea4b717 100644 --- a/exchange/exchange-ps/exchange/Remove-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/Remove-ForeignConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-foreignconnector +online version: https://learn.microsoft.com/powershell/module/exchange/remove-foreignconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-ForeignConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ForeignConnector cmdlet to delete a Foreign connector in the Transport service of a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Remove-ForeignConnector cmdlet deletes the object and the configuration info Although a Foreign connector is configured on a local Mailbox server, if you delete a Foreign connector, you may affect mail flow throughout the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md b/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md index 9656353996..2307a60bef 100644 --- a/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/Remove-GlobalAddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-globaladdresslist +online version: https://learn.microsoft.com/powershell/module/exchange/remove-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-GlobalAddressList schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-GlobalAddressList cmdlet to remove an existing global address list (GAL). -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-GlobalAddressList [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md b/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md index 7367c573b7..6bdf488dfa 100644 --- a/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Remove-GlobalMonitoringOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-globalmonitoringoverride +online version: https://learn.microsoft.com/powershell/module/exchange/remove-globalmonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-GlobalMonitoringOverride schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-GlobalMonitoringOverride cmdlet to remove a managed availability global override that has been configured for a probe, monitor or responder. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-GlobalMonitoringOverride [-Identity] -ItemType ## DESCRIPTION You should also remove the preservation rule that corresponds to the removed policy by using the Remove-HoldComplianceRule cmdlet. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The Identity parameter specifies the preservation policy to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -92,7 +92,7 @@ The ForceDeletion switch forces the removal of the policy. You don't need to spe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +102,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -122,12 +122,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md index cdf3a57f54..5b0fea9c47 100644 --- a/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-HoldComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-holdcompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-holdcompliancerule +applicable: Security & Compliance title: Remove-HoldComplianceRule schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Remove-HoldComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-HoldComplianceRule cmdlet to remove preservation rules from the Microsoft 365 compliance center. +Use the Remove-HoldComplianceRule cmdlet to remove preservation rules from the Microsoft Purview compliance portal. **Note**: The Remove-HoldComplianceRule cmdlet has been replaced by the Remove-RetentionComplianceRule cmdlet. If you have scripts that use Remove-HoldComplianceRule, update them to use Remove-RetentionComplianceRule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Remove-HoldComplianceRule [-Identity] ## DESCRIPTION Removing a preservation rule causes the release of all Exchange mailbox and SharePoint site preservations that are associated with the rule. Removing a preservation rule also causes the corresponding preservation policy to become invalid, so you should remove it by using the Remove-HoldCompliancePolicy cmdlet. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The Identity parameter specifies the preservation rule to remove. You can use an Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -92,7 +92,7 @@ The ForceDeletion switch forces the removal of the rule. You don't need to speci Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +102,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -122,12 +122,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md b/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md index 9f9af66413..b94bb23bff 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-HostedContentFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedcontentfilterpolicy applicable: Exchange Online, Exchange Online Protection title: Remove-HostedContentFilterPolicy schema: 2.0.0 @@ -18,9 +18,7 @@ Use the Remove-HostedContentFilterPolicy cmdlet to remove spam filter policies ( When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-HostedContentFilterRule cmdlet. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Remove-HostedContentFilterPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,12 +101,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md index efbc55e773..20e3e3eb7f 100644 --- a/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-HostedOutboundSpamFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection title: Remove-HostedOutboundSpamFilterPolicy schema: 2.0.0 @@ -18,9 +18,7 @@ Use the Remove-HostedOutboundSpamFilterPolicy cmdlet to remove outbound spam fil When a policy is removed and there are rules associated with it, the rules are not removed when the policy is removed. This is by design. If you want to remove the associated rules, you need to do this separately via the Remove-HostedOutboundSpamFilterRule cmdlet. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +29,7 @@ Remove-HostedOutboundSpamFilterPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md b/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md index 8236a41f97..ed6b8d990c 100644 --- a/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Remove-HybridConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-hybridconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/remove-hybridconfiguration applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-HybridConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-HybridConfiguration cmdlet to delete the HybridConfigurationActive Directory object for your on-premises Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Remove-HybridConfiguration [-Confirm] ## DESCRIPTION Removing a HybridConfiguration object should typically only be performed in circumstances where the hybrid deployment state is corrupt and under the direction of Microsoft Customer Service and Support. After removing the HybridConfiguration object, your existing hybrid deployment configuration settings aren't disabled or removed. However, when the Hybrid Configuration wizard is run again after removing the HybridConfiguration object, the wizard won't have a hybrid configuration reference point for your existing feature settings. As a result, it will automatically create a HybridConfiguration object and record the new hybrid deployment configuration feature values defined in the wizard. The feature settings associated with the hybrid deployment, such as organization relationship or Send and Receive connector parameters, which were configured with the HybridConfiguration object that's removed, aren't removed or modified until the Hybrid Configuration wizard is run again. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -101,12 +101,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md b/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md index cbfb44d858..07022d05d8 100644 --- a/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md +++ b/exchange/exchange-ps/exchange/Remove-IPAllowListEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-ipallowlistentry +online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipallowlistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-IPAllowListEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-IPAllowListEntry cmdlet to remove IP address entries from the IP Allow list that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -130,12 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md index f6558b74e4..530652a8e2 100644 --- a/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Remove-IPAllowListProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-ipallowlistprovider +online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-IPAllowListProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-IPAllowListProvider cmdlet to remove IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md b/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md index 87cc334b95..81f9179a23 100644 --- a/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md +++ b/exchange/exchange-ps/exchange/Remove-IPBlockListEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-ipblocklistentry +online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipblocklistentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-IPBlockListEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-IPBlockListEntry cmdlet to remove IP block list entries that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -130,12 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md index 47fdbce763..27e5a41a87 100644 --- a/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Remove-IPBlockListProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-ipblocklistprovider +online version: https://learn.microsoft.com/powershell/module/exchange/remove-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-IPBlockListProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Remove-IPBlockListProvider cmdlet to remove IP Block list providers that are used by the Connection Filtering agent on Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-InboundConnector.md b/exchange/exchange-ps/exchange/Remove-InboundConnector.md index 53b0773979..643afa3df0 100644 --- a/exchange/exchange-ps/exchange/Remove-InboundConnector.md +++ b/exchange/exchange-ps/exchange/Remove-InboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-inboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/remove-inboundconnector applicable: Exchange Online, Exchange Online Protection title: Remove-InboundConnector schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-InboundConnector cmdlet to delete an Inbound connector from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Remove-InboundConnector [-Identity] ## DESCRIPTION Inbound connectors accept email messages from remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -101,12 +99,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-InboxRule.md b/exchange/exchange-ps/exchange/Remove-InboxRule.md index 8cba270494..78a9af6e7b 100644 --- a/exchange/exchange-ps/exchange/Remove-InboxRule.md +++ b/exchange/exchange-ps/exchange/Remove-InboxRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-inboxrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-InboxRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-InboxRule cmdlet to remove an Inbox rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Remove-InboxRule [-Identity] ## DESCRIPTION When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -76,7 +76,7 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. +The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -129,7 +129,7 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -194,12 +194,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md index a70fc373e6..daac4a22b1 100644 --- a/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-InformationBarrierPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-informationbarrierpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-informationbarrierpolicy +applicable: Security & Compliance title: Remove-InformationBarrierPolicy schema: 2.0.0 author: chrisda @@ -12,25 +12,26 @@ ms.reviewer: # Remove-InformationBarrierPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-InformationBarrierPolicy cmdlet to remove information barrier policies from the Microsoft 365 compliance center. +Use the Remove-InformationBarrierPolicy cmdlet to remove information barrier policies from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Remove-InformationBarrierPolicy [-Identity] [-Confirm] + [-ForceDeletion] [-WhatIf] [] ``` ## DESCRIPTION -For more information, see [Information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies). +For more information, see [Information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -54,7 +55,7 @@ The Identity parameter specifies the information barrier policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -73,7 +74,23 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the information barrier policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -83,13 +100,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -103,16 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md index 3dfc7c2f6a..6f4cb23daa 100644 --- a/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/exchange/Remove-IntraOrganizationConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-intraorganizationconnector +online version: https://learn.microsoft.com/powershell/module/exchange/remove-intraorganizationconnector applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-IntraOrganizationConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-IntraOrganizationConnector cmdlet to remove existing Intra-Organization connectors. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Intra-Organizational connectors enable features and services between divisions i The Remove-IntraOrganizationConnector cmdlet removes the connector objects. To stop feature or service connectivity without removing the connector object, run the command: `Set-IntraOrganizationConnector -Enabled $false`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,12 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-JournalRule.md b/exchange/exchange-ps/exchange/Remove-JournalRule.md index 705fd16c9f..da555a20f0 100644 --- a/exchange/exchange-ps/exchange/Remove-JournalRule.md +++ b/exchange/exchange-ps/exchange/Remove-JournalRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-journalrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-journalrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-JournalRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-JournalRule cmdlet to remove an existing journal rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-JournalRule [-Identity] ## DESCRIPTION The Remove-JournalRule cmdlet removes the specified journal rule from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-Label.md b/exchange/exchange-ps/exchange/Remove-Label.md index 471ebb4053..7b1812a00e 100644 --- a/exchange/exchange-ps/exchange/Remove-Label.md +++ b/exchange/exchange-ps/exchange/Remove-Label.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-label -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-label +applicable: Security & Compliance title: Remove-Label schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-Label ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-Label cmdlet to remove sensitivity labels from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-Label [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ The Identity parameter specifies the sensitivity label that you want to remove. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -71,7 +71,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -87,7 +87,7 @@ The WhatIf switch causes the command to simulate its results. By using this swit Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md b/exchange/exchange-ps/exchange/Remove-LabelPolicy.md index 666d5a1d3b..2289247216 100644 --- a/exchange/exchange-ps/exchange/Remove-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-LabelPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-labelpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-labelpolicy +applicable: Security & Compliance title: Remove-LabelPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-LabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Remove-LabelPolicies cmdlet to remove sensitivity label policies from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-LabelPolicy [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ The Identity parameter specifies the policy that you want to remove. You can use Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -71,7 +71,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +81,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MailContact.md b/exchange/exchange-ps/exchange/Remove-MailContact.md index eb43bb9bcd..8a14dbb711 100644 --- a/exchange/exchange-ps/exchange/Remove-MailContact.md +++ b/exchange/exchange-ps/exchange/Remove-MailContact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailcontact +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailcontact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-MailContact schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailContact cmdlet to delete existing mail contacts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Remove-MailContact [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -106,9 +106,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -147,12 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailUser.md b/exchange/exchange-ps/exchange/Remove-MailUser.md index 094c0f28bd..022d16da1d 100644 --- a/exchange/exchange-ps/exchange/Remove-MailUser.md +++ b/exchange/exchange-ps/exchange/Remove-MailUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailuser +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-MailUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailUser cmdlet to remove existing mail users. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Remove-MailUser [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -108,9 +108,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -131,7 +131,9 @@ Accept wildcard characters: False ### -IgnoreLegalHold This parameter is available only in on-premises Exchange. -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch. +The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. + +When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. @@ -151,11 +153,12 @@ Accept wildcard characters: False ### -PermanentlyDelete This parameter is available only in the cloud-based service. -The PermanentlyDelete switch specifies whether to immediately and permanently delete (purge) the mail user, which prevents you from recovering or restoring the mail user. You don't need to specify a value with this switch. +The PermanentlyDelete switch immediately and permanently deletes (purges) the mail user, which prevents you from recovering or restoring the mail user. You don't need to specify a value with this switch. -This switch works only on mail users that have already been deleted, but are still recoverable (known as soft-deleted mail-users), that also have a blank value for the ExternalObjectId property. +**Notes**: -Use the Get-MailUser cmdlet to identify the soft-deleted mail user, and then pipe the results to the Remove-MailUser cmdlet with this switch. For example, Get-MailUser -Identity Laura -SoftDeleted | Remove-MailUser -PermanentlyDelete. +- This switch works only on mail users that have already been deleted, but are still recoverable (known as soft-deleted mail-users) that also have a blank value for the ExternalDirectoryObjectId property. +- Use the Get-MailUser cmdlet to identify the soft-deleted mail user, and then pipe the results to the Remove-MailUser cmdlet with this switch. For example, `Get-MailUser -Identity Laura -SoftDeletedMailUser | Remove-MailUser -PermanentlyDelete`. ```yaml Type: SwitchParameter @@ -191,12 +194,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-Mailbox.md b/exchange/exchange-ps/exchange/Remove-Mailbox.md index b01beceef1..27447b1e7a 100644 --- a/exchange/exchange-ps/exchange/Remove-Mailbox.md +++ b/exchange/exchange-ps/exchange/Remove-Mailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailbox +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-Mailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-Mailbox cmdlet to delete mailboxes and the associated user accounts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -63,13 +63,12 @@ Remove-Mailbox -Database -StoreMailboxIdentity - [-PermanentlyDelete] +Remove-Mailbox [-Identity] [-PermanentlyDelete] [-Confirm] [-Force] - [-IgnoreLegalHold] [-Migration] [-PublicFolder] + [-RemoveCNFPublicFolderMailboxPermanently] [-WhatIf] [] ``` @@ -81,7 +80,7 @@ Use the Identity and Permanent parameters to disconnect the mailbox from the use Use the Disable-Mailbox cmdlet to disconnect the mailbox from the user account, but keep the user account. The mailbox is retained until the deleted mailbox retention period for the database or the mailbox expires, and then the mailbox is permanently deleted (purged). Or, you can immediately purge the disconnected mailbox by using the Database and StoreMailboxIdentity parameters on the Remove-Mailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,6 +101,7 @@ In on-premises Exchange, this example removes the mailbox and the user account f ### Example 3 ```powershell $Temp = Get-Mailbox | Where {$_.DisplayName -eq 'John Rodman'} + Remove-Mailbox -Database Server01\Database01 -StoreMailboxIdentity $Temp.MailboxGuid ``` @@ -109,10 +109,10 @@ In on-premises Exchange, this example removes John Rodman's mailbox from the mai ### Example 4 ```powershell -Get-Mailbox -Identity Laura -SoftDeleted | Remove-Mailbox -PermanentlyDelete. +Get-Mailbox -Identity Laura -SoftDeletedMailbox | Remove-Mailbox -PermanentlyDelete ``` -In Exchange Online, this example removes the specified soft-deleted mailbox mailbox. +In Exchange Online, this example removes the specified soft-deleted mailbox. ## PARAMETERS @@ -297,7 +297,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -315,9 +317,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -338,13 +340,15 @@ Accept wildcard characters: False ### -IgnoreLegalHold This parameter is available only in on-premises Exchange. -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the user. When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. You don't need to specify a value with this switch. +The IgnoreLegalHold switch ignores the legal hold status of the user. You don't need to specify a value with this switch. + +When you disable or remove the user, the user's cloud-based mailbox that's on legal hold is also disabled or removed. After you disable or remove a mailbox, you can't include it in a discovery search. When you disable a mailbox, the mailbox is disconnected from the user account. Disconnected mailboxes and removed mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. However, you can also remove a mailbox and purge it immediately from the mailbox database. Check with your organization's legal or Human Resources department before you disable or remove a mailbox that's on legal hold. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Identity, StoreMailboxIdentity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -395,11 +399,11 @@ Accept wildcard characters: False ### -PermanentlyDelete This parameter is available only in the cloud-based service. -The PermanentlyDelete switch specifies whether to immediately and permanently delete (purge) the mailbox, which prevents you from recovering or restoring the mailbox. You don't need to specify a value with this switch. +The PermanentlyDelete switch immediately and permanently deletes (purges) the mailbox, which prevents you from recovering or restoring the mailbox. You don't need to specify a value with this switch. **Notes**: -- This switch works only on mailboxes that have already been deleted, but are still recoverable (known as soft-deleted mailboxes). Use the Get-Mailbox cmdlet to identify the soft-deleted mailbox, and then pipe the results to the Remove-Mailbox cmdlet as shown in Example 3 in this topic. +- This switch works only on mailboxes that have already been deleted, but are still recoverable (known as soft-deleted mailboxes). Use the Get-Mailbox cmdlet to identify the soft-deleted mailbox, and then pipe the results to the Remove-Mailbox cmdlet as shown in Example 4 in this topic. - This switch doesn't work on soft-deleted mailboxes that are on In-Place Hold or Litigation Hold (known as inactive mailboxes). ```yaml @@ -436,7 +440,9 @@ Accept wildcard characters: False ### -RemoveArbitrationMailboxWithOABsAllowed This parameter is available only in on-premises Exchange. -The RemoveArbitrationMailboxWithOABsAllowed switch specifies whether to bypass the checks for offline address books (OABs) within the specified arbitration mailbox that is being removed. When you use this switch, the arbitration mailbox is removed even if OABs are present in the mailbox. You don't need to specify a value with this switch. +The RemoveArbitrationMailboxWithOABsAllowed switch specifies whether to bypass the checks for offline address books (OABs) within the specified arbitration mailbox that is being removed. You don't need to specify a value with this switch. + +When you use this switch, the arbitration mailbox is removed even if OABs are present in the mailbox. ```yaml Type: SwitchParameter @@ -451,10 +457,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoveCNFPublicFolderMailboxPermanently +This parameter is available only in the cloud-based service. + +{{ Fill RemoveCNFPublicFolderMailboxPermanently Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoveLastArbitrationMailboxAllowed This parameter is available only in on-premises Exchange. -The RemoveLastArbitrationMailboxAllowed switch specifies whether to remove the specified mailbox, even if it's the last arbitration mailbox in the organization. If you remove the last arbitration mailbox in the organization, you can't have user-created distribution groups or moderated recipients. You don't need to specify a value with this switch. +The RemoveLastArbitrationMailboxAllowed switch specifies whether to remove the specified mailbox, even if it's the last arbitration mailbox in the organization. You don't need to specify a value with this switch. + +If you remove the last arbitration mailbox in the organization, you can't have user-created distribution groups or moderated recipients. ```yaml Type: SwitchParameter @@ -508,12 +534,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md b/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md index 5048a13ef6..3e424e0421 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-MailboxDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-MailboxDatabase cmdlet to delete a mailbox database object. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ If the mailbox database has a database copy, the Remove-MailboxDatabase cmdlet a The Remove-MailboxDatabase cmdlet removes only the database object from Active Directory. It doesn't remove the physical database files. You must remove the database files manually after you run the Remove-MailboxDatabase cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md index 49cfc1fd81..6fd45481ac 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxDatabaseCopy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxdatabasecopy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-MailboxDatabaseCopy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-MailboxDatabaseCopy cmdlet to remove a passive copy of a mailbox database. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ To use the Remove-MailboxDatabaseCopy cmdlet to remove a mailbox database copy, You can't use this cmdlet to remove the active copy of a mailbox database. To remove the active copy of a mailbox database, you must first remove all passive copies of the database and then use the Remove-MailboxDatabase cmdlet to remove the active copy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). Running this cmdlet removes the mailbox database copy configuration, but doesn't delete the database copy's files. If necessary, you can manually delete those files. @@ -123,12 +123,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md index 239f7a8a0e..6f850b68be 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxExportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxexportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-MailboxExportRequest schema: 2.0.0 @@ -16,11 +16,11 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-MailboxExportRequest cmdlet to remove fully or partially completed export requests. You can create multiple export requests for a specified mailbox provided that you specify a distinct name. Completed export requests aren't cleared automatically; they need to be removed by using this cmdlet. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). When a partially completed export request is removed, content already exported isn't removed from the PST file. If you want to start a new export request to the same file name and start with an empty PST file, you need to rename or delete the previous PST file. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,7 +48,7 @@ The parameter set that requires the Identity parameter allows you to remove a fu The parameter set that requires the RequestGuid and RequestQueue parameters is used for Microsoft Exchange Mailbox Replication service (MRS) debugging purposes only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -167,7 +167,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -203,12 +205,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md index 52fb3906d7..3dccb1d13c 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxFolderPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MailboxFolderPermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxFolderPermission cmdlet to remove folder-level permissions for users in mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,7 +52,7 @@ Remove-MailboxFolderPermission [-Identity] [-ResetDel ## DESCRIPTION You can't use this cmdlet to selectively remove permissions from a user on a mailbox folder. The cmdlet removes all permissions that are assigned to the user on the specified folder. To modify the permissions that are assigned to the user on a mailbox folder, use the Set-MailboxFolderPermission cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,7 +102,14 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example: +The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: - Name - Alias @@ -164,7 +171,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -180,15 +189,17 @@ Accept wildcard characters: False ``` ### -ResetDelegateUserCollection -This parameter is available only in the cloud-based service. +The ResetDelegateUserCollection switch forces the removal of the LocalFreeBusy or the PR_FREEBUSY_ENTRYIDs files in case of corruption. You don't need to specify a value with this switch. + +Use this switch if you encounter problems trying add, change, or remove delegate permissions. Using this switch deletes those files and downgrades any existing delegates to Editor permissions. You'll need to grant delegate permissions again using `-SharingPermissionFlag Delegate`. -The ResetDelegateUserCollection switch can only be used together with -Identity parameter, and the value of Identity should be the user's primary calendar folder, for example, kim@consoto.com:\Calendar. If you run into a problem when trying to add, change, or remove delegate permissions, it is possible that the delegate information stored in the LocalFreeBusy item or the PR_FREEBUSY_ENTRYIDS has become corrupted. Including this switch will delete those files and will downgrade any existing Delegates to Editor status. You will need to grant Delegate permissions again using -SharingPermissionFlag Delegate. +When you use this switch, the value of Identity should be the user's primary calendar folder (for example, `kim@contoso.com:\Calendar`). ```yaml Type: SwitchParameter Parameter Sets: ResetDelegateUserCollection Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2019, Exchange Online Required: False Position: Named @@ -241,22 +252,22 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS -[Get-MailboxFolderPermission](Get-MailboxFolderPermission.md) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) -[Set-MailboxFolderPermission](Set-MailboxFolderPermission.md) +[Set-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission) -[Add-MailboxFolderPermission](Add-MailboxFolderPermission.md) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](Get-EXOMailboxFolderPermission.md) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md b/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md new file mode 100644 index 0000000000..688966ba55 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-MailboxIRMAccess.md @@ -0,0 +1,110 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxirmaccess +applicable: Exchange Online +title: Remove-MailboxIRMAccess +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-MailboxIRMAccess + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-MailboxIRMAccess cmdlet to allow (unblock) delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-MailboxIRMAccess [-Identity] -User + [] +``` + +## DESCRIPTION +> [!NOTE] +> This cmdlet works only for delegates who already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com -User chris@contoso.onmicrosoft.com +``` + +This example removes the restriction from IRM-protected messages in Lynette's mailbox for delegate Chris. In other words, delegate Chris can now access IRM-protected messages in Lynette's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -User +**Note**: Delegates that you specify with this parameter must already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). + +The User parameter specifies the delegate who is no longer blocked from reading IRM-protected messages in the mailbox. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md index aafe02c7f7..e4a36d24de 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxImportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboximportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MailboxImportRequest schema: 2.0.0 @@ -16,13 +16,13 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxImportRequest cmdlet to remove fully or partially completed import requests. Completed import requests aren't automatically cleared. Requests need to be removed by using the Remove-MailboxImportRequest cmdlet. Multiple import requests can exist against the same mailbox if you provide a distinct import request name. -NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://docs.microsoft.com/microsoft-365/compliance/use-network-upload-to-import-pst-files). +NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://learn.microsoft.com/purview/use-network-upload-to-import-pst-files). -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). Removing a partially completed import request removes the request from the Microsoft Exchange Mailbox Replication service (MRS) job queue. Any import progress that was made until the removal won't be reverted. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -50,7 +50,7 @@ The parameter set that requires the Identity parameter allows you to remove a fu The parameter set that requires the RequestGuid and RequestQueue parameters is used for MRS debugging purposes only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -177,7 +177,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -213,12 +215,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md index d69c9dc1b1..b6e76be563 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxPermission.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxpermission +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MailboxPermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxPermission cmdlet to remove permissions from a user's mailbox or from an Exchange Server 2016, Exchange Server 2019 or Exchange Online mail user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,6 @@ Remove-MailboxPermission [[-Identity] ] -Instance ] - [-ResetDefault] [-User ] [-WhatIf] [] @@ -65,24 +64,18 @@ Remove-MailboxPermission [[-Identity] ] ### ClearAutoMapping ``` -Remove-MailboxPermission [-Identity] +Remove-MailboxPermission [-Identity] [-ClearAutoMapping] [-BypassMasterAccountSid] - [-ClearAutoMapping] - [-AccessRights ] [-Confirm] - [-Deny] [-DomainController ] [-IgnoreDefaultScope] - [-InheritanceType ] - [-User ] [-WhatIf] [] ``` ### ResetDefault ``` -Remove-MailboxPermission [-Identity] - [-ResetDefault] +Remove-MailboxPermission [-Identity] [-ResetDefault] [-Confirm] [-DomainController ] [-IgnoreDefaultScope] @@ -93,16 +86,23 @@ Remove-MailboxPermission [-Identity] ## DESCRIPTION The Remove-MailboxPermission cmdlet allows you to remove permissions from a user's mailbox, for example, removing full access to another user's mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Remove-MailboxPermission -Identity Test1 -User Test2 -AccessRights FullAccess -InheritanceType All +Remove-MailboxPermission -Identity "Yuuto Sasaki" -User "Pedro Pizarro" -AccessRights FullAccess -InheritanceType All +``` + +This example removes Pedro Pizarro's full access permission to Yuuto Sasaki's mailbox. + +### Example 2 +```powershell +Remove-MailboxPermission -Identity "HR Project" -ClearAutoMapping ``` -This example removes user Test2's full access rights to Test1's mailbox. +In Exchange Online, this example excludes the HR Project mailbox from auto-mapping in Outlook for all users who have Full Access permission to the mailbox. ## PARAMETERS @@ -210,7 +210,12 @@ The User parameter specifies whose permissions are being removed from the specif - Mail users - Security groups -You can use any value that uniquely identifies the user or group. For example: +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: - Name - Alias @@ -250,11 +255,15 @@ Accept wildcard characters: False ``` ### -ClearAutoMapping -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. + +The ClearAutoMapping parameter excludes the mailbox from the auto-mapping feature in Microsoft Outlook. You don't need to specify a value with this switch. + +Auto-mapping uses Autodiscover to automatically add mailboxes to a user's Outlook profile if the user has Full Access permission to the mailbox. Use this switch to exclude this mailbox from auto-mapping for all users who have Full Access permission to the mailbox. -The ClearAutoMapping switch specifies that the mailbox is automatically mapped (auto-mapped) by Autodiscover only into the mailbox owner's Outlook profile. The mailbox isn't auto-mapped to other users who have FullAccess permission to the mailbox. +You can't use this switch with the User or AccessRights parameters. -To re-add auto-mapping capability on the mailbox for other users, run the command: `Add-MailboxPermission -Identity -AccessRights FullAccess -AutoMapping $true`. +**Note**: If you use this switch in a Remove-MailboxPermission command, but the mailbox is not excluded from auto-mapping for a user, remove the user's Full Access permission by using the Remove-MailboxPermission cmdlet with the User parameter. Then, reassign the user's Full Access permission on the mailbox using the Add-MailboxPermission cmdlet with the AutoMapping parameter set to the value $false. ```yaml Type: SwitchParameter @@ -269,12 +278,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ResetDefault +This parameter is functional only in the cloud-based service. + +The ResetDefault switch resets the default security descriptor of the mailbox. You don't need to specify a value with this switch. + +Permissions on the mailbox are reset so only the mailbox owner has Full Access permission to the mailbox. The following types of permissions are not affected: + +- Recipient permissions (for example, SendAs, SendOnBehalf and delegates). +- Mailbox folder permissions assigned using the MailboxFolderPermission cmdlets. +- Mailbox folder permissions assigned using Outlook or other MAPI clients. + +Also, because this switch removes Full Access permission from other users on the mailbox, the mailbox is no longer auto-mapped by Autodiscover into the Outlook profiles of other users. + +You can't use this switch with the User for AccessRights parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: Instance +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BypassMasterAccountSid This parameter is available only in the cloud-based service. -The BypassMasterAccountSid parameter is required when you receive the following error when you try to use this cmdlet: `Can't remove the access control entry on the object "User" for the user account because the ACE doesn't exist on the object.` +The BypassMasterAccountSid switch suppresses the following error: `Can't remove the access control entry on the object "User" for the user account because the ACE doesn't exist on the object.` You don't need to specify a value with this switch. -Typically, you only need to use this parameter in Microsoft Office 365 Dedicated/ITAR legacy environments. +Typically, you only need to use this switch in Office 365 Dedicated or ITAR legacy environments. ```yaml Type: SwitchParameter @@ -309,7 +346,7 @@ Accept wildcard characters: False ``` ### -Deny -The Deny parameter denies permissions to the user on the Active Directory object. +The Deny switch specifies that the permissions you're removing are Deny permissions. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -361,9 +398,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -382,7 +419,13 @@ Accept wildcard characters: False ``` ### -InheritanceType -The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. +The InheritanceType parameter specifies whether permissions are inherited to folders within the mailbox. Valid values are: + +- None +- All (this is the default value) +- Children +- Descendents [sic] +- SelfAndChildren ```yaml Type: ActiveDirectorySecurityInheritance @@ -397,30 +440,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResetDefault -This parameter is available or functional only in the cloud-based service. - -The ResetDefault switch resets the default security descriptor of the mailbox. Permissions on the mailbox are reset so only the mailbox owner has FullAccess permission to the mailbox. The following types of permissions are not affected: - -- Recipient permissions (for example, SendAs, SendOnBehalf and delegates). -- Mailbox folder permissions assigned using the MailboxFolderPermission cmdlets. -- Mailbox folder permissions assigned using Outlook or other MAPI clients. - -Also, because this switch removes FullAccess permission from other users on the mailbox, the mailbox is no longer auto-mapped by Autodiscover into the Outlook profiles of other users. - -```yaml -Type: SwitchParameter -Parameter Sets: Instance -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -SoftDeletedMailbox This parameter is available only in the cloud-based service. @@ -462,12 +481,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md index 31fdeec2b4..c9037afa2f 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxRepairRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxrepairrequest +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxrepairrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-MailboxRepairRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-MailboxRepairRequest cmdlet to remove mailbox repair requests from a mailbox database that were created using the New-MailboxRepairRequest cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,28 +31,30 @@ Remove-MailboxRepairRequest [-Identity] ## DESCRIPTION You can run the Remove-MailboxRepairRequest cmdlet to remove all mailbox repair requests for a specific database, for a group of related mailbox repair requests, or for a specific mailbox repair request. Mailbox repair requests are identified by a complex GUID with the following format: `DatabaseGuid\RequestGuid\JobGuid`. The DatabaseGuid identifies the mailbox database where the mailbox being repaired is located. The RequestGuid identifies related requests that may contain more than one job if the request runs more than one task or targets more than one mailbox. The JobGuid identifies a unique job. See the examples to remove all requests on a mailbox database, remove a group of related requests that share the same RequestGuid, or remove a specific request by specifying the complete `DatabaseGuid\RequestGuid\JobGuid` value. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Get-MailboxDatabase -Identity "EXCH-MBX-01" | Get-MailboxRepairRequest | Remove-MailboxRepairRequest +Get-MailboxRepairRequest -Database "EXCH-MBX-01" | Remove-MailboxRepairRequest ``` This example removes all mailbox repair requests for the mailbox database EXCH-MBX-01. ### Example 2 ```powershell -Get-MailboxDatabase -Identity "EXCH-MBX-02" | Get-MailboxRepairRequest | Format-List Identity +Get-MailboxRepairRequest -Database "EXCH-MBX-02" | Format-List Identity + Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\335c2b06-321d-4e73-b2f7-3dc2b02d0df5 ``` -This example removes all related mailbox repair requests that have the same DatabaseGuid\\RequestGuid. The example uses the Get-MailboxRepairRequest cmdlet to display the value of the Identity parameter for all mailbox repair request for EXCH-MBX-02 mailbox database. +This example removes all related mailbox repair requests that have the same `DatabaseGuid\RequestGuid` value. The example uses the Get-MailboxRepairRequest cmdlet to display the value of the Identity parameter for all mailbox repair request for EXCH-MBX-02 mailbox database. ### Example 3 ```powershell -Get-MailboxDatabase -Identity "EXCH-MBX-02" | Get-MailboxRepairRequest | Format-List Identity +Get-MailboxRepairRequest -Database "EXCH-MBX-02" | Format-List Identity + Remove-MailboxRepairRequest -Identity 5b8ca3fa-8227-427f-af04-9b4f206d611f\189c7852-49bd-4737-a53e-6e6caa5a183c\1d8ca58a-186f-4dc6-b481-f835b548a929 ``` @@ -132,12 +134,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md index bba449360a..96cc00e783 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxRestoreRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxrestorerequest +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MailboxRestoreRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxRestoreRequest cmdlet to remove fully or partially completed restore requests. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,7 +44,7 @@ The parameter set that requires the Identity parameter allows you to remove a fu The parameter set that requires the RequestGuid and RequestQueue parameters is used for Microsoft Exchange Mailbox Replication service (MRS) debugging purposes only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -171,7 +171,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -207,12 +209,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md index 5102448bef..eca5f3db04 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxsearch +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MailboxSearch schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxSearch cmdlet to remove a mailbox search. -**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Remove-MailboxSearch [-Identity] ## DESCRIPTION In on-premises Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can't remove an In-Place Hold without first disabling the hold. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md b/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md index c49a712f89..723d1efc08 100644 --- a/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md +++ b/exchange/exchange-ps/exchange/Remove-MailboxUserConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mailboxuserconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mailboxuserconfiguration applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MailboxUserConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MailboxUserConfiguration cmdlet to remove user configuration items from mailboxes. Typically, after you delete a user configuration item, it's automatically recreated the next time the user uses that feature in their mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-MailboxUserConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -101,7 +101,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in on-premises Exchange. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -137,12 +139,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md index 719dcaa71f..4171ff3c01 100644 --- a/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Remove-MalwareFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-malwarefilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-MalwareFilterRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MalwareFilterRule cmdlet to remove malware filter rules from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-MalwareFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md index bdaef419e3..3ec37d8684 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md +++ b/exchange/exchange-ps/exchange/Remove-ManagedContentSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-managedcontentsettings +online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedcontentsettings applicable: Exchange Server 2010 title: Remove-ManagedContentSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-ManagedContentSettings cmdlet to delete managed content settings from a managed folder. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-ManagedContentSettings [-Identity] ## DESCRIPTION When managed content settings are removed from a managed folder, the folder effectively ceases to be a managed folder, and folder contents are no longer under messaging records management (MRM). Removing managed content settings disables any retention and journaling policies for the folder. It doesn't affect whether you can move, delete, or rename the folder, or whether the folder has a quota or policy statement that's displayed in Microsoft Outlook or Microsoft Office Outlook Web App. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolder.md b/exchange/exchange-ps/exchange/Remove-ManagedFolder.md index 7761a8553e..7b68957f99 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedFolder.md +++ b/exchange/exchange-ps/exchange/Remove-ManagedFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-managedfolder +online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedfolder applicable: Exchange Server 2010 title: Remove-ManagedFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-ManagedFolder cmdlet to remove a managed folder from Active Directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-ManagedFolder [-Identity] ## DESCRIPTION The Remove-ManagedFolder cmdlet accepts a managed folder object or a mailbox identity as pipelined input. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md index 2c8f6a592c..4cd1f7a86c 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-ManagedFolderMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-managedfoldermailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-managedfoldermailboxpolicy applicable: Exchange Server 2010 title: Remove-ManagedFolderMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-ManagedFolderMailboxPolicy cmdlet to delete managed folder mailbox policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Remove-ManagedFolderMailboxPolicy [-Identity] ## DESCRIPTION If you remove a managed folder mailbox policy that's applied to users' mailboxes, the affected mailboxes may no longer have retention settings. Therefore, before using this cmdlet to remove a policy, you should determine if the managed folder mailbox policy is applied to any users, and apply another policy to those users. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,7 +97,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch overrides the confirmation prompt displayed by the cmdlet when the managed folder mailbox policy being removed is assigned to a mailbox user. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +This switch hides the confirmation prompt when the managed folder mailbox policy that's being removed is assigned to a mailbox user. ```yaml Type: SwitchParameter @@ -133,12 +135,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRole.md b/exchange/exchange-ps/exchange/Remove-ManagementRole.md index b62af20b07..60ed3913e0 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRole.md +++ b/exchange/exchange-ps/exchange/Remove-ManagementRole.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-managementrole +online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementrole applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-ManagementRole schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ManagementRole cmdlet to remove custom management roles that you don't need anymore. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Remove-ManagementRole [-Identity] ``` ## DESCRIPTION -You need to remove all the management role assignments from a role before you delete it. If the role is the parent of child roles, the child roles must be removed before you remove the parent role, or you must use the Recurse parameter when you remove the parent role. You can only remove custom roles. Built-in roles, such as the Mail Recipients role, can't be removed. For more information about how to remove a custom role, see [Remove a role](https://docs.microsoft.com/exchange/remove-a-role-exchange-2013-help). +You need to remove all the management role assignments from a role before you delete it. If the role is the parent of child roles, the child roles must be removed before you remove the parent role, or you must use the Recurse parameter when you remove the parent role. You can only remove custom roles. Built-in roles, such as the Mail Recipients role, can't be removed. For more information about how to remove a custom role, see [Remove a role](https://learn.microsoft.com/exchange/remove-a-role-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,7 +68,7 @@ Remove-ManagementRole "In-house scripts" -UnScopedTopLevel In on-premises Exchange, this example removes the In-house scripts unscoped top-level management role. Because this is an unscoped top-level role, the UnScopedTopLevel switch must be used. Note that the UnScopedTopLevel switch requires the UnScoped Role Management role, which isn't assigned to any role groups by default. -For more information about unscoped top-level management roles, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about unscoped top-level management roles, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). ## PARAMETERS @@ -128,7 +128,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -144,9 +146,9 @@ Accept wildcard characters: False ``` ### -Recurse -The Recurse parameter removes all child roles of the role specified with the Identity parameter, and then removes the specified role. +The Recurse switch removes the specified role and all child roles of the specified role. You don't need to specify a value with this switch. -The Recurse parameter removes all child roles of the specified role. We recommend that you first use the command with the WhatIf switch to confirm that the action to be taken is correct. +We recommend that you test the command with the WhatIf switch to confirm that the results will be correct. ```yaml Type: SwitchParameter @@ -162,16 +164,14 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. +This parameter is available only in on-premises Exchange. -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). The UnScopedTopLevel switch specifies the role that you want to remove is an unscoped top-level role. You don't need to specify a value with this switch. Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. -You must use this switch if you want to remove an unscoped top-level role. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -206,12 +206,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md index fa2910239c..7540ec48ac 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Remove-ManagementRoleAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-managementroleassignment +online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementroleassignment applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-ManagementRoleAssignment schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ManagementRoleAssignment cmdlet to remove management role assignments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Remove-ManagementRoleAssignment [-Identity] ``` ## DESCRIPTION -When you remove a role assignment, the management role group, management role assignment, user, or universal security group (USG) that was assigned the associated role can no longer access the cmdlets or parameters made available by the role. For more information about management role assignments, see [Understanding management role assignments](https://docs.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). +When you remove a role assignment, the management role group, management role assignment, user, or universal security group (USG) that was assigned the associated role can no longer access the cmdlets or parameters made available by the role. For more information about management role assignments, see [Understanding management role assignments](https://learn.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -110,7 +110,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -146,12 +148,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md index 48040e50af..a6d8a1d54c 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Remove-ManagementRoleEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-managementroleentry +online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementroleentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-ManagementRoleEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ManagementRoleEntry cmdlet to remove existing management role entries. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Remove-ManagementRoleEntry [-Identity] ## DESCRIPTION The Remove-ManagementRoleEntry cmdlet removes existing role entries. However, you can't remove role entries from built-in management roles. -For more information about management role entries, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about management role entries, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,19 +47,21 @@ This example removes the New-Mailbox role entry from the Tier 1 Help Desk role. ### Example 2 ```powershell -Get-ManagementRoleEntry "Tier 1 Help Desk\*" | Where-Object {$_.Name -like 'New-*'} | %{Remove-ManagementRoleEntry -Identity "$($_.id)\$($_.name)"} +Get-ManagementRoleEntry "Tier 1 Help Desk\*" | where {$_.Name -like 'New-*'} | foreach {Remove-ManagementRoleEntry -Identity "$($_.id)\$($_.name)"} ``` -This example removes all the role entries that have the verb New on the Tier 1 Help Desk role by piping the output of the Get-ManagementRoleEntry cmdlet to the Where-Object cmdlet which specifies the verb filter and then, these results are being piped to Remove-ManagementRoleEntry cmdlet. +This example removes all the role entries that have the verb New on the Tier 1 Help Desk role by piping the output of the Get-ManagementRoleEntry cmdlet to the Where-Object cmdlet which specifies the verb filter, and then these results are piped to the Remove-ManagementRoleEntry cmdlet. -This example forces you to acknowledge the command before proceeding. +This example forces you to acknowledge the command before proceeding (we didn't use `-Confirm:$false` or `-Force`). + +**Note**: Exchange Online PowerShell requires the complex syntax as described, and the same command also works in the Exchange Management Shell in on-premises Exchange servers. The Exchange Management Shell supports much simpler syntax for the same result, but the command doesn't work in Exchange Online PowerShell: `Get-ManagementRoleEntry "Tier 1 Help Desk\New-* | Remove-ManagementRoleEntry`. ## PARAMETERS ### -Identity The Identity parameter specifies the role entry that you want to remove. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). -For more information about how management role entries work, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). If the role entry name contains spaces, enclose the name in quotation marks ("). @@ -116,7 +118,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -152,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ManagementScope.md b/exchange/exchange-ps/exchange/Remove-ManagementScope.md index 1c34a95614..ec73842594 100644 --- a/exchange/exchange-ps/exchange/Remove-ManagementScope.md +++ b/exchange/exchange-ps/exchange/Remove-ManagementScope.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-managementscope +online version: https://learn.microsoft.com/powershell/module/exchange/remove-managementscope applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-ManagementScope schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-ManagementScope cmdlet to remove an existing management scope. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Remove-ManagementScope [-Identity] ``` ## DESCRIPTION -You can't remove a management scope if it's associated with a management role assignment. Use the Get-ManagementScope cmdlet to retrieve a list of orphaned scopes. For more information about regular and exclusive scopes, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +You can't remove a management scope if it's associated with a management role assignment. Use the Get-ManagementScope cmdlet to retrieve a list of orphaned scopes. For more information about regular and exclusive scopes, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -110,7 +110,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -146,12 +148,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md index bf84e1d85b..936faaf305 100644 --- a/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-MapiVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mapivirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mapivirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-MapiVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-MapiVirtualDirectory cmdlet to remove Message Application Programming Interface (MAPI) virtual directories from Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-MapiVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-Message.md b/exchange/exchange-ps/exchange/Remove-Message.md index 45148c1227..ecf08727f1 100644 --- a/exchange/exchange-ps/exchange/Remove-Message.md +++ b/exchange/exchange-ps/exchange/Remove-Message.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-message +online version: https://learn.microsoft.com/powershell/module/exchange/remove-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-Message schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-Message cmdlet to delete a message from a queue on a Mailbox server or an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ Remove-Message [-Identity] ## DESCRIPTION A message being transmitted to multiple recipients might be located in multiple queues. If you specify an Identity parameter, the message is removed from a single queue if that identity matches only a single message. If the identity matches more than one message, you receive an error. To remove a message from more than one queue in a single operation, you must use the Filter parameter. If you try to remove a message currently being delivered, the message status changes to PendingDelete. Message delivery isn't interrupted, but if the delivery fails and causes the message to re-enter the queue, it's then removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +58,7 @@ This example removes all messages that meet the following criteria without gener ## PARAMETERS ### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity @@ -74,7 +74,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more messages by using OPath filter syntax. The OPath filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://docs.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -172,12 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MessageClassification.md b/exchange/exchange-ps/exchange/Remove-MessageClassification.md index 0572219455..430c30d775 100644 --- a/exchange/exchange-ps/exchange/Remove-MessageClassification.md +++ b/exchange/exchange-ps/exchange/Remove-MessageClassification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-messageclassification +online version: https://learn.microsoft.com/powershell/module/exchange/remove-messageclassification applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MessageClassification schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MessageClassification cmdlet to delete an existing message classification instance from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-MessageClassification [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md index 810df27037..7a3f08fc37 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Remove-MigrationBatch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-migrationbatch +online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MigrationBatch schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MigrationBatch cmdlet to delete a migration batch that either isn't running or has been completed. If necessary, you can run the Get-MigrationBatch cmdlet to determine the status of a migration batch before you remove it. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ Remove-MigrationBatch [[-Identity] ] [-Confirm] [-DomainController ] [-Force] - [-Partition + [-Partition ] [-WhatIf] [] ``` @@ -33,9 +33,9 @@ Remove-MigrationBatch [[-Identity] ] ## DESCRIPTION The Remove-MigrationBatch cmdlet removes a migration batch. All subscriptions are deleted and any object related to the migration batch is also deleted. -If you use the Force parameter with this cmdlet, the individual user requests and subscriptions that were part of the removed migration batch aren't removed. You need to remove the individual migration user requests with the command: `Remove-MigrationUser -Force`. +If you use the Force switch with this cmdlet, the individual user requests and subscriptions that were part of the removed migration batch aren't removed. You need to remove the individual migration user requests with the command: `Remove-MigrationUser -Force`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -111,9 +111,11 @@ Accept wildcard characters: False ### -Force This parameter is available only in on-premises Exchange. -The Force switch specifies whether to remove a corrupted migration batch. Corrupted migration batches have a status of Corrupted. If you try to remove a corrupted migration batch without using this switch, you receive an error saying the migrated batch can't be found. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -If you use this parameter to remove a corrupted migration batch, the individual user requests (also called job items) and subscriptions that were part of the removed migration batch aren't removed. You need to remove the individual migration user requests with the command: `Remove-MigrationUser -Force`. +Use this switch to remove a corrupted migration batch. Corrupted migration batches have a status of Corrupted. If you try to remove a corrupted migration batch without using this switch, you receive an error saying the migrated batch can't be found. + +If you use this switch to remove a corrupted migration batch, the individual user requests (also called job items) and subscriptions that were part of the removed migration batch aren't removed. You need to remove the individual migration user requests with the command: `Remove-MigrationUser -Force`. ```yaml Type: SwitchParameter @@ -167,12 +169,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md index 766ba4ebe1..9484d7d7e2 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md +++ b/exchange/exchange-ps/exchange/Remove-MigrationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-migrationendpoint +online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationendpoint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MigrationEndpoint schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MigrationEndpoint cmdlet to remove existing migration endpoints for source or destination servers for cutover or staged Exchange migrations, IMAP migrations and remote moves. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Remove-MigrationEndpoint [-Identity] ## DESCRIPTION Use the Remove-MigrationEndpoint cmdlet to remove an existing migration endpoint. -For more information about migration endpoints, see [Set-MigrationEndpoint](https://docs.microsoft.com/powershell/module/exchange/set-migrationendpoint) and [New-MigrationEndpoint](https://docs.microsoft.com/powershell/module/exchange/new-migrationendpoint). +For more information about migration endpoints, see [Set-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchange/set-migrationendpoint) and [New-MigrationEndpoint](https://learn.microsoft.com/powershell/module/exchange/new-migrationendpoint). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -139,12 +139,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MigrationUser.md b/exchange/exchange-ps/exchange/Remove-MigrationUser.md index b5109c0090..61036e2269 100644 --- a/exchange/exchange-ps/exchange/Remove-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Remove-MigrationUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-migrationuser +online version: https://learn.microsoft.com/powershell/module/exchange/remove-migrationuser applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MigrationUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MigrationUser cmdlet to remove a migration user from a batch. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-MigrationUser [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -100,7 +100,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in on-premises Exchange. -The Force switch specifies that some specific checks and removal steps should be skipped and that the migration user should be forcibly removed. This parameter is used to work around issues where the migration user needs to be removed to fix issues when the user or data is corrupted, or to prevent such issues from occurring. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to work around user or data corruption issues. Specific checks and removal steps are skipped to forcibly remove the migration user. ```yaml Type: SwitchParameter @@ -154,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MobileDevice.md b/exchange/exchange-ps/exchange/Remove-MobileDevice.md index d65aa5b4f9..dc6843cec8 100644 --- a/exchange/exchange-ps/exchange/Remove-MobileDevice.md +++ b/exchange/exchange-ps/exchange/Remove-MobileDevice.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mobiledevice +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mobiledevice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MobileDevice schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MobileDevice cmdlet to remove mobile device partnerships that identify the devices that are configured to synchronize with user mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,31 +31,32 @@ Remove-MobileDevice [-Identity] ## DESCRIPTION The Remove-MobileDevice cmdlet is useful for removing mobile devices that no longer synchronize successfully with the server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Remove-MobileDevice -Identity WM_JeffHay +Remove-MobileDevice -Identity JeffHay\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac ``` -This example removes the mobile device partnership for the device named WM\_JeffHay. +This example removes the mobile device partnership for the specified mobile device. ### Example 2 ```powershell -Remove-MobileDevice -Identity iPhone_TonySmith -Confirm:$false +Remove-MobileDevice -Identity TonySmith\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac -Confirm:$false ``` -This example removes the mobile device partnership for the device named iPhone\_TonySmith and doesn't display the confirm prompt. +This example removes the mobile device partnership for the specified device and doesn't display the confirm prompt. ## PARAMETERS ### -Identity -The Identity parameter specifies the mobile device partnership that you want to remove. You can use any value that uniquely identifies the mobile device. For example: +The Identity parameter specifies the mobile device partnership that you want to remove. You can use the following values that uniquely identifies the mobile device: -- GUID -- DeviceID +- Identity (`\ExchangeActiveSyncDevices\` for example, `CarlosM\ExchangeActiveSyncDevices\REST§Outlook§5eec4e941e0748a264512fd83770d5ac`) +- Distinguished name (DN) +- GUID (same as ExchangeObjectId) ```yaml Type: MobileDeviceIdParameter @@ -128,12 +129,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md index f309665403..24f850cef1 100644 --- a/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-MobileDeviceMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-mobiledevicemailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-mobiledevicemailboxpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MobileDeviceMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MobileDeviceMailboxPolicy cmdlet to remove mobile device mailbox policies from Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Remove-MobileDeviceMailboxPolicy [-Identity] ## DESCRIPTION A Mobile Device mailbox policy is a group of settings that specifies how mobile phones connect to Exchange. Exchange supports multiple mobile device mailbox policies. The Remove-MobileDeviceMailboxPolicy cmdlet removes a specific mobile device mailbox policy. If any users are assigned to the policy when you remove it, the Remove-MobileDeviceMailboxPolicy cmdlet fails. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -117,7 +117,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -153,12 +155,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-MoveRequest.md b/exchange/exchange-ps/exchange/Remove-MoveRequest.md index 4de5a60c28..ff8f5e3203 100644 --- a/exchange/exchange-ps/exchange/Remove-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Remove-MoveRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-moverequest +online version: https://learn.microsoft.com/powershell/module/exchange/remove-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-MoveRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-MoveRequest cmdlet to cancel a mailbox move initiated using the New-MoveRequest cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,13 +42,13 @@ Remove-MoveRequest -MailboxGuid -MoveRequestQueue ``` ## DESCRIPTION -In coexistence environments with Exchange 2010 and newer versions of Exchange, don't run a newer version of Remove-MoveRequest to clear completed mailbox move requests between Exchange 2010 databases as documented in [Clear or Remove Move Requests](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/dd351276(v=exchg.141)). Otherwise, you might delete the mailbox that you just moved. In coexistence environments, only use the Remove-MoveRequest cmdlet on Exchange 2010 servers to clear completed Exchange 2010 move requests. For mailbox moves from an Exchange 2010 database to an Exchange 2016 database, you can safely run Remove-MoveRequest on the Exchange 2016 server. +In coexistence environments with Exchange 2010 and newer versions of Exchange, don't run a newer version of Remove-MoveRequest to clear completed mailbox move requests between Exchange 2010 databases as documented in [Clear or Remove Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd351276(v=exchg.141)). Otherwise, you might delete the mailbox that you just moved. In coexistence environments, only use the Remove-MoveRequest cmdlet on Exchange 2010 servers to clear completed Exchange 2010 move requests. For mailbox moves from an Exchange 2010 database to an Exchange 2016 database, you can safely run Remove-MoveRequest on the Exchange 2016 server. In Exchange 2010, you need to use the Remove-MoveRequest cmdlet on completed move requests to clear the InTransit flag from the mailbox. This step isn't required for mailbox moves in newer versions of Exchange where the Remove-MoveRequest is only used to cancel existing move requests. The MoveRequestQueue and MailboxGuid parameters are for debugging purposes only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -178,7 +178,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -243,12 +245,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md index 5dfa09acde..20d726ee54 100644 --- a/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md +++ b/exchange/exchange-ps/exchange/Remove-OMEConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Remove-OMEConfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/remove-omeconfiguration applicable: Exchange Online title: Remove-OMEConfiguration schema: 2.0.0 @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-OMEConfiguration cmdlet to remove custom Microsoft 365 Message Encryption (OME) configurations. You can't use this cmdlet to remove the default OME configuration. +Use the Remove-OMEConfiguration cmdlet to remove custom Microsoft Purview Message Encryption configurations. You can't use this cmdlet to remove the default OME configuration. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Remove-OMEConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,12 +97,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md index 1f0f5c7223..24791b7b37 100644 --- a/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-OabVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-oabvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/remove-oabvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-OabVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-OabVirtualDirectory cmdlet to remove offline address book (OAB) virtual directories from Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Remove-OabVirtualDirectory [-Identity] ## DESCRIPTION Some situations require the removal of an OAB virtual directory. For example, to uninstall an Exchange server that contains an OAB distribution points list, you need to remove the OAB virtual directory and then re-create it on another server. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -110,7 +110,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -146,12 +148,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md index de4646f700..b9d780e4f5 100644 --- a/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Remove-OfflineAddressBook.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-offlineaddressbook +online version: https://learn.microsoft.com/powershell/module/exchange/remove-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-OfflineAddressBook schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-OfflineAddressBook cmdlet to remove (delete) offline address books (OABs). -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Remove-OfflineAddressBook [-Identity] ## DESCRIPTION If you remove the default OAB, you need to configure another OAB as the default by using the IsDefault parameter on the New-OfflineAddressBook or Set-OfflineAddressBook cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -105,7 +105,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -141,12 +143,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md index 8809e7524a..a6196d357b 100644 --- a/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md +++ b/exchange/exchange-ps/exchange/Remove-OnPremisesOrganization.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-onpremisesorganization +online version: https://learn.microsoft.com/powershell/module/exchange/remove-onpremisesorganization applicable: Exchange Online title: Remove-OnPremisesOrganization schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-OnPremisesOrganization cmdlet to remove an OnPremisesOrganization object in a Microsoft 365 tenant. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Remove-OnPremisesOrganization [-Identity] ## DESCRIPTION Removing an OnPremisesOrganization object should only be used in circumstances where the hybrid deployment state is corrupt and under the direction and supervision of Microsoft Customer Service and Support. After removing the OnPremisesOrganization object, any related hybrid deployment configured with this object won't be functional and will need to be re-created and reconfigured. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -105,12 +103,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md index a04348b615..0598e9d220 100644 --- a/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/Remove-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/remove-organizationrelationship +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-OrganizationRelationship cmdlet to remove the organization relationship with an external Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-OrganizationRelationship [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ The Identity parameter specifies the organization segment that you want to remov Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -71,7 +71,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +81,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,18 +101,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Attributes for information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes) +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Remove-OutboundConnector.md b/exchange/exchange-ps/exchange/Remove-OutboundConnector.md index 02af0a8df5..7cfabaff38 100644 --- a/exchange/exchange-ps/exchange/Remove-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/Remove-OutboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-outboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/remove-outboundconnector applicable: Exchange Online, Exchange Online Protection title: Remove-OutboundConnector schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-OutboundConnector cmdlet to delete an Outbound connector from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Remove-OutboundConnector [-Identity] ## DESCRIPTION Outbound connectors send email messages to remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -101,12 +99,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md index b2017b01ee..2fd3e45e05 100644 --- a/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/Remove-OutlookProtectionRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-outlookprotectionrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-OutlookProtectionRule schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-OutlookProtectionRule cmdlet to remove Outlook protection rules. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +31,9 @@ Remove-OutlookProtectionRule [-Identity] ``` ## DESCRIPTION -Outlook protection rules use an Active Directory Rights Management Services (AD RMS) rights template to automatically apply Information Rights Management (IRM) protection to messages before they're sent. For more information, see [Outlook protection rules](https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). +Outlook protection rules use an Active Directory Rights Management Services (AD RMS) rights template to automatically apply Information Rights Management (IRM) protection to messages before they're sent. For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -127,12 +127,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-OutlookProvider.md b/exchange/exchange-ps/exchange/Remove-OutlookProvider.md index 897da26725..1d6410cdd9 100644 --- a/exchange/exchange-ps/exchange/Remove-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/Remove-OutlookProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-outlookprovider +online version: https://learn.microsoft.com/powershell/module/exchange/remove-outlookprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-OutlookProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-OutlookProvider cmdlet to delete the AutoDiscoverConfig object from Active Directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-OutlookProvider [-Identity] ## DESCRIPTION The Remove-OutlookProvider cmdlet deletes the AutoDiscoverConfig object under the Global Settings object in Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md index 45aa85013a..b9f7e4ee5e 100644 --- a/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-OwaMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-owamailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-owamailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-OwaMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-OwaMailboxPolicy cmdlet to remove Outlook on the web mailbox policies from the organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Remove-OwaMailboxPolicy [-Identity] ``` ## DESCRIPTION -Changes to Outlook on the web mailbox polices may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). +Changes to Outlook on the web mailbox policies may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -117,7 +117,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -153,12 +155,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md index 6c109a7a76..f97d5d7436 100644 --- a/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-OwaVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-owavirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/remove-owavirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-OwaVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-OwaVirtualDirectory cmdlet to remove Outlook on the web virtual directories from Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ You might be required to use the Remove-OwaVirtualDirectory cmdlet in the follow Remove-OwaVirtualDirectory permanently removes an Outlook on the web virtual directory or directories. When you use this cmdlet, make sure that you don't accidentally delete the default Outlook on the web virtual directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -127,12 +127,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-PartnerApplication.md b/exchange/exchange-ps/exchange/Remove-PartnerApplication.md index de435d8d27..2eb9caf5e4 100644 --- a/exchange/exchange-ps/exchange/Remove-PartnerApplication.md +++ b/exchange/exchange-ps/exchange/Remove-PartnerApplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-partnerapplication +online version: https://learn.microsoft.com/powershell/module/exchange/remove-partnerapplication applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-PartnerApplication schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-PartnerApplication cmdlet to remove a partner application configuration. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,11 +29,11 @@ Remove-PartnerApplication [-Identity] ``` ## DESCRIPTION -You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the Remove-PartnerApplication cmdlet to remove a partner application configuration if the application no longer needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://docs.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). +You can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the Remove-PartnerApplication cmdlet to remove a partner application configuration if the application no longer needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://learn.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md index aa0f7e084e..590d704a0c 100644 --- a/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-PhishSimOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-phishsimoverridepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-phishsimoverridepolicy +applicable: Exchange Online title: Remove-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,35 +12,60 @@ ms.reviewer: # Remove-PhishSimOverridePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -Use the Remove-PhishSimOverridePolicy cmdlet to remove third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). +Use the Remove-PhishSimOverridePolicy cmdlet to remove third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Remove-PhishSimOverridePolicy [-Identity] [-Confirm] + [-DomainController ] + [-ForceDeletion] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Remove-PhishSimOverridePolicy -Identity PhishSimOverridePolicy +Get-PhishSimOverridePolicy | Remove-PhishSimOverridePolicy ``` This example removes the phishing simulation override policy. ## PARAMETERS +### -Identity +The Identity parameter specifies the phishing simulation override policy that you want to remove. You can use any value that uniquely identifies the policy. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-PhishSimOverridePolicy cmdlet to find the values. The only available policy is named PhishSimOverridePolicy. + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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. @@ -51,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -60,35 +85,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -The Identity parameter specifies the phishing simulation override policy that you want to remove. You can use any value that uniquely identifies the policy. For example: +### -DomainController +This parameter is reserved for internal Microsoft use. -- Name -- Id -- Distinguished name (DN) -- GUID +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. ```yaml -Type: PolicyIdParameter +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +In Exchange Online PowerShell, 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. + +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -102,12 +140,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Remove-PhishSimOverrideRule.md deleted file mode 100644 index 47eaf4b7e1..0000000000 --- a/exchange/exchange-ps/exchange/Remove-PhishSimOverrideRule.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-phishsimoverriderule -applicable: Security & Compliance Center -title: Remove-PhishSimOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-PhishSimOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-PhishSimOverrideRule cmdlet to remove third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-PhishSimOverrideRule [-Identity] - [-Confirm] - [-WhatIf] - [] -``` - -## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -## EXAMPLES - -### Example 1 -```powershell -Remove-PhishSimOverrideRule -Identity PhishSimOverrideRulea0eae53e-d755-4a42-9320-b9c6b55c5011 -``` - -This example remove the phishing simulation override rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the phishing simulation override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md index 28e08c58b0..45d9e9b72c 100644 --- a/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md +++ b/exchange/exchange-ps/exchange/Remove-PolicyTipConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-policytipconfig +online version: https://learn.microsoft.com/powershell/module/exchange/remove-policytipconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-PolicyTipConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-PolicyTipConfig cmdlet to remove custom data loss prevention (DLP) Policy Tips from your organization. You can't remove built-in Policy Tips. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-PolicyTipConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ This example removes all the custom Russian Policy Tips. ### -Identity The Identity parameter specifies the custom Policy Tip you want to remove. You can use any value that uniquely identifies the custom Policy Tip. For example: -- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - GUID - Distinguished name (DN) @@ -128,12 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md index 489a7a3462..56801944fd 100644 --- a/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-PowerShellVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-powershellvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/remove-powershellvirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-PowerShellVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-PowerShellVirtualDirectory cmdlet to remove existing Windows PowerShell virtual directories from Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-PowerShellVirtualDirectory [-Identity] ## DESCRIPTION Although it's possible to remove a Windows PowerShell virtual directory, we recommend that you only do so at the request of Microsoft Customer Service and Support. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,12 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md b/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md index 035f46d325..f4edc74c13 100644 --- a/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Remove-ProtectionAlert.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-protectionalert -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-protectionalert +applicable: Security & Compliance title: Remove-ProtectionAlert schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-ProtectionAlert ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-ProtectionAlert cmdlet to remove alert policies from the Microsoft 365 compliance center. +Use the Remove-ProtectionAlert cmdlet to remove alert policies from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-ProtectionAlert [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -38,7 +38,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Remove-ProtectionAlert -Identity "External User File Activities" ``` -This example removes the alert policy named External User File Activities. +This example removes the specified alert policy. ## PARAMETERS @@ -53,7 +53,7 @@ The Identity parameter specifies the alert policy that you want to remove. You c Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -72,7 +72,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -88,7 +88,7 @@ The ForceDeletion switch forces the removal of the alert policy. You don't need Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +98,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -118,12 +118,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolder.md b/exchange/exchange-ps/exchange/Remove-PublicFolder.md index ff7cfa951a..036d6a15da 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-publicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-PublicFolder schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Remove-PublicFolder cmdlet to remove an existing public folder. The Remove-PublicFolder cmdlet removes the public folder data from all servers in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Remove-PublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -126,7 +126,9 @@ Accept wildcard characters: False ``` ### -Recurse -The Recurse switch specifies whether all subfolders of the specified folder should be removed. If the Recurse switch isn't specified and the public folder has subfolders, the command doesn't run and an error message is returned. +The Recurse switch specifies whether all subfolders of the specified folder should also be removed. You don't need to specify a value with this switch. + +If you don't use this switch and the public folder has subfolders, the command doesn't run and an error message is returned. ```yaml Type: SwitchParameter @@ -187,12 +189,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md b/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md index 3d344e8f07..b1b0afb2e2 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderAdministrativePermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-publicfolderadministrativepermission +online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolderadministrativepermission applicable: Exchange Server 2010 title: Remove-PublicFolderAdministrativePermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-PublicFolderAdministrativePermission cmdlet to remove administrative permissions for a public folder or a public folder hierarchy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +47,7 @@ Remove-PublicFolderAdministrativePermission [[-Identity] -Acces ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,7 +114,12 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the user principal name (UPN), domain\\user, or alias of the user whose permissions are being removed. +The User parameter specifies the user whose permissions are being removed. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. ```yaml Type: PublicFolderUserIdParameter @@ -212,12 +217,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md index 1790ac1289..1da34f3a54 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-publicfolderdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfolderdatabase applicable: Exchange Server 2010 title: Remove-PublicFolderDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-PublicFolderDatabase cmdlet to delete public folder databases. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Remove-PublicFolderDatabase [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -Removing a public folder database can have a broad range of serious consequences. (This is particularly true when removing the last public folder database in the organization.) For more information, see [Remove Public Folder Databases](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/dd876883(v=exchg.141)). +Removing a public folder database can have a broad range of serious consequences. (This is particularly true when removing the last public folder database in the organization.) For more information, see [Remove Public Folder Databases](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd876883(v=exchg.141)). ## EXAMPLES @@ -101,7 +101,7 @@ Accept wildcard characters: False ``` ### -RemoveLastAllowed -The RemoveLastAllowed parameter specifies whether to enable removal of the last public folder database in the organization. +The RemoveLastAllowed switch allows the removal of the last public folder database in the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -137,12 +137,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md index d418944bb7..647e00554d 100644 --- a/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Remove-PublicFolderMailboxMigrationRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest +online version: https://learn.microsoft.com/powershell/module/exchange/remove-publicfoldermailboxmigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-PublicFolderMailboxMigrationRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-PublicFolderMailboxMigrationRequest cmdlet to remove individual jobs from public folder migration batches that were created by using the New-MigrationBatch cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ Remove-PublicFolderMailboxMigrationRequest -RequestGuid -RequestQueue -RequestQueue -RequestQueue + [-DomainController ] + [] +``` + +## DESCRIPTION +You can't remove the built-in quarantine policies named AdminOnlyAccessPolicy or DefaultFullAccessPolicy. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-QuarantinePolicy -Identity "Contoso Engineering" +``` + +This example removes the quarantine policy named Contoso Engineering. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the quarantine policy you want to remove. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: QuarantineTagIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/Remove-RMSTrustedPublishingDomain.md deleted file mode 100644 index 4873a615e3..0000000000 --- a/exchange/exchange-ps/exchange/Remove-RMSTrustedPublishingDomain.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-rmstrustedpublishingdomain -applicable: Exchange Online -title: Remove-RMSTrustedPublishingDomain -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-RMSTrustedPublishingDomain - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Remove-RMSTrustedPublishingDomain cmdlet to remove an existing trusted publishing domain (TPD) from your organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-RMSTrustedPublishingDomain [-Identity] - [-Confirm] - [-Force] - [-WhatIf] - [] -``` - -## DESCRIPTION -A trusted publishing domain contains the settings needed to use Rights Management Services (RMS) features in your organization. When you delete a trusted publishing domain, all existing content that's protected by the RMS templates in the trusted publishing domain becomes unreadable. Instead of deleting the trusted publishing domain, you can archive the RMS templates using the Set-RMSTemplate cmdlet. Archiving the RMS template prevents future use for encryption, but allows access to existing rights-protected content. - -If you delete the only trusted publishing domain, all RMS features are disabled in the organization. If multiple trusted publishing domains exist in your organization, you can't delete the default trusted publishing domain. You must first designate another trusted publishing domain as the default. You can change the default trusted publishing domain using the Set-RMSTrustedPublishingDomain cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -Remove-RMSTrustedPublishingDomain "Contoso TPD" -``` - -This example removes the trusted publishing domain Contoso TPD from your organization. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the trusted publishing domain. You can use any value that uniquely identifies the trusted publishing domain, for example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: RmsTrustedPublishingDomainIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -The Force parameter forces the command to execute without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md b/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md index 9446e56ba4..16d1194f04 100644 --- a/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Remove-ReceiveConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-receiveconnector +online version: https://learn.microsoft.com/powershell/module/exchange/remove-receiveconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-ReceiveConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ReceiveConnector cmdlet to remove Receive connectors from Mailbox servers and Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-ReceiveConnector [-Identity] ## DESCRIPTION Removing a Receive connector from the server might affect mail flow throughout the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,12 +123,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md b/exchange/exchange-ps/exchange/Remove-RecipientPermission.md index c032a82458..2b1a383994 100644 --- a/exchange/exchange-ps/exchange/Remove-RecipientPermission.md +++ b/exchange/exchange-ps/exchange/Remove-RecipientPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-recipientpermission +online version: https://learn.microsoft.com/powershell/module/exchange/remove-recipientpermission applicable: Exchange Online title: Remove-RecipientPermission schema: 2.0.0 @@ -16,15 +16,18 @@ This cmdlet is available only in the cloud-based service. Use the Remove-RecipientPermission cmdlet to remove SendAs permission from users in a cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Remove-RecipientPermission [-Identity] -AccessRights -Trustee [-Confirm] + [-Deny] + [-MultiTrustees ] + [-SkipDomainValidationForMailContact] + [-SkipDomainValidationForMailUser] + [-SkipDomainValidationForSharedMailbox] [-WhatIf] [] ``` @@ -32,7 +35,7 @@ Remove-RecipientPermission [-Identity] -AccessRights -LabelName - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -{{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -ItemUrl -{{ Fill ItemUrl Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LabelName -{{ Fill LabelName Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-RemoteDomain.md b/exchange/exchange-ps/exchange/Remove-RemoteDomain.md index 6bf9cb9896..bc7601b802 100644 --- a/exchange/exchange-ps/exchange/Remove-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Remove-RemoteDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-remotedomain +online version: https://learn.microsoft.com/powershell/module/exchange/remove-remotedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-RemoteDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-RemoteDomain cmdlet to remove a remote domain. When you remove a remote domain, the remote domain object is deleted. Removing a remote domain doesn't disable mail flow to that domain. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-RemoteDomain [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md b/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md index 9cf27deba3..1795e792f9 100644 --- a/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Remove-RemoteMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-remotemailbox +online version: https://learn.microsoft.com/powershell/module/exchange/remove-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-RemoteMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-RemoteMailbox cmdlet to remove a mail-enabled user in the on-premises Active Directory and the associated mailbox in the cloud-based service. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ With the Remove-RemoteMailbox cmdlet, you can remove an on-premises mail-enabled Directory synchronization must be configured correctly for a mailbox to be removed from the service. Removal of the mailbox from the service isn't immediate and depends on the directory synchronization schedule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,9 +109,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -130,7 +130,9 @@ Accept wildcard characters: False ``` ### -IgnoreLegalHold -The IgnoreLegalHold switch specifies whether to ignore the legal hold status of the remote user. This switch removes the instance of the remote object in the on-premises organization, and the request to remove the mailbox is synchronized to the cloud. The Azure AD object is removed, but if the mailbox is on hold, the mailbox is converted into an inactive mailbox and remains on hold. +The IgnoreLegalHold switch ignores the legal hold status of the remote user. You don't need to specify a value with this switch. + +This switch removes the instance of the remote object in the on-premises organization, and the request to remove the mailbox is synchronized to the cloud. The Microsoft Entra object is removed, but if the mailbox is on hold, the mailbox is converted into an inactive mailbox and remains on hold. ```yaml Type: SwitchParameter @@ -166,12 +168,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md new file mode 100644 index 0000000000..bdcd81de21 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ReportSubmissionPolicy.md @@ -0,0 +1,68 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-reportsubmissionpolicy +applicable: Exchange Online +title: Remove-ReportSubmissionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ReportSubmissionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ReportSubmissionPolicy cmdlet to remove the report submission policy from your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ReportSubmissionPolicy [-Identity] [] +``` + +## DESCRIPTION +There's only one report submission policy in an organization, and it's named DefaultReportSubmissionPolicy. You can remove the policy and then use the New-ReportSubmissionPolicy cmdlet to recreate it with the default settings. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy +``` + +This example removes the report submission policy from your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission policy that you want to remove. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md new file mode 100644 index 0000000000..7c7b4a7d97 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-ReportSubmissionRule.md @@ -0,0 +1,106 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/remove-reportsubmissionrule +applicable: Exchange Online +title: Remove-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Remove-ReportSubmissionRule cmdlet to remove the report submission rule from your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-ReportSubmissionRule [-Identity] + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +To disable the report submission rule without deleting it, use the Disable-ReportSubmissionRule cmdlet. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ReportSubmissionRule -Identity DefaultReportSubmissionRule +``` + +This example removes the report submission rule from your organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to remove. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md b/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md index 8b05bc305b..6b01e58449 100644 --- a/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md +++ b/exchange/exchange-ps/exchange/Remove-ResubmitRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-resubmitrequest +online version: https://learn.microsoft.com/powershell/module/exchange/remove-resubmitrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-ResubmitRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ResubmitRequest cmdlet to remove requests to replay redundant copies of messages from Safety Net after a mailbox database recovery. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-ResubmitRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -128,12 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md index 30eacbbd5d..586520eb81 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentioncompliancepolicy +applicable: Security & Compliance title: Remove-RetentionCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-RetentionCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-HoldCompliancePolicy cmdlet to remove retention policies from the Microsoft 365 compliance center. This cmdlet also removes the corresponding retention rule. +Use the Remove-RetentionCompliancePolicy cmdlet to remove retention policies from the Microsoft Purview compliance portal. This cmdlet also removes the corresponding retention rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,14 +24,13 @@ For information about the parameter sets in the Syntax section below, see [Excha Remove-RetentionCompliancePolicy [-Identity] [-Confirm] [-ForceDeletion] + [-PriorityCleanup] [-WhatIf] [] ``` ## DESCRIPTION -New policies are not valid and will not be applied until a retention rule is added to the policy. In addition, at least one location parameter must be defined to create a retention policy. - -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -55,7 +54,7 @@ The Identity parameter specifies the retention policy that you want to remove. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -74,7 +73,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +83,29 @@ Accept wildcard characters: False ``` ### -ForceDeletion -The ForceDeletion switch forces the removal of the retention policy. You don't need to specify a value with this switch. +The ForceDeletion switch forces the removal of the policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +115,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -120,12 +135,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md index 121e290c1d..fd33677240 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentioncompliancerule +applicable: Security & Compliance title: Remove-RetentionComplianceRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-RetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-RetentionComplianceRule cmdlet to remove retention rules from the Microsoft 365 compliance center. +Use the Remove-RetentionComplianceRule cmdlet to remove retention rules from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Remove-RetentionComplianceRule [-Identity] [-Confirm] [-ForceDeletion] + [-PriorityCleanup] [-WhatIf] [] ``` @@ -31,7 +32,7 @@ Remove-RetentionComplianceRule [-Identity] ## DESCRIPTION Removing a retention rule causes the release of all Exchange mailbox and SharePoint site retentions that are associated with the rule. Removing a retention rule also causes the corresponding retention policy to become invalid, so you should remove it by using the Remove-RetentionCompliancePolicy cmdlet. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -55,7 +56,7 @@ The Identity parameter specifies the retention rule to remove. You can use any v Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -74,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -84,13 +85,29 @@ Accept wildcard characters: False ``` ### -ForceDeletion -The ForceDeletion switch forces the removal of the retention rule. You don't need to specify a value with this switch. +The ForceDeletion switch forces the removal of the rule. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -100,13 +117,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -120,12 +137,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md b/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md index 7b1660f580..3606e9995c 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-retentionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentionpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-RetentionPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-RetentionPolicy cmdlet to remove a retention policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Retention policies are used to apply message retention settings to folders and i If you remove a retention policy that's assigned to users and they don't have another retention policy assigned, messages in those mailboxes may never expire. This may be a violation of the organization's messaging retention policies. When you attempt to remove a policy that's assigned to users, Microsoft Exchange displays a confirmation message indicating that the policy is assigned to users. Note that this message is in addition to the confirmation prompt displayed when removing a retention policy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -115,7 +115,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to override the confirmation prompt that appears when removing a retention policy that's assigned to users. Removing a policy that's assigned to users results in those users not having any retention policy. You don't have to specify a value with the Force switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you remove a retention policy that's assigned to users. Removing a policy that's assigned to users results in those users not having any retention policy. ```yaml Type: SwitchParameter @@ -151,12 +153,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md index f1d4188e2a..03f3e9a59f 100644 --- a/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/Remove-RetentionPolicyTag.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-retentionpolicytag +online version: https://learn.microsoft.com/powershell/module/exchange/remove-retentionpolicytag applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-RetentionPolicyTag schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-RetentionPolicyTag cmdlet to remove a retention tag. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,9 +33,9 @@ Retention tags are added to a retention policy, which is applied to a mailbox. When you use the Remove-RetentionPolicyTag cmdlet to remove a retention tag, it removes the tag definition stored in Active Directory. The next time the Managed Folder Assistant runs, it processes all items that have the removed tag applied and restamps them. Depending on the number of mailboxes and messages, this process may result in significant resource consumption on all Mailbox servers that contain mailboxes with a retention policy that includes the removed tag. -For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). +For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md index 08f12db972..30fc9c2297 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-RoleAssignmentPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-roleassignmentpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-roleassignmentpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-RoleAssignmentPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-RoleAssignmentPolicy cmdlet to remove existing management role assignment policies from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,17 +35,20 @@ The assignment policy you want to remove can't be assigned to any mailboxes or m - If the assignment policy is the default assignment policy, use the Set-RoleAssignmentPolicy cmdlet to select a new default assignment policy. You don't need to do this if you're removing the last assignment policy. - Use the Remove-ManagementRoleAssignment cmdlet to remove any management role assignments assigned to the policy. -For more information about assignment policies, see [Understanding management role assignment policies](https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). +For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"} + Get-Mailbox | Where {$_.RoleAssignmentPolicy -Eq "End User"} | Set-Mailbox -RoleAssignmentPolicy "Seattle End User" + Get-ManagementRoleAssignment -RoleAssignee "End User" | Remove-ManagementRoleAssignment + Remove-RoleAssignmentPolicy "End User" ``` @@ -59,7 +62,7 @@ Remove all management role assignments that are assigned to the End User policy. Remove the End User role assignment policy. -For more information about the Where cmdlet and pipelining, see [Working with command output](https://docs.microsoft.com/exchange/working-with-command-output-exchange-2013-help) and [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). +For more information about the Where cmdlet and pipelining, see [Working with command output](https://learn.microsoft.com/exchange/working-with-command-output-exchange-2013-help) and [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines). ## PARAMETERS @@ -139,12 +142,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroup.md b/exchange/exchange-ps/exchange/Remove-RoleGroup.md index a25ece6754..ed3cddf995 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Remove-RoleGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-rolegroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-rolegroup +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Remove-RoleGroup schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-RoleGroup cmdlet to remove a management role group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,9 +37,9 @@ You can't remove built-in role groups. If the ManagedBy property has been populated with role group managers, the user removing the role group must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. -For more information about role groups, see [Understanding management role groups](https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). +For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,7 +66,7 @@ The Identity parameter specifies the role group to remove. If the role group nam Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -76,7 +76,12 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch enables a user who hasn't been added to the ManagedBy property to remove a role group. The user must be a member of the Organization Management role group or be assigned, either directly or indirectly, the Role Management role. +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. ```yaml Type: SwitchParameter @@ -101,7 +106,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -131,13 +136,15 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -147,7 +154,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -155,7 +162,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -169,12 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md index fb932848c0..34807f1679 100644 --- a/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md +++ b/exchange/exchange-ps/exchange/Remove-RoleGroupMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-rolegroupmember -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-rolegroupmember +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Remove-RoleGroupMember schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-RoleGroupMember cmdlet to remove a member of a management role group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,9 +36,9 @@ If the ManagedBy property has been populated with role group managers, the user If the role group is a linked role group, you can't use the Remove-RoleGroupMember cmdlet to remove members from the role group. Instead, you need to remove members from the foreign universal security group (USG) linked to the linked role group. To find the foreign USG linked to a role group, use the Get-RoleGroup cmdlet. -For more information about role groups, see [Understanding management role groups](https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). +For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,8 +60,8 @@ After you've verified that the correct members will be removed the role group, r For more information about pipelining, and the WhatIf parameter, see the following topics: -- [About Pipelines](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) -- WhatIf, Confirm and ValidateOnly switches +- [About Pipelines](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_pipelines) +- [WhatIf, Confirm and ValidateOnly switches](https://learn.microsoft.com/exchange/whatif-confirm-and-validateonly-switches-exchange-2013-help) ### Example 3 ```powershell @@ -79,7 +79,7 @@ The Identity parameter specifies the role group that you want to remove a member Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -93,7 +93,7 @@ The Member parameter specifies who to remove from the role group. You can specif - Mailbox users - Mail users -- Mail-enabled security groups (don't use in Security & Compliance Center PowerShell) +- Mail-enabled security groups - Security groups (on-premises Exchange only) You can use any value that uniquely identifies the user or group. For example: @@ -113,7 +113,7 @@ You can use any value that uniquely identifies the user or group. For example: Type: SecurityPrincipalIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -123,7 +123,12 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch enables a user who hasn't been added to the ManagedBy property to remove a member from a role group. The user must be a member of the Organization Management role group or be assigned, either directly or indirectly, the Role Management role. +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. ```yaml Type: SwitchParameter @@ -148,7 +153,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -176,7 +181,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -184,7 +189,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -198,12 +203,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md index 56bd61965b..e34b39e341 100644 --- a/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md +++ b/exchange/exchange-ps/exchange/Remove-RoutingGroupConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-routinggroupconnector +online version: https://learn.microsoft.com/powershell/module/exchange/remove-routinggroupconnector applicable: Exchange Server 2010 title: Remove-RoutingGroupConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-RoutingGroupConnector cmdlet to remove a routing group connector between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ A routing group connector is used to send and receive messages between computers The Exchange 2003 servers used as source servers for the specified routing group connector are automatically removed from the ExchangeLegacyInterop universal security group. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md b/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md index 7fbf264846..869e6560c5 100644 --- a/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md +++ b/exchange/exchange-ps/exchange/Remove-RpcClientAccess.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-rpcclientaccess +online version: https://learn.microsoft.com/powershell/module/exchange/remove-rpcclientaccess applicable: Exchange Server 2010 title: Remove-RpcClientAccess schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Remove-RpcClientAccess cmdlet to remove the configuration information that allows RPC access through the Client Access server role on Microsoft Exchange Server 2010. After you remove the configuration information, the Exchange RPC Client Access service stops and no longer starts. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-RPCClientAccess -Server ## DESCRIPTION Disabling RPC client access on a server blocks all RPC access through the specified Client Access server. Therefore, RPC clients (for example, clients running Microsoft Office Outlook 2007) with mailboxes on any mailbox databases configured to use the specified Client Access server won't be able to connect. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -121,12 +121,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md index 2797c7974d..857607a82b 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentpolicy +applicable: Exchange Online title: Remove-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-SafeAttachmentPolicy cmdlet to remove safe attachment policies from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +29,9 @@ Remove-SafeAttachmentPolicy [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,7 +57,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -78,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -88,13 +86,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -110,7 +110,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -124,12 +124,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md index 910272d44a..e442e79efb 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Remove-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-safeattachmentrule +applicable: Exchange Online title: Remove-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-SafeAttachmentRule cmdlet to remove safe attachment rules from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +28,9 @@ Remove-SafeAttachmentRule [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -77,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -107,12 +105,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md index acfdf5f4c4..287856fcc5 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SafeLinksPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-safelinkspolicy +applicable: Exchange Online title: Remove-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-SafeLinksPolicy cmdlet to remove Safe Links policies from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +33,7 @@ You can't remove the default Safe Links policy (the policy where the IsDefault p Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,7 +59,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -80,7 +78,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -90,13 +88,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -112,7 +112,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -126,12 +126,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md index f0279ccb88..472e9e9324 100644 --- a/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Remove-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-safelinksrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-safelinksrule +applicable: Exchange Online title: Remove-SafeLinksRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Remove-SafeLinksRule cmdlet to remove Safe Links rules from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Remove-SafeLinksRule [-Identity] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +56,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -77,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -93,7 +91,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -107,12 +105,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md index 9a710f3808..b15bec5d2b 100644 --- a/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md +++ b/exchange/exchange-ps/exchange/Remove-SearchDocumentFormat.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-searchdocumentformat +online version: https://learn.microsoft.com/powershell/module/exchange/remove-searchdocumentformat applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-SearchDocumentFormat schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-SearchDocumentFormat cmdlet to remove a format-specific filter from those used by Exchange search. Only filters added with New-SearchDocumentFormat can be removed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-SearchDocumentFormat [-Identity] ## DESCRIPTION After running the Remove-SearchDocumentFormat cmdlet, your must run the following cmdlet to restart the search service. There will be a brief search outage. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,12 +123,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md index 2c690573df..116c6c915a 100644 --- a/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SecOpsOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-secopsoverridepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-secopsoverridepolicy +applicable: Exchange Online title: Remove-SecOpsOverridePolicy schema: 2.0.0 author: chrisda @@ -12,23 +12,25 @@ ms.reviewer: # Remove-SecOpsOverridePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -Use the Remove-SecOpsOverridePolicy cmdlet to remove SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). +Use the Remove-SecOpsOverridePolicy cmdlet to remove SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Remove-SecOpsOverridePolicy [-Identity] [-Confirm] + [-DomainController ] + [-ForceDeletion] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,7 +55,7 @@ The Identity parameter specifies the SecOps override policy that you want to rem Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: True Position: 0 @@ -72,7 +74,39 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ForceDeletion +The ForceDeletion switch forces the removal of the SecOps override policy. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -82,13 +116,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -102,12 +136,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Remove-SecOpsOverrideRule.md deleted file mode 100644 index 784b1d0299..0000000000 --- a/exchange/exchange-ps/exchange/Remove-SecOpsOverrideRule.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-secopsoverriderule -applicable: Security & Compliance Center -title: Remove-SecOpsOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Remove-SecOpsOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Remove-SecOpsOverrideRule cmdlet to remove SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Remove-SecOpsOverrideRule [-Identity] - [-Confirm] - [-WhatIf] - [] -``` - -## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -## EXAMPLES - -### Example 1 -```powershell -Remove-SecOpsOverrideRule -Identity SecOpsOverrideRule6fed4b63-3563-495d-a481-b24a311f8329 -``` - -This example removes the SecOps mailbox override rule. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the SecOps override rule that you want to remove. You can use any value that uniquely identifies the rule. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: PolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SendConnector.md b/exchange/exchange-ps/exchange/Remove-SendConnector.md index 1ad3a03e93..e1ce45ac63 100644 --- a/exchange/exchange-ps/exchange/Remove-SendConnector.md +++ b/exchange/exchange-ps/exchange/Remove-SendConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-sendconnector +online version: https://learn.microsoft.com/powershell/module/exchange/remove-sendconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-SendConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-SendConnector cmdlet to delete a Send connector. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Remove-SendConnector cmdlet deletes the object and the configuration setting Although a Send connector is configured locally in the Transport service on a Mailbox server or on an Edge server, deleting a Send connector may affect mail flow throughout the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md b/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md index a6a322ed35..dff6213508 100644 --- a/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md +++ b/exchange/exchange-ps/exchange/Remove-ServerMonitoringOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-servermonitoringoverride +online version: https://learn.microsoft.com/powershell/module/exchange/remove-servermonitoringoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-ServerMonitoringOverride schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-ServerMonitoringOverride cmdlet to remove a managed availability local server override that has been configured for a probe, monitor or responder. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Remove-ServerMonitoringOverride [-Identity] -ItemType + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Remove-ServicePrincipal -Identity 7c7599b2-23af-45e3-99ff-0025d148e929 +``` + +This example removes the specified service principal. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to remove. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ObjectId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SettingOverride.md b/exchange/exchange-ps/exchange/Remove-SettingOverride.md index 678a2ebf44..c3488fbb4e 100644 --- a/exchange/exchange-ps/exchange/Remove-SettingOverride.md +++ b/exchange/exchange-ps/exchange/Remove-SettingOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-settingoverride +online version: https://learn.microsoft.com/powershell/module/exchange/remove-settingoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-SettingOverride schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-SettingOverride cmdlet to remove setting overrides from Active Directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Remove-SettingOverride [-Identity] ## DESCRIPTION Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-specific, and they persist in Active Directory across Exchange Cumulative Updates (CUs). Exchange customizations in web.config or exe.config XML application configuration files are server-specific, and they're lost when you install the next Exchange CU. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SharingPolicy.md b/exchange/exchange-ps/exchange/Remove-SharingPolicy.md index 91f228c9f2..ac9dbb8159 100644 --- a/exchange/exchange-ps/exchange/Remove-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SharingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-sharingpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-sharingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-SharingPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-SharingPolicy cmdlet to remove a sharing policy. Before you can remove a sharing policy, you must ensure that no mailbox users are provisioned to use that policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-SharingPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -128,12 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md index 39e953cf12..3b226be32b 100644 --- a/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-SiteMailboxProvisioningPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-sitemailboxprovisioningpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-sitemailboxprovisioningpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-SiteMailboxProvisioningPolicy schema: 2.0.0 @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). - Use the Remove-SiteMailboxProvisioningPolicy cmdlet to remove site mailbox provisioning policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Remove-SiteMailboxProvisioningPolicy [-Identity] ## DESCRIPTION You can't delete the default site mailbox provisioning policy. You need to create a new default policy by using the New-SiteMailboxProvisioningPolicy cmdlet or designate an existing policy as the default policy by using the Set-SiteMailboxProvisioningPolicy cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-StoreMailbox.md b/exchange/exchange-ps/exchange/Remove-StoreMailbox.md index 1ee1fe7c23..4faccccab2 100644 --- a/exchange/exchange-ps/exchange/Remove-StoreMailbox.md +++ b/exchange/exchange-ps/exchange/Remove-StoreMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-storemailbox +online version: https://learn.microsoft.com/powershell/module/exchange/remove-storemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-StoreMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-StoreMailbox cmdlet to purge the mailbox and all of its message content from the mailbox database. This results in permanent data loss for the mailbox being purged. You can only run this cmdlet against disconnected or soft-deleted mailboxes. Running this command against an active mailbox fails, and you receive an error. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ A mailbox is marked as Disabled immediately after the Disable-Mailbox or Remove- To view disabled mailboxes, run the Get-MailboxStatistics cmdlet against a database using the property DisconnectReason with a value of Disabled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -160,12 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md index 8a07eb89b5..1bbb2eaf31 100644 --- a/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Remove-SupervisoryReviewPolicyV2.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-supervisoryreviewpolicyv2 -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-supervisoryreviewpolicyv2 +applicable: Security & Compliance title: Remove-SupervisoryReviewPolicyV2 schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-SupervisoryReviewPolicyV2 ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-SupervisoryReviewPolicyV2 cmdlet to remove supervisory review policies from the Microsoft 365 compliance center. +Use the Remove-SupervisoryReviewPolicyV2 cmdlet to remove supervisory review policies from the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-SupervisoryReviewPolicyV2 [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -53,7 +53,7 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -72,7 +72,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -88,7 +88,7 @@ The ForceDeletion switch forces the removal of the policy. You don't need to spe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +98,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -118,12 +118,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SweepRule.md b/exchange/exchange-ps/exchange/Remove-SweepRule.md index 6d91163176..5a20fe05fc 100644 --- a/exchange/exchange-ps/exchange/Remove-SweepRule.md +++ b/exchange/exchange-ps/exchange/Remove-SweepRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-sweeprule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-SweepRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-SweepRule cmdlet to remove Sweep rules from mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Remove-SweepRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -155,12 +155,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md b/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md index 6671dbd9c6..b48470c51b 100644 --- a/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Remove-SyncMailPublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-syncmailpublicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/remove-syncmailpublicfolder applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Remove-SyncMailPublicFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. The Remove-SyncMailPublicFolder cmdlet is used by the Sync-MailPublicFolders.ps1 script to remove mail-enabled public folder recipient objects from Exchange Online (the script synchronizes mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-SyncMailPublicFolder [-Identity] ## DESCRIPTION This cmdlet is only used by the Sync-MailPublicFolders.ps1 script. Don't run this cmdlet in the Exchange Management Shell or in Exchange Online PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,12 +123,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-SystemMessage.md b/exchange/exchange-ps/exchange/Remove-SystemMessage.md index c3ff6cbacd..c61753f2b5 100644 --- a/exchange/exchange-ps/exchange/Remove-SystemMessage.md +++ b/exchange/exchange-ps/exchange/Remove-SystemMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-systemmessage +online version: https://learn.microsoft.com/powershell/module/exchange/remove-systemmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-SystemMessage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-SystemMessage cmdlet to remove custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Remove-SystemMessage [-Identity] ## DESCRIPTION You can't remove a default system message that's included with Exchange. When you remove a custom system message, the message text reverts to the text in the corresponding system message (if any) that's included with Exchange. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -52,7 +52,7 @@ This example removes the specified custom quota message (combination of language ## PARAMETERS ### -Identity -TheIdentity parameter specifies the custom system message that you want to remove. You can use any value that uniquely identifies the system message. For example: +The Identity parameter specifies the custom system message that you want to remove. You can use any value that uniquely identifies the system message. For example: - Identity - Distinguished name (DN) @@ -61,61 +61,47 @@ TheIdentity parameter specifies the custom system message that you want to remov The identity value of a system message uses one of these formats: - System messages for enhanced status codes: `Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. -- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailBox`. +- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailbox`. -Language: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +\: For the list of supported language codes, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). -DSNCode: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system code values that are currently used by custom system messages, run the command Get-SystemMessage. +\: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command `Get-SystemMessage`. To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. -QuotaMessageType: Valid value are: +\: Valid value are: Mailbox size quotas: -ProhibitSendReceiveMailBox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - -ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. - -WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - -WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. +- ProhibitSendReceiveMailbox: A mailbox exceeds its ProhibitSendReceiveQuota limit. +- ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. +- WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. +- WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. Public folder size quotas: -ProhibitPostPublicFolder: A public folder exceeds its ProhibitPostQuota limit. - -WarningPublicFolder: A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured. - -WarningPublicFolderUnlimitedSize: A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured. +- ProhibitPostPublicFolder: A public folder exceeds its ProhibitPostQuota limit. +- WarningPublicFolder: A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured. +- WarningPublicFolderUnlimitedSize: A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured. Maximum number of messages in a mailbox folder: -ProhibitReceiveMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit. - -WarningMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured. - -WarningMailboxMessagesPerFolderUnlimitedCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured. +- ProhibitReceiveMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit. +- WarningMailboxMessagesPerFolderCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured. +- WarningMailboxMessagesPerFolderUnlimitedCount: A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured. Maximum number of subfolders in a mailbox folder: -ProhibitReceiveFolderHierarchyChildrenCountCount: A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit. - -WarningFolderHierarchyChildrenCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured. - -WarningFolderHierarchyChildrenUnlimitedCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured. - -ProhibitReceiveFoldersCount: A mailbox exceeds its FoldersCountReceiveQuota limit. - -WarningFoldersCount: A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured. - -WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured. +- ProhibitReceiveFolderHierarchyChildrenCountCount: A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit. +- WarningFolderHierarchyChildrenCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured. +- WarningFolderHierarchyChildrenUnlimitedCount: A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured. +- ProhibitReceiveFoldersCount: A mailbox exceeds its FoldersCountReceiveQuota limit. +- WarningFoldersCount: A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured. +- WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured. Maximum number of levels (depth) in a mailbox folder: -ProhibitReceiveFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit. - -WarningFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured. - -WarningFolderHierarchyDepthUnlimited: : A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured. +- ProhibitReceiveFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit. +- WarningFolderHierarchyDepth: A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured. +- WarningFolderHierarchyDepthUnlimited: : A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured. ```yaml Type: SystemMessageIdParameter @@ -188,12 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md index 29387ce7c0..131df513a6 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListItems.md @@ -1,38 +1,43 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistitems -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistitems +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Remove-TenantAllowBlockListItems schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: -ROBOTS: NOINDEX --- # Remove-TenantAllowBlockListItems ## SYNOPSIS -**Note**: The features described in this topic are in Preview, are subject to change, and are not available in all organizations. - This cmdlet is available only in the cloud-based service. -Use the Remove-TenantAllowBlockListItems cmdlet to remove entries from the Tenant Allow/Block List in the Microsoft 365 Defender portal. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Remove-TenantAllowBlockListItems cmdlet to remove entries from the Tenant Allow/Block List in the Microsoft Defender portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Entries +``` +Remove-TenantAllowBlockListItems -Entries -ListType + [-ListSubType ] + [-OutputJson] + [] +``` + +### Ids ``` Remove-TenantAllowBlockListItems -Ids -ListType + [-ListSubType ] [-OutputJson] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -41,22 +46,56 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Remove-TenantAllowBlockListItems -ListType Url -Ids "RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0l" ``` -This example removes the specified URL entry from the Allow/Block List. +This example removes the specified URL entry from the Tenant Allow/Block List. + +### Example 2 +```powershell +Remove-TenantAllowBlockListItems -ListType Url -ListSubType AdvancedDelivery -Entries *.fabrikam.com +``` + +This example removes the URL allow entry for the specified third-party phishing simulation URL. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). ## PARAMETERS +### -Entries +The Entries parameter specifies the entries that you want to remove based on the ListType parameter value. Valid values are: + +- FileHash: The exact SHA256 file hash value. +- Sender domains and email addresses: The exact domain or email address value. +- Url: The exact URL value. +- IP: IPv6 addresses only. Single IPv6 addresses in colon-hexadecimal or zero-compression format or CIDR IPv6 ranges from 1 to 128. + +This value is shown in the Value property of the entry in the output of the Get-TenantAllowBlockListItems cmdlet. + +You can't mix value types (sender, URL, file, or IP address) or allow and block actions in the same command. + +You can't use this parameter with the Ids parameter. + +```yaml +Type: String[] +Parameter Sets: Entries +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Ids -The Ids parameter specifies the entry that you want to modify. To find this value, use the Get-TenantAllowBlockListItems cmdlet and the Entry property value (a URL or a file hash). +The Ids parameter specifies the entries that you want to remove. This value is shown in the Identity property in the output of the Get-TenantAllowBlockListItems cmdlet. An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. -You can specify multiple values separated by commas. +You can't use this parameter with the Entries parameter. ```yaml Type: String[] -Parameter Sets: (All) +Parameter Sets: Ids Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -66,16 +105,18 @@ Accept wildcard characters: False ``` ### -ListType -The ListType parameter specifies the type of entry to remove. Valid values are: +The ListType parameter specifies the type of entry that you want to remove. Valid values are: - FileHash +- Sender - Url +- IP ```yaml Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -84,6 +125,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ListSubType +The ListSubType specifies further specifies the type of entry that you want to remove. Valid values are: + +- AdvancedDelivery: Use this value for phishing simulation URLs. +- Tenant: This is the default value. + +```yaml +Type: ListSubType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OutputJson The OutputJson switch specifies whether to return all entries in a single JSON value. You don't need to specify a value with this switch. @@ -93,7 +153,7 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -107,12 +167,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md index 3f4cc8ec85..dffc5da8d0 100644 --- a/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/Remove-TenantAllowBlockListSpoofItems.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistspoofitems -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/remove-tenantallowblocklistspoofitems +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Remove-TenantAllowBlockListSpoofItems schema: 2.0.0 author: chrisda @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-TenantAllowBlockListSpoofItems cmdlet to remove spoof entries from the Tenant Allow/Block List. +Use the Remove-TenantAllowBlockListSpoofItems cmdlet to remove spoofed sender entries from the Tenant Allow/Block List. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,28 +30,27 @@ Remove-TenantAllowBlockListSpoofItems [-Identity] ## DESCRIPTION You can't remove the default client throttling policy. Also, you can't remove a policy associated with any users. For more information, see Example 2. -For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). +For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,9 +48,13 @@ This example removes the user throttling policy ClientThrottlingPolicy2. ### Example 2 ```powershell $policy = Get-ThrottlingPolicy ClientThrottlingPolicy2 + $mailboxes = Get-Mailbox | where-object {$_.ThrottlingPolicy -eq $policy.Identity} + $defaultPolicy = Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true} + foreach ($mailbox in $mailboxes) {Set-Mailbox -Identity $mailbox.Identity -ThrottlingPolicy $defaultPolicy} + Remove-ThrottlingPolicy ClientThrottlingPolicy2 ``` @@ -112,7 +116,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -148,12 +154,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-TransportRule.md b/exchange/exchange-ps/exchange/Remove-TransportRule.md index d1e1856549..110d9f1322 100644 --- a/exchange/exchange-ps/exchange/Remove-TransportRule.md +++ b/exchange/exchange-ps/exchange/Remove-TransportRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-transportrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Remove-TransportRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Remove-TransportRule cmdlet to remove transport rules (mail flow rules) from your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ On Mailbox servers, this cmdlet removes the rule from Active Directory. On an Ed To temporarily disable a transport rule without removing it, use the Disable-TransportRule cmdlet instead. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -126,12 +126,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md index 146d62c34f..902c636055 100644 --- a/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/Remove-UMAutoAttendant.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-umautoattendant +online version: https://learn.microsoft.com/powershell/module/exchange/remove-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Remove-UMAutoAttendant schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-UMAutoAttendant cmdlet to delete a Unified Messaging (UM) auto attendant. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Remove-UMAutoAttendant cmdlet deletes an existing UM auto attendant from Act After this task is completed, the UM auto attendant is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md index ad1e8e7783..85003d4509 100644 --- a/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/exchange/Remove-UMCallAnsweringRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-umcallansweringrule +online version: https://learn.microsoft.com/powershell/module/exchange/remove-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 title: Remove-UMCallAnsweringRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-UMCallAnsweringRule cmdlet to remove an existing Unified Messaging (UM) call answering rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ The Remove-UMCallAnsweringRule cmdlet removes an existing UM call answering rule After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -155,12 +155,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-UMDialPlan.md b/exchange/exchange-ps/exchange/Remove-UMDialPlan.md index 88e1b6845a..15968a4562 100644 --- a/exchange/exchange-ps/exchange/Remove-UMDialPlan.md +++ b/exchange/exchange-ps/exchange/Remove-UMDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-umdialplan +online version: https://learn.microsoft.com/powershell/module/exchange/remove-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Remove-UMDialPlan schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-UMDialPlan cmdlet to delete an existing Unified Messaging (UM) dial plan. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Remove-UMDialPlan cmdlet deletes an existing UM dial plan from Active Direct After this task is completed, the UM dial plan is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md b/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md index 9e2c682fd3..0923af3a69 100644 --- a/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md +++ b/exchange/exchange-ps/exchange/Remove-UMHuntGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-umhuntgroup +online version: https://learn.microsoft.com/powershell/module/exchange/remove-umhuntgroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Remove-UMHuntGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-UMHuntGroup cmdlet to remove and delete an existing Unified Messaging (UM) hunt group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Remove-UMHuntGroup cmdlet deletes an existing UM hunt group from Active Dire After this task is completed, the UM hunt group is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-UMIPGateway.md b/exchange/exchange-ps/exchange/Remove-UMIPGateway.md index 351de2e8a9..e19873e3a1 100644 --- a/exchange/exchange-ps/exchange/Remove-UMIPGateway.md +++ b/exchange/exchange-ps/exchange/Remove-UMIPGateway.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-umipgateway +online version: https://learn.microsoft.com/powershell/module/exchange/remove-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Remove-UMIPGateway schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-UMIPGateway cmdlet to delete a Unified Messaging (UM) IP gateway. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ The Remove-UMIPGateway cmdlet should be run only by an administrator who fully u After this task is completed, the UM IP gateway is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md index be035df72e..56d19d3378 100644 --- a/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-UMMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-ummailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/remove-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Remove-UMMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-UMMailboxPolicy cmdlet to delete a Unified Messaging (UM) mailbox policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ The Remove-UMMailboxPolicy cmdlet deletes or removes a UM mailbox policy. If the After this task is completed, the UM mailbox policy is removed from Active Directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md index 0044769d59..ed810f1d9c 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedAuditLogRetentionPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-unifiedauditlogretentionpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedauditlogretentionpolicy +applicable: Security & Compliance title: Remove-UnifiedAuditLogRetentionPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-UnifiedAuditLogRetentionPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-UnifiedAuditLogRetentionPolicy cmdlet to delete audit log retention policies from the Microsoft 365 Defender portal or the Microsoft 365 compliance center. +Use the Remove-UnifiedAuditLogRetentionPolicy cmdlet to delete audit log retention policies from the Microsoft Defender portal or the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Remove-UnifiedAuditLogRetentionPolicy [-Identity] ``` ## DESCRIPTION -It might take up to 30 minutes for the policy to be completely removed. For more information, see [Manage audit log retention policies](https://docs.microsoft.com/microsoft-365/compliance/audit-log-retention-policies). +It might take up to 30 minutes for the policy to be completely removed. For more information, see [Manage audit log retention policies](https://learn.microsoft.com/purview/audit-log-retention-policies). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -49,14 +49,14 @@ This example deletes the audit log retention policy named "SearchQueryPerformed The Identity parameter specifies the audit log retention policy that you want to delete. You can use any value that uniquely identifies the policy. For example: - Name -- Distingished name (DN) +- Distinguished name (DN) - GUID ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -75,7 +75,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -91,7 +91,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -107,7 +107,7 @@ The ForceDeletion switch forces the removal of the policy. You don't need to spe Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -117,13 +117,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -137,12 +137,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md index 506222bace..8c186032fb 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-unifiedgroup -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedgroup +applicable: Exchange Online, Exchange Online Protection title: Remove-UnifiedGroup schema: 2.0.0 author: chrisda @@ -16,9 +16,9 @@ This cmdlet is available only in the cloud-based service. Use the Remove-UnifiedGroup cmdlet to remove Microsoft 365 Groups from your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: You can't use this cmdlet to remove Microsoft 365 Groups if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see [Delete group](https://learn.microsoft.com/graph/api/group-delete). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Remove-UnifiedGroup [-Identity] ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,7 +60,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to remove Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -79,7 +79,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -89,13 +89,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -111,7 +113,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -125,12 +127,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md index 5d65b888ae..f6ae947e09 100644 --- a/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md +++ b/exchange/exchange-ps/exchange/Remove-UnifiedGroupLinks.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-unifiedgrouplinks -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/remove-unifiedgrouplinks +applicable: Exchange Online, Exchange Online Protection title: Remove-UnifiedGroupLinks schema: 2.0.0 author: chrisda @@ -14,11 +14,12 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Remove-UnifiedGroupLinks cmdlet to remove members, owners and subscribers from Microsoft 365 Groups in your cloud-based organization. To add members, owners and subscribers, use the Add-UnifiedGroupLinks cmdlet. To modify other properties of Microsoft 365 Groups, use the Set-UnifiedGroup cmdlet. +Use the Remove-UnifiedGroupLinks cmdlet to remove members, owners, and subscribers from Microsoft 365 Groups in your cloud-based organization. To add members, owners and subscribers, use the Add-UnifiedGroupLinks cmdlet. To modify other properties of Microsoft 365 Groups, use the Set-UnifiedGroup cmdlet. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +> [!NOTE] +> You can't use this cmdlet to modify Microsoft 365 Group members, owners, or subscribers if you connect using certificate based authentication (also known as CBA or app-only authentication for unattended scripts) or Azure managed identity. You can use Microsoft Graph instead. For more information, see [Group resource type](https://learn.microsoft.com/graph/api/resources/group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +33,7 @@ Remove-UnifiedGroupLinks [-Identity] -Links ``` ## DESCRIPTION -Use the Remove-UserPhoto cmdlet to delete the user photo currently associated with a user's account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox, both of which are deleted when you run this cmdlet. Administrators can also use the Exchange admin center (EAC) to delete user photos by accessing the user's Outlook on the web Options page. +Use the Remove-UserPhoto cmdlet to delete the user photo currently associated with a user's account. This cmdlet removes the photo from user's Exchange mailbox root. +In on-premises Exchange, it also removes the user's photo from their Active Directory account. Administrators can also use the Exchange admin center (EAC) to delete user photos by accessing the Options page in the user's mailbox in Outlook on the web. -**Note**: Changes to the user photo won't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. +**Notes**: Changes to the user photo won't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,7 +82,7 @@ The Identity parameter specifies the identity of the user. You can use any value Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -89,20 +92,20 @@ Accept wildcard characters: False ``` ### -ClearMailboxPhotoRecord -The ClearMailboxPhoto switch specifies that a deleted mailbox photo is considered blank instead of deleted. +The ClearMailboxPhoto switch specifies that a deleted mailbox photo is considered blank instead of deleted. You don't need to specify a value with this switch. By default, when a user deletes their mailbox photo, a flag is set on the mailbox that causes subsequent photo requests to: - Return a blank photo. - Prevent searching Active Directory for a photo. -Using this switch allows photo requests to search Active Directory for a photo. You don't have to specify a value with this switch. +Using this switch allows photo requests to search Active Directory for a photo. ```yaml Type: SwitchParameter Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -121,7 +124,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,8 +134,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -155,7 +156,7 @@ The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't ne Type: SwitchParameter Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -165,9 +166,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -176,7 +177,7 @@ Using the IgnoreDefaultScope switch introduces the following restrictions: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -192,7 +193,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: ClearMailboxPhoto Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -208,7 +209,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -222,12 +223,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md new file mode 100644 index 0000000000..e263889a41 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-VivaModuleFeaturePolicy.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivamodulefeaturepolicy +applicable: Exchange Online +title: Remove-VivaModuleFeaturePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-VivaModuleFeaturePolicy + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module in Viva. Once you delete a policy, the policy is permanently deleted. You cannot undo the deletion. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX +``` +Remove-VivaModuleFeaturePolicy -FeatureId -ModuleId -PolicyId + [-Confirm] + [-ResultSize ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Remove-VivaModuleFeaturePolicy cmdlet to delete an access policy for a feature in a Viva module in Viva. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role or the roles that have been assigned at the feature level to run this cmdlet. + +To learn more about assigned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management). + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Remove-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b +``` + +This example deletes the specified policy for the Reflection feature in Viva Insights. + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module that you want to remove the policy from. + +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module of the feature that you want to remove the policy from. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the policy for the feature in the Viva module that you want to remove. + +To view details about the added policies for a feature in a Viva module, refer to the Get-VivaModuleFeaturePolicy cmdlet. The details provided by the Get-VivaModuleFeaturePolicy cmdlet include the policy identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md b/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md new file mode 100644 index 0000000000..037e2a9216 --- /dev/null +++ b/exchange/exchange-ps/exchange/Remove-VivaOrgInsightsDelegatedRole.md @@ -0,0 +1,112 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/remove-vivaorginsightsdelegatedrole +title: Remove-VivaOrgInsightsDelegatedRole +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Remove-VivaOrgInsightsDelegatedRole + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module v3.7.1 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Remove-VivaOrgInsightsDelegatedRole cmdlet to remove delegate access from the specified account (the delegate) so they can't view organizational insights like the leader (the delegator). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Remove-VivaOrgInsightsDelegatedRole -Delegate -Delegator + [-ResultSize ] + [] +``` + +## DESCRIPTION +Use the Get-VivaOrgInsightsDelegatedRole cmdlet to find the Microsoft Entra ObjectId values of delegate accounts that were given the capabilities of delegator accounts. + +To run this cmdlet, you need to be a member of one of the following role groups in Microsoft Entra ID in the destination organization: + +- Global Administrator +- Insights Administrator + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Remove-VivaOrgInsightsDelegatedRole -Delegate 5eaf7164-f36f-5381-5546-dcaa1792f077 -Delegator 043f6d38-378b-7dcd-7cd8-c1a901881fa9 +``` + +This example removes the organization insights viewing capability of the specified delegator account from the specified delegate account. + +## PARAMETERS + +### -Delegate +The Delegate parameter specifies the account that can view organizational insights like the leader (the account specified by the Delegator account). + +A valid value for this parameter is the Microsoft Entra ObjectId value of the delegate account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delegator +The Delegator parameter specifies the account of the leader that can view organizational insights. This capability is delegated to the account specified by the Delegate parameter. + +A valid value for this parameter is the ObjectID value of the delegator account. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) cmdlet in Microsoft Graph PowerShell to find this value. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md index be2a8b645b..f4f42ba089 100644 --- a/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Remove-WebServicesVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-webservicesvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/remove-webservicesvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-WebServicesVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-WebServicesVirtualDirectory cmdlet to remove existing Exchange Web Services virtual directories from Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Remove-WebServicesVirtualDirectory [-Identity] ## DESCRIPTION You can remove the default Exchange Web Services virtual directory or another Exchange Web Services virtual directory. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,7 +103,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -139,12 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md index 56b99d6488..f6c5c5dddd 100644 --- a/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/exchange/Remove-X400AuthoritativeDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-x400authoritativedomain +online version: https://learn.microsoft.com/powershell/module/exchange/remove-x400authoritativedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Remove-X400AuthoritativeDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Remove-X400AuthoritativeDomain cmdlet to remove an X.400 authoritative domain. When you remove an X.400 authoritative domain, the X.400 authoritative domain object is deleted from Active Directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Remove-X400AuthoritativeDomain [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -116,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md index e5be71383f..828137cfb4 100644 --- a/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Remove-eDiscoveryCaseAdmin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/remove-ediscoverycaseadmin -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/remove-ediscoverycaseadmin +applicable: Security & Compliance title: Remove-eDiscoveryCaseAdmin schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Remove-eDiscoveryCaseAdmin ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Remove-eDiscoveryCaseAdmin cmdlet to remove an eDiscovery Administrator from the Microsoft 365 compliance center. To replace all eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. +Use the Remove-eDiscoveryCaseAdmin cmdlet to remove an eDiscovery Administrator from the Microsoft Purview compliance portal. To replace all eDiscovery Administrators, use the Update-eDiscoveryCaseAdmin cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,9 +30,9 @@ Remove-eDiscoveryCaseAdmin -User ## DESCRIPTION An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. -When you remove an eDiscovery Administrator, the user isn't removed from the eDiscovery Manager role group. +When you remove a user from the list of eDiscovery Administrators, the user isn't removed from the eDiscovery Manager role group. That means the user can still view and access the eDiscovery cases they are a member of and the eDiscovery cases they created. To remove all eDiscovery permissions, you can remove the user from the eDiscovery Manager role group by running the Remove-RoleGroupMember cmdlet. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The User parameter specifies the user that you want to remove from the list of e Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -86,13 +86,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -106,12 +106,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md b/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md index 596e0a6694..0c541d75c8 100644 --- a/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md +++ b/exchange/exchange-ps/exchange/Reset-ProvisioningCache.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/reset-provisioningcache +online version: https://learn.microsoft.com/powershell/module/exchange/reset-provisioningcache applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Reset-ProvisioningCache schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. The Reset-ProvisioningCache cmdlet clears the Windows PowerShell provisioning cache of frequently used Active Directory objects. This cmdlet is only used for diagnostic purposes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,7 +46,7 @@ The Reset-ProvisioningCache cmdlet is for diagnostic purposes only and is rarely The Reset-ProvisioningCache cmdlet clears the Windows PowerShell provisioning cache of frequently used Active Directory objects. To reduce Active Directory requests, a provisioning cache is initialized in each Windows PowerShell runspace and is used to cache common objects that are frequently used by cmdlets and provisioning handlers. During Exchange cmdlet execution, the provisioning cache loads configuration objects from Active Directory to help run a cmdlet. For example, when you create a mailbox, the New-Mailbox cmdlet obtains properties from Active Directory. When running cmdlets, configuration objects such as database containers, administrative role groups, and LegacyDNs are retrieved from Active Directory. Because these types of objects are stable and don't change for months or years after they're created, they're stored in the provisioning cache used by Windows PowerShell. This increases provisioning efficiency and significantly improves cmdlet performance. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,6 +66,22 @@ This example runs in a multi-tenant deployment by a data center administrator to ## PARAMETERS +### -Server +The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -Application The Application parameter specifies the specific administrative application to reset the provisioning cache for. You can use the following values: @@ -90,7 +106,7 @@ Accept wildcard characters: False ``` ### -GlobalCache -The GlobalCache switch specifies that all cache keys are cleared. +The GlobalCache switch clears all cache keys. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -105,22 +121,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Server -The Server parameter specifies the fully qualified domain name (FQDN) of the server that the application you want to reset is running on. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -CacheKeys The CacheKeys parameter specifies the value for the cache key that you want to clear. The format for the values should contain 32 digits separated by four dashes: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx @@ -159,7 +159,7 @@ Accept wildcard characters: False ``` ### -CurrentOrganization -The CurrentOrganization switch specifies that the provision cache is reset for this organization. +The CurrentOrganization switch resets the provision cache for the organization. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -211,12 +211,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md index f7db22020f..e7ed934cf1 100644 --- a/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Restore-DatabaseAvailabilityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/restore-databaseavailabilitygroup +online version: https://learn.microsoft.com/powershell/module/exchange/restore-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Restore-DatabaseAvailabilityGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Restore-DatabaseAvailabilityGroup cmdlet as part of a datacenter switchover of a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Restore-DatabaseAvailabilityGroup [-Identity] ## DESCRIPTION Details templates can't be created or deleted, but this task restores the specified template to its default state. All user changes are lost. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,6 +73,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -123,12 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Restore-Mailbox.md b/exchange/exchange-ps/exchange/Restore-Mailbox.md index 130b72427a..8e775b1697 100644 --- a/exchange/exchange-ps/exchange/Restore-Mailbox.md +++ b/exchange/exchange-ps/exchange/Restore-Mailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/restore-mailbox +online version: https://learn.microsoft.com/powershell/module/exchange/restore-mailbox applicable: Exchange Server 2010 title: Restore-Mailbox schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Restore-Mailbox cmdlet to extract mailbox content from a restored databa **Note**: In Exchange Server 2010 Service Pack 1 (SP1) or later, use the New-MailboxRestoreRequest cmdlet instead of the Restore-Mailbox cmdlet to extract mailbox content from a restored database. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,7 +48,7 @@ Restore-Mailbox [-Identity] -RecoveryDatabase [-LastParentFolderID ] [-MaxParallelSize ] [-NoOutput] + [-PolicyTag ] + [-RestoreTargetFolder ] [-ResultSize ] [-SourceFolder ] [-SubjectContains ] @@ -55,7 +57,7 @@ Restore-RecoverableItems -Identity ## DESCRIPTION Items are restored to the original folder location if the information is available for the item. If the information can't be found, the item is restored to the default folder for the item type (Inbox for messages, Calendar for meetings and appointments, etc.). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,6 +77,7 @@ After using the Get-RecoverableItems cmdlet to verify the existence of the item, ### Example 2 ```powershell $mailboxes = Import-CSV "C:\My Documents\RestoreMessage.csv" + $mailboxes | foreach {Restore-RecoverableItems -Identity $_.SMTPAddress -SubjectContains "Project X" -SourceFolder DeletedItems -FilterItemType IPM.Note} ``` @@ -178,7 +181,7 @@ Accept wildcard characters: False ### -FilterEndTime The FilterEndTime specifies the end date/time of the date range. This parameter uses the LastModifiedTime value of the item. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -218,7 +221,7 @@ Accept wildcard characters: False ### -FilterStartTime The FilterStartTime specifies the start date/time of the date range. This parameter uses the LastModifiedTime value of the item. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -272,7 +275,7 @@ Accept wildcard characters: False ### -NoOutput This parameter is available only in the cloud-based service. -The NoOutput switch specifies whether to restore the deleted items directly without any command output in the console. You don't need to specify a value with this switch. +The NoOutput switch restores the deleted items directly without any command output in the console. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -287,6 +290,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PolicyTag +This parameter is available only in the cloud-based service. + +{{ Fill PolicyTag Description }} + +```yaml +Type: String[] +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestoreTargetFolder +This parameter is available only in the cloud-based service. + +The RestoreTargetFolder parameter specifies the top-level folder in which to restore data. If you don't specify this parameter, the command restores folders to the top of the folder structure in the target mailbox or archive. Content is merged under existing folders, and new folders are created if they don't already exist in the target folder structure. + +This parameter is available only on primary mailboxes and is ignored on archive mailboxes. A destination folder will be created if it does not exist. Valid paths are: + +- `/` +- `/folder1` +- `/folder1/folder2` +- `folder1` +- `folder1/folder2` + +The preceding or trailing `/` will be ignored. Then, it will be treated as the relative path of the IPM sub-tree: `/Top Of Information Store`. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResultSize The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. @@ -310,28 +359,15 @@ The SourceFolder parameter specifies where to search for deleted items in the ma - RecoverableItems: The Recoverable Items\Deletions folder. This folder contains items that have been deleted from the Deleted Items folder (soft-deleted items). - PurgedItems: The Recoverable Items\Purges folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items). -If you don't use this parameter, the command will search all of these folders. +If you don't use this parameter, the command searches those three folders. -```yaml -Type: RecoverableItemsFolderType -Parameter Sets: OnPrem -Aliases: -Accepted values: DeletedItems | RecoverableItems, DeletedItems | RecoverableItems | PurgedItems -Applicable: Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +- DiscoveryHoldsItems (cloud-only): The Recoverable Items\DiscoveryHolds folder. This folder contains items that have been purged from the Recoverable Items folder (hard-deleted items) and are protected by a hold. To search for deleted items in this folder, use this parameter with the value DiscoveryHoldsItems. ```yaml Type: RecoverableItemsFolderType -Parameter Sets: Cloud +Parameter Sets: OnPrem Aliases: -Accepted values: DeletedItems | RecoverableItems | PurgedItems -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -361,12 +397,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md index fe064046b4..fd5c0c4ae9 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxDatabaseCopy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-mailboxdatabasecopy +online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Resume-MailboxDatabaseCopy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Resume-MailboxDatabaseCopy cmdlet to unblock activation or resume log copying and replay for a passive mailbox database copy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,7 +44,7 @@ Resume-MailboxDatabaseCopy [-Identity] ## DESCRIPTION The Resume-MailboxDatabaseCopy cmdlet resumes replication and replay from a suspended state. If a database copy was suspended without administrator intervention, it's because the database copy is in a bad state. You can use the Get-MailboxDatabaseCopyStatus cmdlet to see if there are any messages indicating a failure. If the copy of the database is in a bad state, resuming the copy causes replication to fail and the mailbox database copy to return to a suspended state. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,30 +99,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -DisableReplayLag +The DisableReplayLag switch disables any configured replay lag time for the database copy when the passive copy is resumed. You don't need to specify a value with this switch. ```yaml -Type: Fqdn -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: DisableReplayLag Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReplicationOnly -The ReplicationOnly switch specifies whether to resume replication without affecting the activation setting (for example, the ActivationSuspended property for the database copy remains set to True). +### -DisableReplayLagReason +The DisableReplayLagReason parameter is used with the DisableReplayLag parameter to specify an administrative reason for disabling replay lag time for a passive copy. ```yaml -Type: SwitchParameter -Parameter Sets: Identity +Type: String +Parameter Sets: DisableReplayLag Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -131,13 +131,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. +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi +Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False @@ -147,30 +147,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableReplayLag -The DisableReplayLag parameter specifies that any configured replay lag time for the database copy should be disabled when the passive copy is resumed. +### -ReplicationOnly +The ReplicationOnly switch resumes replication without affecting the activation setting (for example, the ActivationSuspended property for the database copy remains set to True). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter -Parameter Sets: DisableReplayLag +Parameter Sets: Identity Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableReplayLagReason -The DisableReplayLagReason parameter is used with the DisableReplayLag parameter to specify an administrative reason for disabling replay lag time for a passive copy. +### -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. ```yaml -Type: String -Parameter Sets: DisableReplayLag -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -184,12 +184,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md index cb5c80ddae..48f67e84d6 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxExportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-mailboxexportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Resume-MailboxExportRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Resume-MailboxExportRequest cmdlet to resume an export request that was suspended or failed. -This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Resume-MailboxExportRequest [-Identity] ## DESCRIPTION The Resume-MailboxExportRequest cmdlet can be pipelined with the Get-MailboxExportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -125,12 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md index f50af8e560..f1d190bae5 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxImportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-mailboximportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Resume-MailboxImportRequest schema: 2.0.0 @@ -16,11 +16,11 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Resume-MailboxImportRequest cmdlet to resume an import request that was suspended or failed. -NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://docs.microsoft.com/microsoft-365/compliance/use-network-upload-to-import-pst-files). +NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://learn.microsoft.com/purview/use-network-upload-to-import-pst-files). -This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Resume-MailboxImportRequest [-Identity] ## DESCRIPTION This cmdlet can be pipelined with the Get-MailboxImportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -129,12 +129,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md index 178599ee2e..b7faf00b00 100644 --- a/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MailboxRestoreRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-mailboxrestorerequest +online version: https://learn.microsoft.com/powershell/module/exchange/resume-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Resume-MailboxRestoreRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Resume-MailboxRestoreRequest cmdlet to resume a restore request that was suspended or failed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Resume-MailboxRestoreRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -125,12 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Resume-Message.md b/exchange/exchange-ps/exchange/Resume-Message.md index 27aa4122ae..3015c97f9a 100644 --- a/exchange/exchange-ps/exchange/Resume-Message.md +++ b/exchange/exchange-ps/exchange/Resume-Message.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-message +online version: https://learn.microsoft.com/powershell/module/exchange/resume-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Resume-Message schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Resume-Message cmdlet to enable delivery of a previously suspended message in a queue on a Mailbox server or Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ Resume-Message [-Identity] ## DESCRIPTION A message being sent to multiple recipients might be located in multiple queues. If you specify an Identity parameter, the message is resumed in a single queue if that identity matches only a single message. If the identity matches more than one message, you receive an error. To resume a message in more than one queue in a single operation, you must use the Filter parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,7 +58,7 @@ This example resumes delivery of all messages in a suspended state and for which ## PARAMETERS ### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity @@ -74,7 +74,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more messages by using OPath filter syntax. The OPath filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://docs.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -156,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Resume-MoveRequest.md b/exchange/exchange-ps/exchange/Resume-MoveRequest.md index 8f3f43e034..81384c86be 100644 --- a/exchange/exchange-ps/exchange/Resume-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Resume-MoveRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-moverequest +online version: https://learn.microsoft.com/powershell/module/exchange/resume-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Resume-MoveRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Resume-MoveRequest cmdlet to resume a move request that has been suspended or has failed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Resume-MoveRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,7 +51,7 @@ This example resumes any failed move requests. ### Example 3 ```powershell -Get-MoveRequest -MoveStatus Suspended | Get-MoveRequestStatistics |Where {$_.Message -like "*resume after 10 P.M."} | Resume-MoveRequest +Get-MoveRequest -MoveStatus Suspended | Get-MoveRequestStatistics | Where {$_.Message -like "*resume after 10 P.M."} | Resume-MoveRequest ``` This example resumes any move requests that have the suspend comment "Resume after 10 P.M." @@ -149,7 +149,9 @@ Accept wildcard characters: False ``` ### -SuspendWhenReadyToComplete -The SuspendWhenReadyToComplete switch specifies whether to suspend the move request before it reaches the status of CompletionInProgress. Instead of this switch, we recommend using the Set-MoveRequest cmdlet with the CompleteAfter parameter. +The SuspendWhenReadyToComplete switch suspends the move request before it reaches the status of CompletionInProgress. You don't need to specify a value with this switch. + +Instead of this switch, we recommend using the Set-MoveRequest cmdlet with the CompleteAfter parameter. ```yaml Type: SwitchParameter @@ -185,12 +187,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md index 3acddbee3f..42768b7cfb 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Resume-PublicFolderMigrationRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-publicfoldermigrationrequest +online version: https://learn.microsoft.com/powershell/module/exchange/resume-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Resume-PublicFolderMigrationRequest schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Resume-PublicFolderMigrationRequest cmdlet to resume serial public folde **Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Resume-PublicFolderMigrationRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -49,7 +49,7 @@ This example resumes failed public folder move requests. ### Example 3 ```powershell -Get-PublicFolderMoveRequest -MoveStatus Suspended | Get-PublicFolderMoveRequestStatistics |Where {$_.Message -like "*resume after 10 P.M."} | Resume-PublicFolderMoveRequest +Get-PublicFolderMoveRequest -MoveStatus Suspended | Get-PublicFolderMoveRequestStatistics | Where {$_.Message -like "*resume after 10 P.M."} | Resume-PublicFolderMoveRequest ``` This example resumes a move request that has the suspend comment "Resume after 10 P.M." @@ -128,12 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md b/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md index b41bdaac49..a781b34c89 100644 --- a/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md +++ b/exchange/exchange-ps/exchange/Resume-PublicFolderReplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-publicfolderreplication +online version: https://learn.microsoft.com/powershell/module/exchange/resume-publicfolderreplication applicable: Exchange Server 2010 title: Resume-PublicFolderReplication schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Resume-PublicFolderReplication cmdlet to resume public folder content replication when it's been stopped. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Resume-PublicFolderReplication [-Confirm] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,12 +97,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Resume-Queue.md b/exchange/exchange-ps/exchange/Resume-Queue.md index c743496976..43bb312d87 100644 --- a/exchange/exchange-ps/exchange/Resume-Queue.md +++ b/exchange/exchange-ps/exchange/Resume-Queue.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/resume-queue +online version: https://learn.microsoft.com/powershell/module/exchange/resume-queue applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Resume-Queue schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Resume-Queue cmdlet to restart processing for a suspended queue on a Mailbox server or an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ Resume-Queue [-Identity] ## DESCRIPTION If you use the Identity parameter, the queue is resumed only if that identity matches a single queue. If the identity matches more than one queue, you receive an error. To resume more than one queue in a single operation, you must use the Filter parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,7 +54,7 @@ This example resumes processing of all queues where the NextHopDomain is Fourthc ## PARAMETERS ### -Identity -The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). +The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity @@ -70,7 +70,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -152,12 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Retry-Queue.md b/exchange/exchange-ps/exchange/Retry-Queue.md index 483dc0f1ce..c34b537241 100644 --- a/exchange/exchange-ps/exchange/Retry-Queue.md +++ b/exchange/exchange-ps/exchange/Retry-Queue.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/retry-queue +online version: https://learn.microsoft.com/powershell/module/exchange/retry-queue applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Retry-Queue schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Retry-Queue cmdlet to force a connection attempt for a queue on a Mailbox server or an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +42,7 @@ Retry-Queue [-Identity] ## DESCRIPTION The Retry-Queue cmdlet forces a connection attempt for a queue that has a status of Retry. The cmdlet establishes a connection to the next hop if possible. If a connection isn't established, a new retry time is set. To use this command to retry delivery of messages in the Unreachable queue, you must include the Resubmit parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,7 +60,7 @@ This example forces a connection attempt for all queues that meet the following ## PARAMETERS ### -Identity -The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). +The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity @@ -76,7 +76,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -174,12 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md index aa06e8d68e..d424e6898b 100644 --- a/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md +++ b/exchange/exchange-ps/exchange/Rotate-DkimSigningConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/rotate-dkimsigningconfig +online version: https://learn.microsoft.com/powershell/module/exchange/rotate-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection title: Rotate-DkimSigningConfig schema: 2.0.0 @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Rotate-DkimSigningConfig cmdlet to rotate the public and private DomainKeys Identified Mail (DKIM) signing policy keys for domains in a cloud-based organization. This cmdlet creates new DKIM keys and uses the alternate DKIM selector. Typically, you don't need to use this cmdlet, because Microsoft 365 automatically rotates your DKIM keys. +Use the Rotate-DkimSigningConfig cmdlet to rotate the public and private DomainKeys Identified Mail (DKIM) signing policy keys for domains in a cloud-based organization. This cmdlet creates new DKIM keys and uses the alternate DKIM selector. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +29,7 @@ Rotate-DkimSigningConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -84,9 +82,14 @@ Accept wildcard characters: False ``` ### -KeySize -The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are 1024 or 2048. +The KeySize parameter specifies the size in bits of the public key that's used in the DKIM signing policy. Valid values are: + +- 1024 +- 2048 + +RSA keys are supported. Ed25519 keys aren't supported. -RSA keys are supported; Ed25519 keys aren't supported. +**Note**: Upgrading the key size to 2048 only upgrades the selector that isn't currently active. After key rotation has taken place, you need to run the command again to upgrade the key size of the other selector. ```yaml Type: UInt16 @@ -122,12 +125,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md index c601b4a3b6..f42ad8e781 100644 --- a/exchange/exchange-ps/exchange/Search-AdminAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-AdminAuditLog.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/search-adminauditlog -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/search-adminauditlog +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Search-AdminAuditLog schema: 2.0.0 author: chrisda @@ -12,11 +12,14 @@ ms.reviewer: # Search-AdminAuditLog ## SYNOPSIS +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: . + This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Search-AdminAuditLog cmdlet to search the contents of the administrator audit log. Administrator audit logging records when a user or administrator makes a change in your organization (in the Exchange admin center or by using cmdlets). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,11 +42,13 @@ Search-AdminAuditLog ## DESCRIPTION If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default. -**Note**: In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. +In Exchange Online PowerShell, if you don't use the StartDate or EndDate parameters, only results from the last 14 days are returned. + +In Exchange Online PowerShell, data is available for the last 90 days. You can enter dates older than 90 days, but only data from the last 90 days will be returned. -For more information about the structure and properties of the audit log, [Administrator audit log structure](https://docs.microsoft.com/Exchange/policy-and-compliance/admin-audit-logging/log-structure). +For more information about the structure and properties of the audit log, see [Administrator audit log structure](https://learn.microsoft.com/Exchange/policy-and-compliance/admin-audit-logging/log-structure). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,6 +76,7 @@ The command completed successfully ### Example 3 ```powershell $LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog + $LogEntries | ForEach { $_.CmdletParameters } ``` @@ -96,7 +102,7 @@ In the results of this cmdlet, this property is named **CmdletName**. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -126,12 +132,12 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In the cloud-based service, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). In the results of this cmdlet, the date/time when the change was made (the cmdlet was run) is returned in the property named **RunDate**. @@ -139,7 +145,7 @@ In the results of this cmdlet, the date/time when the change was made (the cmdle Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -158,7 +164,7 @@ The ExternalAccess parameter filters the results by changes that were made (cmdl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -179,7 +185,7 @@ In the results of this cmdlet, this property is named **Succeeded**. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -203,7 +209,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -221,7 +227,7 @@ In the results of this cmdlet, this property is named **CmdletParameters** Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -239,7 +245,7 @@ The maximum results to return is 250,000. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -251,12 +257,12 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In the cloud-based service, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). In the results of this cmdlet, the date/time when the change was made (the cmdlet was run) is returned in the property named **RunDate**. @@ -264,7 +270,7 @@ In the results of this cmdlet, the date/time when the change was made (the cmdle Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -280,7 +286,7 @@ The StartIndex parameter specifies the position in the result set where the disp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -302,7 +308,7 @@ In the results of this cmdlet, this property is named **Caller** Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -316,12 +322,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Search-Mailbox.md b/exchange/exchange-ps/exchange/Search-Mailbox.md index ca63774725..942951ea8b 100644 --- a/exchange/exchange-ps/exchange/Search-Mailbox.md +++ b/exchange/exchange-ps/exchange/Search-Mailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/search-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/search-mailbox +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Search-Mailbox schema: 2.0.0 author: chrisda @@ -12,15 +12,15 @@ ms.reviewer: # Search-Mailbox ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. Use the Search-Mailbox cmdlet to search a mailbox and copy the results to a specified target mailbox, delete messages from the source mailbox, or both. -**Note**: In cloud-based environments, the Search-Mailbox cmdlet is being deprecated in favor of [New-ComplianceSearch](https://docs.microsoft.com/powershell/module/exchange/new-compliancesearch) and related eDiscovery cmdlets. +**Note**: In cloud-based environments, the Search-Mailbox cmdlet was deprecated in favor of [New-ComplianceSearch](https://learn.microsoft.com/powershell/module/exchange/new-compliancesearch) and related eDiscovery cmdlets. -By default, Search-Mailbox is available only in the Mailbox Search or Mailbox Import Export roles, and these roles aren't assigned to *any* role groups. To use this cmdlet, you need to add one or both of the roles to a role group (for example, the Organization Management role group). Only the Mailbox Import Export role gives you access to the DeleteContent parameter. For more information about adding roles to role groups, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +By default, Search-Mailbox is available only in the Mailbox Search or Mailbox Import Export roles, and these roles aren't assigned to *any* role groups. To use this cmdlet, you need to add one or both of the roles to a role group (for example, the Organization Management role group). Only the Mailbox Import Export role gives you access to the DeleteContent parameter. For more information about adding roles to role groups, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -132,7 +132,7 @@ The Identity parameter specifies the identity of the mailbox to search. You can Type: MailboxOrMailUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -142,13 +142,15 @@ Accept wildcard characters: False ``` ### -EstimateResultOnly -The EstimateResultOnly switch specifies that only an estimate of the total number and size of messages returned by the search be provided. Messages aren't copied to the target mailbox. You can't use this switch with the TargetMailbox parameter. +The EstimateResultOnly switch returns only an estimate of the total number and size of messages. Messages aren't copied to the target mailbox. You don't need to specify a value with this switch. + +You can't use this switch with the TargetMailbox parameter. ```yaml Type: SwitchParameter Parameter Sets: EstimateResult Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -164,7 +166,7 @@ The TargetFolder parameter specifies a folder name in which search results are s Type: String Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -193,7 +195,7 @@ You must use this parameter with the TargetFolder parameter. You can't use this Type: MailboxIdParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -212,7 +214,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -234,7 +236,7 @@ Before you use the DeleteContent switch to delete content, we recommend that you Type: SwitchParameter Parameter Sets: Mailbox, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -244,8 +246,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -262,7 +262,9 @@ Accept wildcard characters: False ``` ### -DoNotIncludeArchive -The DoNotIncludeArchive switch specifies that the user's archive mailbox shouldn't be included in the search. You don't need to specify a value for this switch. By default, the archive mailbox is always searched. +The DoNotIncludeArchive switch specifies that the user's archive mailbox shouldn't be included in the search. You don't need to specify a value for this switch. + +By default, the archive mailbox is always searched. If auto-expanding archiving is enabled for an Exchange Online mailbox, only the user's primary archive mailbox is searched. Auxiliary archive mailboxes aren't included in the search. @@ -270,7 +272,7 @@ If auto-expanding archiving is enabled for an Exchange Online mailbox, only the Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -280,13 +282,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch overrides the confirmation prompt displayed when your use the DeleteContent switch to permanently delete messages. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you use the DeleteContent switch to permanently delete messages. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -296,13 +300,13 @@ Accept wildcard characters: False ``` ### -IncludeUnsearchableItems -The IncludeUnsearchableItems switch specifies whether to include items that couldn't be indexed by Exchange Search. When set to $true, the IncludeUnsearchableItems switch specifies that items that couldn't be indexed by Exchange Search should be included in the search results. +The IncludeUnsearchableItems switch includes items that couldn't be indexed by Exchange Search in the search results. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -326,7 +330,7 @@ When you included this parameter, an email message is created and sent to the ma Type: LoggingLevel Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -336,13 +340,15 @@ Accept wildcard characters: False ``` ### -LogOnly -The LogOnly switch specifies that a search be performed and only a log be generated. Messages returned by the search aren't copied to the target mailbox. The logging level is specified by using the LogLevel parameter. +The LogOnly switch performs a search, but only generates a log. Messages returned by the search aren't copied to the target mailbox. You don't need to specify a value with this switch. + +The logging level is specified by using the LogLevel parameter. ```yaml Type: SwitchParameter Parameter Sets: Mailbox Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -352,13 +358,15 @@ Accept wildcard characters: False ``` ### -SearchDumpster -The SearchDumpster parameter specifies whether to search the Recoverable Items folder, which is the storage location in which items deleted from the Deleted Items folder or hard-deleted items are stored until they're purged from the mailbox database. By default, the Recoverable Items folder is always searched. To exclude the folder from the search, set the SearchDumpster switch to $false, for example,-SearchDumpster:$false +The SearchDumpster switch specifies whether to include the Recoverable Items folder in the search. The Recoverable items folder stores items that were deleted from the Deleted Items folder or items that were hard-deleted until they're purged from the mailbox database. + +By default, the Recoverable Items folder is always included in the search. To exclude the Recoverable Items folder from the search, use this exact syntax: `-SearchDumpster:$false`. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -368,13 +376,17 @@ Accept wildcard characters: False ``` ### -SearchDumpsterOnly -The SearchDumpsterOnly switch specifies that only the Recoverable Items folder of the specified mailbox be searched. You can also use this switch with the DeleteContent switch to delete messages from the Recoverable Items folder and reduce the size of the folder. +The SearchDumpsterOnly switch specifies that only the Recoverable Items folder of the specified mailbox is searched. You don't need to specify a value with this switch. + +The Recoverable items folder stores items that were deleted from the Deleted Items folder or items that were hard-deleted until they're purged from the mailbox database. + +You can also use this switch with the DeleteContent switch to delete messages from the Recoverable Items folder and reduce the size of the folder. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -384,7 +396,7 @@ Accept wildcard characters: False ``` ### -SearchQuery -The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more information about KQL in Exchange, see [Message properties and search operators for In-Place eDiscovery](https://docs.microsoft.com/exchange/security-and-compliance/in-place-ediscovery/message-properties-and-search-operators). +The SearchQuery parameter specifies a search string or a query formatted using Keyword Query Language (KQL). For more information about KQL in Exchange, see [Message properties and search operators for In-Place eDiscovery](https://learn.microsoft.com/exchange/security-and-compliance/in-place-ediscovery/message-properties-and-search-operators). If this parameter is empty, all messages are returned. @@ -394,7 +406,7 @@ If this parameter is empty, all messages are returned. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -410,7 +422,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -424,12 +436,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md index 7825e24d6b..f6ff4a429a 100644 --- a/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-MailboxAuditLog.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/search-mailboxauditlog +online version: https://learn.microsoft.com/powershell/module/exchange/search-mailboxauditlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Search-MailboxAuditLog schema: 2.0.0 @@ -12,11 +12,14 @@ ms.reviewer: # Search-MailboxAuditLog ## SYNOPSIS +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. To access audit log data, use the Search-UnifiedAuditLog cmdlet. For more information, see this blog post: . + This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Search-MailboxAuditLog cmdlet to search mailbox audit log entries matching the specified search terms. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -54,11 +57,11 @@ Search-MailboxAuditLog [-Mailboxes ] ``` ## DESCRIPTION -The Search-MailboxAuditLog cmdlet performs a synchronous search of mailbox audit logs for one or more specified mailboxes and displays search results in the Exchange Management Shell window. To search mailbox audit logs for multiple mailboxes and have the results sent by email to specified recipients, use the New-MailboxAuditLogSearch cmdlet instead. To learn more about mailbox audit logging, see [Mailbox audit logging in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). +The Search-MailboxAuditLog cmdlet performs a synchronous search of mailbox audit logs for one or more specified mailboxes and displays search results in the Exchange Management Shell window. To search mailbox audit logs for multiple mailboxes and have the results sent by email to specified recipients, use the New-MailboxAuditLogSearch cmdlet instead. To learn more about mailbox audit logging, see [Mailbox audit logging in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mailbox-audit-logging/mailbox-audit-logging). -This cmdlet is available in Office 365 operated by 21Vianet, but it won't return any results. +In multi-geo environments, when you run this cmdlet in a different region from the mailbox that you're trying to search, you might receive the error, "An error occurred while trying to access the audit log." In this scenario, you need to anchor the PowerShell session to a user in the same region as the mailbox as described in [Connect directly to a geo location using Exchange Online PowerShell](https://learn.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo#connect-directly-to-a-geo-location-using-exchange-online-powershell). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,10 +81,10 @@ This example retrieves mailbox audit log entries for Ken Kwok and Ben Smith's ma ### Example 3 ```powershell -Search-MailboxAuditLog -Identity kwok -LogonTypes Owner -ShowDetails -StartDate 1/1/2016 -EndDate 3/1/2016 | Where-Object {$_.Operation -eq "HardDelete"} +Search-MailboxAuditLog -Identity kwok -LogonTypes Owner -ShowDetails -StartDate 1/1/2017 -EndDate 3/1/2017 | Where-Object {$_.Operation -eq "HardDelete"} ``` -This example retrieves mailbox audit log entries for Ken Kwok's mailbox for actions performed by the mailbox owner between 1/1/2016 and 3/1/2016. The results are piped to the Where-Object cmdlet and filtered to return only entries with the HardDelete action. +This example retrieves mailbox audit log entries for Ken Kwok's mailbox for actions performed by the mailbox owner between 1/1/2017 and 3/1/2017. The results are piped to the Where-Object cmdlet and filtered to return only entries with the HardDelete action. ## PARAMETERS @@ -133,7 +136,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -208,9 +211,7 @@ Accept wildcard characters: False ### -IncludeInactiveMailbox This parameter is available only in the cloud-based service. -The IncludeInactiveMailbox switch is required to include inactive mailboxes in the search. You don't need to specify a value with this switch. - -An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. +{{ Fill IncludeInactiveMailbox Description }} ```yaml Type: SwitchParameter @@ -346,7 +347,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: ExDateTime @@ -366,12 +367,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md b/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md index ece7687cc7..b56afd8580 100644 --- a/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md +++ b/exchange/exchange-ps/exchange/Search-MessageTrackingReport.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/search-messagetrackingreport +online version: https://learn.microsoft.com/powershell/module/exchange/search-messagetrackingreport applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Search-MessageTrackingReport schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Search-MessageTrackingReport ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. -Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see [Get-MessageTrackingReport](https://docs.microsoft.com/powershell/module/exchange/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. +Use the Search-MessageTrackingReport cmdlet to find the unique message tracking report based on the search criteria provided. You can then pass this message tracking report ID to the Get-MessageTrackingReport cmdlet to get full message tracking information. For more information, see [Get-MessageTrackingReport](https://learn.microsoft.com/powershell/module/exchange/get-messagetrackingreport). The message tracking report cmdlets are used by the delivery reports feature. -In Exchange Online, delivery reports has been replaced by message trace (the Get-MessageTrace and Get-MessageTraceDetail cmdlets). +In Exchange Online, delivery reports are replaced by message trace (the Get-MessageTraceV2 and Get-MessageTraceDetailV2 cmdlets). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -56,7 +56,7 @@ Search-MessageTrackingReport [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -325,12 +325,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md index 327aabfb64..9043d4d2b9 100644 --- a/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md +++ b/exchange/exchange-ps/exchange/Search-UnifiedAuditLog.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/search-unifiedauditlog -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/search-unifiedauditlog +applicable: Exchange Online, Exchange Online Protection title: Search-UnifiedAuditLog schema: 2.0.0 author: chrisda @@ -14,11 +14,11 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint Online, OneDrive for Business, Azure Active Directory, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. +Use the Search-UnifiedAuditLog cmdlet to search the unified audit log. This log contains events from Exchange Online, SharePoint, OneDrive, Microsoft Entra ID, Microsoft Teams, Power BI, and other Microsoft 365 services. You can search for all events in a specified date range, or you can filter the results based on specific criteria, such as the user who performed the action, the action, or the target object. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: By default, this cmdlet returns a subset of results containing up to 100 records. Use SessionCommand parameter with the ReturnLargeSet value to exhaustively search up to 50,000 results. The SessionCommand parameter causes the cmdlet to return unsorted data. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,9 @@ For information about the parameter sets in the Syntax section below, see [Excha Search-UnifiedAuditLog -EndDate -StartDate [-Formatted] [-FreeText ] + [-HighCompleteness] [-IPAddresses ] + [-LongerRetentionEnabled ] [-ObjectIds ] [-Operations ] [-RecordType ] @@ -41,9 +43,9 @@ Search-UnifiedAuditLog -EndDate -StartDate ## DESCRIPTION The Search-UnifiedAuditLog cmdlet presents pages of data based on repeated iterations of the same command. Use SessionId and SessionCommand to repeatedly run the cmdlet until you get zero returns, or hit the maximum number of results based on the session command. To gauge progress, look at the ResultIndex (hits in the current iteration) and ResultCount (hits for all iterations) properties of the data returned by the cmdlet. -The Search-UnifiedAuditLog cmdlet is available in Exchange Online PowerShell. You can also view events from the unified auditing log by using the Microsoft 365 compliance center. For more information, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). +The Search-UnifiedAuditLog cmdlet is available in Exchange Online PowerShell. You can also view events from the unified auditing log by using the Microsoft Purview compliance portal. For more information, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). -If you want to programmatically download data from the Microsoft 365 audit log, we recommend that you use the Microsoft 365 Management Activity API instead of using the Search-UnifiedAuditLog cmdlet in a PowerShell script. The Microsoft 365 Management Activity API is a REST web service that you can use to develop operations, security, and compliance monitoring solutions for your organization. For more information, see [Management Activity API reference](https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-reference). +If you want to programmatically download data from the Microsoft 365 audit log, we recommend that you use the Microsoft 365 Management Activity API instead of using the Search-UnifiedAuditLog cmdlet in a PowerShell script. The Microsoft 365 Management Activity API is a REST web service that you can use to develop operations, security, and compliance monitoring solutions for your organization. For more information, see [Management Activity API reference](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-reference). This cmdlet is available in Office 365 operated by 21Vianet, but it won't return any results. @@ -51,50 +53,50 @@ The OutVariable parameter accepts objects of type ArrayList. Here's an example o `$start = (Get-Date).AddDays(-1); $end = (Get-Date).AddDays(-0.5); $auditData = New-Object System.Collections.ArrayList; Search-UnifiedAuditLog -StartDate $start -EndDate $end -OutVariable +auditData | Out-Null` -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/2/2018 +Search-UnifiedAuditLog -StartDate 5/1/2023 -EndDate 5/2/2023 -SessionCommand ReturnLargeSet ``` -This example searches the unified audit log for all events from May 1, 201812:00AM to May 2, 2018 12:00AM. +This example searches the unified audit log for all events from May 1, 2023 12:00AM to May 2, 2023 12:00AM. **Note**: If you don't include a timestamp in the value for the StartDate or EndDate parameters, the default timestamp 12:00 AM (midnight) is used. ### Example 2 ```powershell -Search-UnifiedAuditLog -StartDate "6/1/2018 8:00 AM" -EndDate "6/1/2018 6:00 PM" -RecordType ExchangeAdmin +Search-UnifiedAuditLog -StartDate "6/1/2023 8:00 AM" -EndDate "6/1/2023 6:00 PM" -RecordType ExchangeAdmin -SessionCommand ReturnLargeSet ``` -This example searches the unified audit log for all Exchange admin events from 8:00 AM to 6:00 PM on June 1, 2018. +This example searches the unified audit log for all Exchange admin events from 8:00 AM to 6:00 PM on June 1, 2023. **Note** If you use the same date for the StartDate and EndDate parameters, you need to include a timestamp; otherwise, no results will be returned because the date and time for the start and end dates will be the same. ### Example 3 ```powershell -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -SessionId "UnifiedAuditLogSearch 05/08/17" -SessionCommand ReturnLargeSet +Search-UnifiedAuditLog -StartDate 5/1/2023 -EndDate 5/8/2023 -SessionId "UnifiedAuditLogSearch 05/08/17" -SessionCommand ReturnLargeSet ``` -This example searches the unified audit log for all events from May 1, 2018 to May 8, 2018. If you don't include a time stamp in the StartDate or EndDate parameters, The data is returned in pages as the command is rerun sequentially while using the same SessionId value. +This example searches the unified audit log for all events from May 1, 2023 to May 8, 2023. If you don't include a time stamp in the StartDate or EndDate parameters, The data is returned in pages as the command is rerun sequentially while using the same SessionId value. **Note**: Always use the same SessionCommand value for a given SessionId value. Don't switch between ReturnLargeSet and ReturnNextPreviewPage for the same session ID. Otherwise, the output is limited to 10,000 results. ### Example 4 ```powershell -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -RecordType SharePointFileOperation -Operations FileAccessed -SessionId "WordDocs_SharepointViews"-SessionCommand ReturnLargeSet +Search-UnifiedAuditLog -StartDate 5/1/2023 -EndDate 5/8/2023 -RecordType SharePointFileOperation -Operations FileAccessed -SessionId "WordDocs_SharepointViews" -SessionCommand ReturnLargeSet ``` -This example searches the unified audit log for any files accessed in SharePoint Online from May 1, 2018 to May 8, 2018. The data is returned in pages as the command is rerun sequentially while using the same SessionId value. +This example searches the unified audit log for any files accessed in SharePoint from May 1, 2023 to May 8, 2023. The data is returned in pages as the command is rerun sequentially while using the same SessionId value. ### Example 5 ```powershell -Search-UnifiedAuditLog -StartDate 5/1/2018 -EndDate 5/8/2018 -ObjectIDs "https://alpinehouse.sharepoint.com/sites/contoso/Departments/SM/International/Shared%20Documents/Sales%20Invoice%20-%20International.docx" +Search-UnifiedAuditLog -StartDate 5/1/2023 -EndDate 5/8/2023 -ObjectIDs "https://alpinehouse.sharepoint.com/sites/contoso/Departments/SM/International/Shared%20Documents/Sales%20Invoice%20-%20International.docx" -SessionCommand ReturnLargeSet ``` -This example searches the unified audit log from May 1, 2018 to May 8, 2018 for all events relating to a specific Word document identified by its ObjectIDs value. +This example searches the unified audit log from May 1, 2023 to May 8, 2023 for all events relating to a specific Word document identified by its ObjectIDs value. ## PARAMETERS @@ -104,7 +106,7 @@ The EndDate parameter specifies the end date of the date range. Entries are stor To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, `"2018-05-06 14:30:00z"`. -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2018 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2018 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). If you don't include a timestamp in the value for this parameter, the default timestamp is 12:00 AM (midnight) on the specified date. @@ -112,7 +114,7 @@ If you don't include a timestamp in the value for this parameter, the default ti Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -127,7 +129,7 @@ The StartDate parameter specifies the start date of the date range. Entries are To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, `"2018-05-06 14:30:00z"`. -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2018 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2018 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). If you don't include a timestamp in the value for this parameter, the default timestamp is 12:00 AM (midnight) on the specified date. @@ -135,7 +137,7 @@ If you don't include a timestamp in the value for this parameter, the default ti Type: ExDateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -153,7 +155,7 @@ In addition, this switch makes AuditData more readable. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -169,7 +171,27 @@ The FreeText parameter filters the log entries by the specified text string. If Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighCompleteness +**Note**: This parameter is currently in Preview, isn't available in all organizations, and is subject to change. + +The HighCompleteness switch specifies completeness instead performance in the results. You don't need to specify a value with this switch. + +When you use this switch, the query returns more complete search results but might take significantly longer to run. If you don't use this switch, the query runs faster but might have missing search results. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -185,7 +207,23 @@ The IPAddresses parameter filters the log entries by the specified IP addresses. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LongerRetentionEnabled +{{ Fill LongerRetentionEnabled Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -195,7 +233,11 @@ Accept wildcard characters: False ``` ### -ObjectIds -The ObjectIds parameter filters the log entries by object ID. The object ID is the target object that was acted upon, and depends on the RecordType and Operations values of the event. For example, for SharePoint operations, the object ID is the URL path to a file, folder, or site. For Azure Active Directory operations, the object ID is the account name or GUID value of the account. +The ObjectIds parameter filters the log entries by object ID. The object ID is the target object that was acted upon, and depends on the RecordType and Operations values of the event. + +For example, for SharePoint operations, the object ID is the URL path to a file, folder, or site. To search logs in a site, add a wildcard (\*) in front of the site URL (for example, `"https://contoso.sharepoint.com/sites/test/*"`). + +For Microsoft Entra operations, the object ID is the account name or GUID value of the account. The ObjectId value appears in the AuditData (also known as Details) property of the event. @@ -205,7 +247,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -215,7 +257,7 @@ Accept wildcard characters: False ``` ### -Operations -The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). +The Operations parameter filters the log entries by operation. The available values for this parameter depend on the RecordType value. For a list of the available values for this parameter, see [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -223,7 +265,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -233,13 +275,13 @@ Accept wildcard characters: False ``` ### -RecordType -The RecordType parameter filters the log entries by record type. For details about the available values, see [AuditLogRecordType](https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). +The RecordType parameter filters the log entries by record type. For details about the available values, see [AuditLogRecordType](https://learn.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). ```yaml Type: AuditRecordType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,7 +297,7 @@ The ResultSize parameter specifies the maximum number of results to return. The Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -265,7 +307,7 @@ Accept wildcard characters: False ``` ### -SessionCommand -The SessionCommand parameter specifies how much information is returned and how it's organized. Valid values are: +The SessionCommand parameter specifies how much information is returned and how it's organized. This parameter is required if you want to retrieve more than the default limit of 100 results. Valid values are: - ReturnLargeSet: This value causes the cmdlet to return unsorted data. By using paging, you can access a maximum of 50,000 results. This is the recommended value if an ordered result is not required and has been optimized for search latency. - ReturnNextPreviewPage: This value causes the cmdlet to return data sorted on date. The maximum number of records returned through use of either paging or the ResultSize parameter is 5,000 records. @@ -276,7 +318,7 @@ The SessionCommand parameter specifies how much information is returned and how Type: UnifiedAuditSessionCommand Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -296,7 +338,7 @@ For a given session ID, if you use the SessionCommand value ReturnLargeSet, and Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -306,17 +348,15 @@ Accept wildcard characters: False ``` ### -SiteIds -The SiteIds parameter filters the log entries by the SharePoint site URL. +The SiteIds parameter filters the log entries by the SharePoint SiteId (GUID). You can enter multiple values separated by commas: `Value1, Value2,...ValueN`. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -If the site URL contains a dash (-), escape the dash character with another dash. For example, for the site `https://contoso.sharepoint.com/sites/hr-project`, use the value `"https://contoso.sharepoint.com/sites/hr--project"`. +To obtain the SiteId for a SharePoint site, append `/_api/site/id` to the URL of the site collection you want to specify. For example, change the URL `https://contoso.sharepoint.com/sites/hr-project` to `https://contoso.sharepoint.com/sites/hr-project/_api/site/id`. An XML payload is returned and the SiteId for the site collection is displayed in the Edm.Guid property; for example: `14ab81b6-f23d-476a-8cac-ad5dbd2910f7`. ```yaml Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -326,7 +366,7 @@ Accept wildcard characters: False ``` ### -UserIds -The UserIds parameter filters the log entries by the ID of the user who performed the action. +The UserIds parameter filters the log entries by the account (UserPrincipalName) of the user who performed the action. For example, laura@contoso.onmicrosoft.com. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -334,7 +374,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -348,12 +388,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md b/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md index 4a466bbb81..dd6524d3fd 100644 --- a/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md +++ b/exchange/exchange-ps/exchange/Send-TextMessagingVerificationCode.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/send-textmessagingverificationcode +online version: https://learn.microsoft.com/powershell/module/exchange/send-textmessagingverificationcode applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Send-TextMessagingVerificationCode schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Send-TextMessagingVerificationCode cmdlet to send a text messaging verification as part of configuring text message notifications on the mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Send-TextMessagingVerificationCode [[-Identity] ] ## DESCRIPTION The Send-TextMessagingVerificationCode cmdlet generates a verification code and sends it to a user's mobile phone. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). This cmdlet returns an error if the user requests a verification code more than three times within a 24-hour period. @@ -145,12 +145,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ADServerSettings.md b/exchange/exchange-ps/exchange/Set-ADServerSettings.md index d3c1079b8a..fbc8c31fba 100644 --- a/exchange/exchange-ps/exchange/Set-ADServerSettings.md +++ b/exchange/exchange-ps/exchange/Set-ADServerSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-adserversettings +online version: https://learn.microsoft.com/powershell/module/exchange/set-adserversettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ADServerSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AdServerSettings cmdlet to manage the Active Directory Domain Services (AD DS) environment in the current Exchange Management Shell session. The Set-AdServerSettings cmdlet replaces the AdminSessionADSettings session variable that was used in Exchange Server 2007. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -51,7 +51,7 @@ Set-AdServerSettings [[-PreferredServer] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -225,12 +225,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ADSite.md b/exchange/exchange-ps/exchange/Set-ADSite.md index 4e44fb8896..b2769997e3 100644 --- a/exchange/exchange-ps/exchange/Set-ADSite.md +++ b/exchange/exchange-ps/exchange/Set-ADSite.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-adsite +online version: https://learn.microsoft.com/powershell/module/exchange/set-adsite applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ADSite schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AdSite cmdlet to configure the Exchange settings of Active Directory sites. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Set-AdSite [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -167,12 +167,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md new file mode 100644 index 0000000000..cb0c15498e --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ATPBuiltInProtectionRule.md @@ -0,0 +1,219 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-atpbuiltinprotectionrule +applicable: Exchange Online +title: Set-ATPBuiltInProtectionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ATPBuiltInProtectionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ATPBuiltInProtectionRule cmdlet to modify the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ATPBuiltInProtectionRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ATPBuiltInProtectionRule -Identity "ATP Built-In Protection Rule" -ExceptIfSentToMemberOf "Test Group1","Test Group2" +``` + +This example provides exceptions to the Built-in protection preset security policy for members of the specified groups. + +### Example 2 +```powershell +Set-ATPBuiltInProtectionRule -Identity "ATP Built-In Protection Rule" -ExceptIfRecipientDomainIs (Get-AcceptedDomain).Name +``` + +This example provides exceptions to the Built-in protection preset security policy for recipients in all accepted domains. To see all of your accepted domains, run the following command: `Get-AcceptedDomain | Format-List Name,DomainName`. + +### Example 3 +```powershell +Set-ATPBuiltInProtectionRule -Identity "ATP Built-In Protection Rule" -ExceptIfRecipientDomainIs $null -ExceptIfSentTo $null -ExceptIfSentToMemberOf $null +``` + +This example remove all exceptions from the Built-in protection preset security policy. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +The name of the only rule is ATP Built-In Protection Rule. + +```yaml +Type: DehydrateableRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +Dynamic distribution groups are not supported. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md new file mode 100644 index 0000000000..a2820af421 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ATPProtectionPolicyRule.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-atpprotectionpolicyrule +applicable: Exchange Online +title: Set-ATPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ATPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ATPProtectionPolicyRule cmdlet to modify rules that are associated with Microsoft Defender for Office 365 protections in preset security policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ATPProtectionPolicyRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Name ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" -ExceptIfSentToMemberOf "Test Group1","Test Group2" +``` + +This example provides exceptions to Defender for Office 365 protections in the Standard preset security policy for members of the specified groups. + +### Example 2 +```powershell +Set-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy" -SentTo $null -ExceptIfSentTo $null -SentToMemberOf $null -ExceptIfSentToMemberOf $null -RecipientDomainIs $null -ExceptIfRecipientDomainIs $null +``` + +This example removes all conditions and exceptions from the Standard preset security policy. No restrictions are placed on who the Defender for Office 365 protections apply to. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. We highly recommend that you use the default rule names for clarity and consistency. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. + +You must use the default value for the rule. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md index e33f14e979..d8069d6995 100644 --- a/exchange/exchange-ps/exchange/Set-AcceptedDomain.md +++ b/exchange/exchange-ps/exchange/Set-AcceptedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-accepteddomain +online version: https://learn.microsoft.com/powershell/module/exchange/set-accepteddomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-AcceptedDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-AcceptedDomain cmdlet to modify existing accepted domains in your organization. An accepted domain is any SMTP namespace for which an Exchange organization sends and receives email. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,12 +34,14 @@ Set-AcceptedDomain [-Identity] [-OutboundOnly ] [-PendingCompletion ] [-PendingRemoval ] + [-SendingFromDomainDisabled ] + [-SendingToDomainDisabled ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,7 +101,7 @@ This parameter is available only in the cloud-based service. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -151,10 +153,10 @@ Accept wildcard characters: False The DomainType parameter specifies the accepted domain type. Valid values are: - Authoritative: This is the default value. Your organization is completely responsible for delivering email to recipients in the domain, and for generating non-delivery reports (also known as an NDRs, delivery system notifications, DSNs, or bounce messages) for unresolved recipients. -- InternalRelay: This is a type of non-authoritative domain. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external messaging system that's under your control. The external messaging system is responsible for generating NDRs for unresolved recipients. Use this value to treat messages that are sent to the domain as internal messages. -- ExternalRelay: This is a type of non-authoritative domain that's available only in on-premises Exchange organizations. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external messaging system that's completely outside of your control. The external messaging system is responsible for generating NDRs for unresolved recipients. +- InternalRelay: This is a type of non-authoritative domain. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external email system that's under your control. The external email system is responsible for generating NDRs for unresolved recipients. Use this value to treat messages that are sent to the domain as internal messages. +- ExternalRelay: This is a type of non-authoritative domain that's available only in on-premises Exchange organizations. Your organization receives email that's sent to recipients in the domain, but the messages are relayed to an external email system that's completely outside of your control. The external email system is responsible for generating NDRs for unresolved recipients. -**Note**: For the value InternalRelay or ExternalRelay, you typically use mail users or mail contacts to relay the messages to the external messaging system. Address rewriting is also available on Edge Transport servers in on-premises Exchange organizations. +**Note**: For the value InternalRelay or ExternalRelay, you typically use mail users or mail contacts to relay the messages to the external email system. Address rewriting is also available on Edge Transport servers in on-premises Exchange organizations. ```yaml Type: AcceptedDomainType @@ -302,6 +304,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SendingFromDomainDisabled +This parameter is available only in the cloud-based service. + +The SendingFromDomainDisabled parameter specifies whether to allow email to be sent from addresses in the domain. Valid values are: + +- $true: Email can't be sent from addresses in the domain. +- $false: Email can be sent from addresses in the domain. + +A common scenario is addresses in a legacy domain that still need to receive email, but shouldn't be used to send email. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendingToDomainDisabled +This parameter is available only in the cloud-based service. + +The SendingToDomainDisabled specifies whether to prevent delivery of messages sent to recipients in the domain. Valid values are: + +- $true: Email sent to recipients in the domain is blocked. +- $false: Email sent to recipients in the domain isn't blocked. + +A common scenario is to prevent email delivery to recipients in your unused Micorost Online Email Routing Address (MOERA) domain (for example, contoso.onmicrosoft.com). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -323,12 +371,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md index ccb33fe9ee..a8ff53f2c3 100644 --- a/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md +++ b/exchange/exchange-ps/exchange/Set-AccessToCustomerDataRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-accesstocustomerdatarequest -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-accesstocustomerdatarequest +applicable: Exchange Online, Exchange Online Protection title: Set-AccessToCustomerDataRequest schema: 2.0.0 author: chrisda @@ -16,22 +16,21 @@ This cmdlet is available only in the cloud-based service. Use the Set-AccessToCustomerDataRequest cmdlet to approve, deny, or cancel Microsoft 365 customer lockbox requests that control access to your data by Microsoft support engineers. -**Note**: Customer lockbox is included in the Microsoft 365 E5 plan. If you don't have a Microsoft 365 E5 plan, you can buy a separate customer lockbox subscription with any Microsoft 365 Enterprise plan. +**Note**: Customer Lockbox is included in Microsoft 365 E5, or you can buy a separate Customer Lockbox subscription with any Microsoft 365 Enterprise plan. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-AccessToCustomerDataRequest -ApprovalDecision -RequestId [-Comment ] + [-ServiceName ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,7 +54,7 @@ The ApprovalDecision parameter specifies the approval decision for the customer Type: AccessToCustomerDataApproverDecision Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -71,7 +70,7 @@ The RequestId parameter specifies the reference number of the customer lockbox r Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -87,7 +86,28 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServiceName +The ServiceName parameter specifies the related service. Valid values are: + +- EOP +- Exchange +- SharePoint +- Teams + +```yaml +Type: Microsoft.Exchange.Management.AccessToCustomerDataApproval.AccessToCustomerDataRequestServiceName +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -101,12 +121,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md b/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md index 3db32eb9a0..3649c7062d 100644 --- a/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-ActiveSyncDeviceAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-activesyncdeviceaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-activesyncdeviceaccessrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-ActiveSyncDeviceAccessRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ActiveSyncDeviceAccessRule cmdlet to set the level of access for the rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Set-ActiveSyncDeviceAccessRule [-Identity] ## DESCRIPTION The Set-ActiveSyncVirtualDirectory cmdlet configures a variety of settings on the virtual directory used for Exchange ActiveSync including security, authentication, and internal and external URL settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync" -BasicAuthEnabled $false +Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync (Default Web Site)" -BasicAuthEnabled $false ``` This example disables Basic authentication on the default Exchange ActiveSync virtual directory on the server Contoso. ### Example 2 ```powershell -Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync" -BadItemReportingEnabled $true -SendWatsonReport:$true +Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync (Default Web Site)" -BadItemReportingEnabled $true -SendWatsonReport:$true ``` This example enables bad item reporting and turns on the option to send Watson reports for errors on the server Contoso. ### Example 3 ```powershell -Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync" -ExternalUrl "https://contoso.com/mail" +Set-ActiveSyncVirtualDirectory -Identity "contoso\Microsoft-Server-ActiveSync (Default Web Site)" -ExternalUrl "https://contoso.com/mail" ``` This example configures the external URL on the default Exchange ActiveSync virtual directory on the server Contoso. @@ -568,12 +568,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ActivityAlert.md b/exchange/exchange-ps/exchange/Set-ActivityAlert.md deleted file mode 100644 index 4fc29996c7..0000000000 --- a/exchange/exchange-ps/exchange/Set-ActivityAlert.md +++ /dev/null @@ -1,408 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-activityalert -applicable: Security & Compliance Center -title: Set-ActivityAlert -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-ActivityAlert - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Set-ActivityAlert cmdlet to modify activity alerts in the Microsoft 365 Defender portal or the Microsoft 365 compliance center. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-ActivityAlert [-Identity] - [-Category ] - [-Condition ] - [-Confirm] - [-Description ] - [-Disabled ] - [-EmailCulture ] - [-Multiplier ] - [-NotifyUser ] - [-Operation ] - [-RecordType ] - [-ScopeLevel ] - [-Severity ] - [-Threshold ] - [-TimeWindow ] - [-UserId ] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -$NU = Get-ActivityAlert "Contoso Elevation of Privilege" -$NU.NotifyUser.Add("chris@fabrikam.com") -Set-ActivityAlert "Contoso Elevation of Privilege" -NotifyUser $NU.NotifyUser -``` - -This example adds the external user chris@fabrikam.com to the list of recipients that email notifications are sent to for the activity alert named Contoso Elevation of Privilege. - -**Note**: To remove an existing email address from the list of recipients, change the value NotifyUser.Add to NotifyUser.Remove. - -### Example 2 -```powershell -Set-ActivityAlert -Identity "External Sharing Alert" -Disabled $true -``` - -This example disables the existing activity alert named External Sharing Alert. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the activity alert that you want to modify. You can use any value that uniquely identifies the activity alert. For example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Category -The Category parameter specifies a category for the activity alert. Valid values are: - -- None (This is the default value) -- DataLossPrevention -- ThreatManagement -- DataGovernance -- AccessGovernance -- Others - -```yaml -Type: AlertRuleCategory -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -The Condition parameter specifies filter conditions for event aggregation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The Description parameter specifies an optional description for the activity alert. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -The Disabled parameter specifies whether the activity alert is enabled or disabled. Valid values are: - -- $true: The activity alert is disabled. -- $false: The activity alert is enabled. This is the default value. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailCulture -The EmailCulture parameter specifies the language of the notification email message. - -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Multiplier -The Multiplier parameter specifies the number of events that trigger an activity alert. The value of this parameter indicates a multiplier from a baseline value. - -You can only use this parameter on activity alerts that have the Type property value AnomalousAggregation. - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyUser -The NotifyUser parameter specifies the email address of the recipients who will receive the notification emails. You can specify internal and external email addresses. - -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -To modify the existing list of recipients, see the Examples section. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Operation -The Operation parameter specifies the activities that trigger activity alerts. - -A valid value for this parameter is an activity that's available in the Microsoft 365 audit log. For a description of these activities, see [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). - -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -For the syntax that you use to modify an existing list of Operations values, see the Examples section. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordType -The RecordType parameter specifies a record type label for the activity alert. For details about the available values, see [AuditLogRecordType](https://docs.microsoft.com/office/office-365-management-api/office-365-management-activity-api-schema#auditlogrecordtype). - -You can't use this parameter when the value of the Type parameter is ElevationOfPrivilege. - -```yaml -Type: AuditRecordType -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeLevel -The ScopeLevel parameter specifies the scope for activity alerts that use the Type parameter values SimpleAggregation or AnomalousAggregation. Valid values are: - -- SingleUser (This is the default value) -- AllUsers - -```yaml -Type: AlertScopeLevel -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Severity -The Severity parameter specifies a severity level for the activity alert. Valid values are: - -- None -- Low (This is the default value) -- Medium -- High - -```yaml -Type: RuleSeverity -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -The Threshold parameter specifies the number of events that trigger an activity alert in the time interval that's specified by the TimeWindow parameter. The minimum value for this parameter is 3. - -You can only use this parameter on activity alerts that have the Type property value SimpleAggregation. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeWindow -The TimeWindow parameter specifies the time window in minutes that's used by the Threshold parameter. - -You can only use this parameter on activity alerts that have the Type property value SimpleAggregation. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserId -The UserId parameter specifies who you want to monitor. - -- If you specify a user's email address, you'll receive an email notification when the user performs the specified activity. You can specify multiple email addresses separated by commas. -- If this parameter is blank ($null), you'll receive an email notification when any user in your organization performs the specified activity. - -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -You can only use this parameter on activity alerts that have the Type property values Custom or ElevationOfPrivilege. - -For the syntax that you use to modify an existing list of UserId values, see the Examples section. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AdSiteLink.md b/exchange/exchange-ps/exchange/Set-AdSiteLink.md index 9c9a089d2a..0bdcffba25 100644 --- a/exchange/exchange-ps/exchange/Set-AdSiteLink.md +++ b/exchange/exchange-ps/exchange/Set-AdSiteLink.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-adsitelink +online version: https://learn.microsoft.com/powershell/module/exchange/set-adsitelink applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-AdSiteLink schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to an Active Directory IP site link. You can also use this cmdlet to configure the maximum message size that can pass across an Active Directory IP site link. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Set-AdSiteLink [-Identity] ## DESCRIPTION By default, Microsoft Exchange determines the least cost routing path by using the cost assigned to the Active Directory IP site link. You can use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to the Active Directory IP site link. The Exchange-specific cost is a separate attribute used instead of the Active Directory-assigned cost to determine the least cost routing path. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -181,12 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AdaptiveScope.md b/exchange/exchange-ps/exchange/Set-AdaptiveScope.md new file mode 100644 index 0000000000..6560f5f4ab --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AdaptiveScope.md @@ -0,0 +1,173 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-adaptivescope +applicable: Security & Compliance +title: Set-AdaptiveScope +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-AdaptiveScope + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Set-AdaptiveScope cmdlet to modify adaptive scopes in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Default +``` +Set-AdaptiveScope [-Identity] -FilterConditions + [-AdministrativeUnit ] + [-Comment ] + [] +``` + +### AdaptiveScopeRawQuery +``` +Set-AdaptiveScope [-Identity] -RawQuery + [-AdministrativeUnit ] + [-Comment ] + [] +``` + +### AdministrativeUnit +``` +Set-AdaptiveScope [-Identity] -AdministrativeUnit + [-Comment ] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AdaptiveScope -Identity "Project X" -FilterConditions @{"Conditions" = @{"Value" = "Redmond"; "Operator" = "Equals"; "Name" = "City"}; "Conjunction" = "And"} +``` + +This example modifies the filter in exiting adaptive scope named Project X. The new filter looks for all users in the city of Redmond. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the adaptive scope that you want to modify. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AdministrativeUnit +{{ Fill AdministrativeUnit Description }} + +```yaml +Type: Guid +Parameter Sets: AdministrativeUnit +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Guid +Parameter Sets: Default, AdaptiveScopeRawQuery +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FilterConditions +The FilterConditions parameter specifies the conditions that are included in the dynamic boundary. Valid syntax and values depend of the value of the LocationType parameter: + +- User or Group: Active Directory attributes. For example, for the condition "('Country or region' equals 'US' or 'Canada') and 'Department' equals 'Finance'", use the following syntax: `@{"Conditions" = @(@{"Conditions" = @(@{"Value" = "US"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}, @{"Value" = "Canada"; "Operator" = "Equals"; "Name" = "CountryOrRegion"}); "Conjunction" = "Or"}, @{"Value" = "Finance"; "Operator" = "Equals"; "Name" = "Department"}); "Conjunction" = "And"}` +- Site: Indexed custom properties. For example, for the condition "'Refinable string 0' equals 'Human Resources', use the following syntax: `@{"Conditions" = @{"Value" = "Human Resources"; "Operator" = "Equals"; "Name" = "RefinableString00"}; "Conjunction" = "And"}` + +You can't use this parameter with the RawQuery parameter. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawQuery +The RawQuery parameter switches the scope to advanced query mode. You use OPATH filter syntax for advanced query mode. + +You can't use this parameter with the FilterConditions parameter. + +```yaml +Type: String +Parameter Sets: AdaptiveScopeRawQuery +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md b/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md index 9e9737f6bd..6438ed69a2 100644 --- a/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AddressBookPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-addressbookpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-addressbookpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-AddressBookPolicy schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-AddressBookPolicy cmdlet to change the settings of an address book policy. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Set-AddressBookPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -167,7 +167,19 @@ Accept wildcard characters: False ``` ### -RoomList -The RoomList parameter specifies the name of the room address list. +The RoomList parameter specifies an address list that used for location experiences for mailbox users who have this address book policy assigned to them. + +- When using location experiences (for example, Room Finder or selecting a conference room when scheduling a meeting), users see only resources that match the [RecipientFilter](https://learn.microsoft.com/powershell/module/exchange/new-addresslist#-recipientfilter) results from the address list that's specified by this parameter. +- When using experiences that aren't location specific (for example, the To or Cc fields of a calendar event), the address lists specified by the AddressLists parameter in this address book policy are applied. The address list specified by this parameter isn't used. + +A valid value for this parameter is one address list. You can use any value that uniquely identifies the address list. For example: + +- Name +- Distinguished name (DN) +- GUID + +> [!NOTE] +> There's no automatic association between this parameter and [room list distribution groups](https://learn.microsoft.com/exchange/recipients/room-mailboxes#create-a-room-list), which also use a parameter named RoomList in the New-DistributionGroup and Set-DistributionGroup cmdlets. You still need to create room list distribution groups and assign resources as group members. Location experiences are filtered to show only rooms included in the address list that's specified by the RoomList property of the address book policy that's assigned to the user (if any). ```yaml Type: AddressListIdParameter @@ -203,12 +215,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AddressList.md b/exchange/exchange-ps/exchange/Set-AddressList.md index 7dd56dc15e..686f5b3185 100644 --- a/exchange/exchange-ps/exchange/Set-AddressList.md +++ b/exchange/exchange-ps/exchange/Set-AddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-addresslist +online version: https://learn.microsoft.com/powershell/module/exchange/set-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-AddressList schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-AddressList cmdlet to modify existing address lists. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -63,11 +63,11 @@ The Conditional parameters that are used with the IncludedRecipients parameter a - The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPath filter. +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. -You can't use this cmdlet to replace a precanned filter with a custom OPath filter, or vice-versa. You can only modify the existing filter. +You can't use this cmdlet to replace a precanned filter with a custom OPATH filter, or vice-versa. You can only modify the existing filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -560,7 +560,7 @@ Accept wildcard characters: False ### -ForceUpgrade This parameter is available only in on-premises Exchange. -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -642,16 +642,16 @@ Accept wildcard characters: False ``` ### -RecipientFilter -The RecipientFilter parameter specifies a custom OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -687,12 +687,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md b/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md index 68776ef9c2..09836f6007 100644 --- a/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md +++ b/exchange/exchange-ps/exchange/Set-AddressRewriteEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-addressrewriteentry +online version: https://learn.microsoft.com/powershell/module/exchange/set-addressrewriteentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-AddressRewriteEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-AddressRewriteEntry cmdlet to modify an existing address rewrite entry that rewrites sender and recipient email addresses in messages sent to or sent from your organization through an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -112,7 +112,7 @@ Accept wildcard characters: False ``` ### -ExceptionList -The ExceptionList parameter specifies the domain names that should be excluded from address rewriting when the InternalAddress parameter contains a value that specifies multiple domain names. You can separate multiple domain names included with the ExceptionList parameter with commas. For more information about how to add values to or remove values from multivalued properties, see [Modifying multivalued properties](https://docs.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). +The ExceptionList parameter specifies the domain names that should be excluded from address rewriting when the InternalAddress parameter contains a value that specifies multiple domain names. You can separate multiple domain names included with the ExceptionList parameter with commas. For more information about how to add values to or remove values from multivalued properties, see [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). ```yaml Type: MultiValuedProperty @@ -222,12 +222,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md index 1ac4ec72a7..6812c3cc6d 100644 --- a/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md +++ b/exchange/exchange-ps/exchange/Set-AdminAuditLogConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-adminauditlogconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-adminauditlogconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-AdminAuditLogConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-AdminAuditLogConfig cmdlet to configure the administrator audit logging configuration settings. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +47,7 @@ Administrator audit logging relies on Active Directory replication to replicate Changes to the audit log configuration may take up to 60 minutes to be applied on computers that have the Exchange Management Shell open at the time a configuration change is made. If you want to apply the changes immediately, close and reopen the Exchange Management Shell on each computer. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -139,7 +139,12 @@ Accept wildcard characters: False ### -AdminAuditLogEnabled This parameter is available only in on-premises Exchange. -The AdminAuditLogEnabled parameter specifies whether administrator audit logging is enabled. The default value is $true. The valid values are $true and $false. You must specify an administrator audit log mailbox before you enable logging. +The AdminAuditLogEnabled parameter specifies whether administrator audit logging is enabled. Valid values are: + +- $true: Administrator audit logging is enabled. This is the default value. +- $false: Administrator audit logging is disabled. + +You must specify an administrator audit log mailbox before you enable logging. Changes to the administrator audit log configuration are always logged, regardless of whether audit logging is enabled or disabled. @@ -233,7 +238,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -250,9 +257,10 @@ Accept wildcard characters: False ### -LogLevel This parameter is available only in on-premises Exchange. -The LogLevel parameter specifies whether additional properties should be included in the log entries. Valid values are None and Verbose. +The LogLevel parameter specifies whether additional properties should be included in the log entries. Valid values are: -By default, the CmdletName, ObjectName, Parameters (values), and the Caller, Succeeded and RunDate properties are included in log entries. When the Verbose value is used, the ModifiedProperties (old and new) and ModifiedObjectResolvedName properties are included in the log entries. +- None: The CmdletName, ObjectName, Parameters (values), and the Caller, Succeeded and RunDate properties are included in log entries. This is the default value. +- Verbose: The ModifiedProperties (old and new) and ModifiedObjectResolvedName properties are also included in log entries. ```yaml Type: AuditLogLevel @@ -290,7 +298,10 @@ Accept wildcard characters: False ### -TestCmdletLoggingEnabled This parameter is available only in on-premises Exchange. -The TestCmdletLoggingEnabled parameter specifies whether the execution of test cmdlets should be logged. Test cmdlets begin with the verb Test. Valid values are $true and $false. The default value is $false. +The TestCmdletLoggingEnabled parameter specifies whether test cmdlets (cmdlet names that begin with the verb Test) results are included in admin audit logging. Valid values are: + +- $true: Test cmdlets are included in admin audit logging. +- $false: Test cmdlets aren't included in admin audit logging. This is the default value. Test cmdlets can produce a large amount of information. As such, you should only enable logging of test cmdlets for a short period of time. @@ -308,12 +319,12 @@ Accept wildcard characters: False ``` ### -UnifiedAuditLogIngestionEnabled -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The UnifiedAuditLogIngestionEnabled parameter specifies whether to enable or disable the recording of user and admin activities in the Microsoft 365 audit log. Valid values are: -- $true: User and admin activities are recorded in the Microsoft 365 audit log, and you can search the Microsoft 365 audit log. -- $false: User and admin activities aren't recorded in the Microsoft 365 audit log, and you can't search the Microsoft 365 audit log. This is the default value. +- $true: User and admin activities are recorded in the Microsoft 365 audit log, and admins can search the Microsoft 365 audit log. This is the default value. +- $false: User and admin activities aren't recorded in the Microsoft 365 audit log, and admins can't search the Microsoft 365 audit log. ```yaml Type: Boolean @@ -347,12 +358,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md index a691b7afe8..a552fa50b5 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-antiphishpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-antiphishpolicy applicable: Exchange Online, Exchange Online Protection title: Set-AntiPhishPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-AntiPhishPolicy cmdlet to modify antiphish policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,6 +25,8 @@ Set-AntiPhishPolicy -Identity [-AdminDisplayName ] [-AuthenticationFailAction ] [-Confirm] + [-DmarcQuarantineAction ] + [-DmarcRejectAction ] [-Enabled ] [-EnableFirstContactSafetyTips ] [-EnableMailboxIntelligence ] @@ -42,24 +42,29 @@ Set-AntiPhishPolicy -Identity [-EnableViaTag ] [-ExcludedDomains ] [-ExcludedSenders ] + [-HonorDmarcPolicy ] [-ImpersonationProtectionState ] [-MailboxIntelligenceProtectionAction ] [-MailboxIntelligenceProtectionActionRecipients ] + [-MailboxIntelligenceQuarantineTag ] [-MakeDefault] [-PhishThresholdLevel ] [-PolicyTag ] + [-SpoofQuarantineTag ] [-TargetedDomainActionRecipients ] [-TargetedDomainProtectionAction ] + [-TargetedDomainQuarantineTag ] [-TargetedDomainsToProtect ] [-TargetedUserActionRecipients ] [-TargetedUserProtectionAction ] + [-TargetedUserQuarantineTag ] [-TargetedUsersToProtect ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -125,8 +130,8 @@ This setting is part of spoof protection. The AuthenticationFailAction parameter specifies the action to take when the message fails composite authentication (a mixture of traditional SPF, DKIM, and DMARC email authentication checks and proprietary backend intelligence). Valid values are: -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- MoveToJmf: This is the default value. Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. ```yaml Type: SpoofAuthenticationFailAction @@ -160,11 +165,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DmarcQuarantineAction +This setting is part of spoof protection. + +The DmarcQuarantineAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=quarantine`. Valid values are: + +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. This is the default value. + +```yaml +Type: SpoofDmarcQuarantineAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DmarcRejectAction +This setting is part of spoof protection. + +The DmarcRejectAction parameter specifies the action to take when a message fails DMARC checks and the sender's DMARC policy is `p=reject`. Valid values are: + +- Quarantine: Deliver the message to quarantine. +- Reject: Reject the message. This is the default value. + +This parameter is meaningful only when the HonorDmarcPolicy parameter is set to the value $true. + +```yaml +Type: SpoofDmarcRejectAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Enabled -The Enabled parameter specifies whether the antiphish policy is enabled or disabled. Valid values are: +This parameter is reserved for internal Microsoft use. + +To enable or disable an existing anti-phishing policy (the combination of the antiphish rule and the associated antiphish policy), use the **Enable-AntiPhishRule** or **Disable-AntiPhishRule** cmdlets. + +To create a disabled anti-phishing policy, use `-Enabled $false` on the **New-AntiPhishRule** cmdlet. -- $true: The policy is enabled. -- $false: The policy is disabled. +In the output of the **Get-AntiPhishRule** cmdlet, whether the anti-phishing policy is enabled or disabled is visible in the State property. ```yaml Type: Boolean @@ -199,7 +251,7 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligence -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligence parameter specifies whether to enable or disable mailbox intelligence, which is artificial intelligence (AI) that determines user email patterns with their frequent contacts. Mailbox intelligence helps distinguish between messages from legitimate and impersonated senders based on a recipient's previous communication history. Valid values are: @@ -220,7 +272,7 @@ Accept wildcard characters: False ``` ### -EnableMailboxIntelligenceProtection -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The EnableMailboxIntelligenceProtection specifies whether to enable or disable taking action for impersonation detections from mailbox intelligence results. Valid values are: @@ -245,9 +297,9 @@ Accept wildcard characters: False ``` ### -EnableOrganizationDomainsProtection -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: +The EnableOrganizationDomainsProtection parameter specifies whether to enable domain impersonation protection for all registered domains in the Microsoft 365 organization. Valid values are: - $true: Domain impersonation protection is enabled for all registered domains in the Microsoft 365 organization. - $false: Domain impersonation protection isn't enabled for all registered domains in the Microsoft 365 organization. This is the default value. You can enable protection for specific domains by using the EnableTargetedDomainsProtection and TargetedDomainsToProtect parameters. @@ -266,9 +318,9 @@ Accept wildcard characters: False ``` ### -EnableSimilarDomainsSafetyTips -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: +The EnableSimilarDomainsSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for domain impersonation detections. Valid values are: - $true: Safety tips for similar domains are enabled. - $false: Safety tips for similar domains are disabled. This is the default value. @@ -287,9 +339,9 @@ Accept wildcard characters: False ``` ### -EnableSimilarUsersSafetyTips -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: +The EnableSimilarUsersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for user impersonation detections. Valid values are: - $true: Safety tips for similar users are enabled. - $false: Safety tips for similar users are disabled. This is the default value. @@ -312,7 +364,7 @@ This setting is part of spoof protection. The EnableSpoofIntelligence parameter specifies whether to enable or disable antispoofing protection for the policy. Valid values are: -- $true: Antispoofing is enabled for the policy. This is the default and recommended value. You specify the spoofed senders to allow or block using the Set-PhishFilterPolicy cmdlet. +- $true: Antispoofing is enabled for the policy. This is the default and recommended value. Use the \*-TenantAllowBlockListSpoofItems, Get-SpoofIntelligenceInsight, and Get-SpoofMailReport cmdlets to view and specify the spoofed senders to allow or block. - $false: Antispoofing is disabled for the policy. We only recommend this value if you have a domain that's protected by another email filtering service. ```yaml @@ -329,9 +381,9 @@ Accept wildcard characters: False ``` ### -EnableTargetedDomainsProtection -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: +The EnableTargetedDomainsProtection parameter specifies whether to enable domain impersonation protection for a list of specified domains. Valid values are: - $true: Domain impersonation protection is enabled for the domains specified by the TargetedDomainsToProtect parameter. - $false: The TargetedDomainsToProtect parameter isn't used. This is the default value. @@ -350,9 +402,9 @@ Accept wildcard characters: False ``` ### -EnableTargetedUserProtection -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: +The EnableTargetedUserProtection parameter specifies whether to enable user impersonation protection for a list of specified users. Valid values are: - $true: User impersonation protection is enabled for the users specified by the TargetedUsersToProtect parameter. - $false: The TargetedUsersToProtect parameter isn't used. This is the default value. @@ -373,15 +425,15 @@ Accept wildcard characters: False ### -EnableUnauthenticatedSender This setting is part of spoof protection. -The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: +The EnableUnauthenticatedSender parameter enables or disables unauthenticated sender identification in Outlook. Valid values are: - $true: This is the default value. A question mark (?) is applied to the sender's photo if the message does not pass SPF or DKIM checks AND the message does not pass DMARC or composite authentication. - $false: A question mark is never applied to the sender's photo. To prevent these identifiers from being added to messages from specific senders, you have the following options: -- Allow the sender to spoof in the spoof intelligence policy. For instructions, see [Configure spoof intelligence in Microsoft 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). -- If you own the sender's domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://docs.microsoft.com/microsoft-365/security/office-365-security/email-validation-and-authentication#configure-email-authentication-for-domains-you-own). +- Allow the sender to spoof in the spoof intelligence policy. For instructions, see [Configure spoof intelligence in Microsoft 365](https://learn.microsoft.com/defender-office-365/anti-spoofing-spoof-intelligence). +- If you own the domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://learn.microsoft.com/defender-office-365/email-authentication-about). ```yaml Type: Boolean @@ -397,9 +449,9 @@ Accept wildcard characters: False ``` ### -EnableUnusualCharactersSafetyTips -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: +The EnableUnusualCharactersSafetyTips parameter specifies whether to enable the safety tip that's shown to recipients for unusual characters in domain and user impersonation detections. Valid values are: - $true: Safety tips for unusual characters are enabled. - $false: Safety tips for unusual characters are disabled. This is the default value. @@ -420,15 +472,15 @@ Accept wildcard characters: False ### -EnableViaTag This setting is part of spoof protection. -The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: +The EnableViaTag parameter enables or disables adding the via tag to the From address in Outlook (chris@contso.com via fabrikam.com). Valid values are: - $true: The via tag is added to the From address (the message sender that's displayed in email clients) if the domain in the From address is different from the domain in the DKIM signature or the MAIL FROM address. This is the default value. - $false: The via tag is not added to the From address. To prevent the via tag from being added to messages from specific senders, you have the following options: -- Allow the sender to spoof. For instructions, see [Configure spoof intelligence in Microsoft 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). -- If you own the sender's domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://docs.microsoft.com/microsoft-365/security/office-365-security/email-validation-and-authentication#configure-email-authentication-for-domains-you-own). +- Allow the sender to spoof. For instructions, see [Configure spoof intelligence in Microsoft 365](https://learn.microsoft.com/defender-office-365/anti-spoofing-spoof-intelligence). +- If you own the domain, configure email authentication for the domain. For more information, see [Configure email authentication for domains you own](https://learn.microsoft.com/defender-office-365/email-authentication-about). ```yaml Type: Boolean @@ -444,12 +496,14 @@ Accept wildcard characters: False ``` ### -ExcludedDomains -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. +The ExcludedDomains parameter specifies an exception for impersonation protection that looks for the specified domains in the message sender. You can specify multiple domains separated by commas. The maximum number of entries is approximately 1000. +**Note**: Domain entries don't include subdomains of the specified domain. You need to add an entry for each subdomain. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -464,9 +518,9 @@ Accept wildcard characters: False ``` ### -ExcludedSenders -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. +The ExcludedSenders parameter specifies an exception for impersonation protection that looks for the specified message sender. You can specify multiple email addresses separated by commas. The maximum number of entries is approximately 1000. @@ -483,8 +537,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HonorDmarcPolicy +This setting is part of spoof protection. + +The HonorDmarcPolicy enables or disables using the sender's DMARC policy to determine what to do to messages that fail DMARC checks. Valid values are: + +- $true: If a message fails DMARC and the sender's DMARC policy is `p=quarantine` or `p=reject`, the DmarcQuarantineAction or DmarcRejectAction parameters specify the action to take on the message. This is the default value. +- $false: If the message fails DMARC, ignore the action in the sender's DMARC policy. The AuthenticationFailAction parameter specifies the action to take on the message. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ImpersonationProtectionState -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The ImpersonationProtectionState parameter specifies the configuration of impersonation protection. Valid values are: @@ -506,16 +581,16 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionAction -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The MailboxIntelligenceProtectionAction parameter specifies what to do with messages that fail mailbox intelligence protection. Valid values are: - NoAction: This is the default value. Note that this value has the same result as setting the EnableMailboxIntelligenceProtection parameter to $false when the EnableMailboxIntelligence parameter is $true. - BccMessage: Add the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter to the Bcc field of the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. -- Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the MailboxIntelligenceProtectionActionRecipients parameter. This parameter is meaningful only if the EnableMailboxIntelligence and EnableMailboxIntelligenceProtection parameters are set to the value $true. @@ -533,9 +608,9 @@ Accept wildcard characters: False ``` ### -MailboxIntelligenceProtectionActionRecipients -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. +The MailboxIntelligenceProtectionActionRecipients parameter specifies the recipients to add to detected messages when the MailboxIntelligenceProtectionAction parameter is set to the value Redirect or BccMessage. A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. @@ -552,8 +627,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxIntelligenceQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The MailboxIntelligenceQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by mailbox intelligence (the MailboxIntelligenceProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by mailbox intelligence impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MakeDefault -The MakeDefault switch makes the specified antiphish policy the default antiphish policy. You don't have to specify a value with this switch. +The MakeDefault switch makes this antiphish policy the default antiphish policy. You don't need to specify a value with this switch. The default antiphish policy is applied to everyone (no corresponding antiphish rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). @@ -571,7 +674,7 @@ Accept wildcard characters: False ``` ### -PhishThresholdLevel -This setting is part of advanced settings and is only available in Microsoft Defender for Office 365. +This setting is part of advanced settings and is available only in Microsoft Defender for Office 365. The PhishThresholdLevel parameter specifies the tolerance level that's used by machine learning in the handling of phishing messages. Valid values are: @@ -609,10 +712,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SpoofQuarantineTag +The SpoofQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by spoof intelligence (the AuthenticationFailAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by spoof intelligence protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetedDomainActionRecipients -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. +The TargetedDomainActionRecipients parameter specifies the recipients to add to detected domain impersonation messages when the TargetedDomainProtectionAction parameter is set to the value Redirect or BccMessage. A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. @@ -630,16 +759,16 @@ Accept wildcard characters: False ``` ### -TargetedDomainProtectionAction -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: +The TargetedDomainProtectionAction parameter specifies the action to take on detected domain impersonation messages. You specify the protected domains in the TargetedDomainsToProtect parameter. Valid values are: - NoAction: This is the default value. -- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. +- BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message, and deliver the message to the Junk Email folder of all (original + BCC-ed) recipients' mailboxes. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. -- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. ```yaml Type: MultiValuedProperty @@ -654,8 +783,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetedDomainQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedDomainQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by domain impersonation protection (the TargetedDomainProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by domain impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetedDomainsToProtect -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedDomainsToProtect parameter specifies the domains that are included in domain impersonation protection when the EnableTargetedDomainsProtection parameter is set to $true. @@ -675,9 +832,9 @@ Accept wildcard characters: False ``` ### -TargetedUserActionRecipients -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. +The TargetedUserActionRecipients parameter specifies the replacement or additional recipients for detected user impersonation messages when the TargetedUserProtectionAction parameter is set to the value Redirect or BccMessage. A valid value for this parameter is an email address. You can specify multiple email addresses separated by commas. @@ -695,16 +852,16 @@ Accept wildcard characters: False ``` ### -TargetedUserProtectionAction -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. -The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: +The TargetedUserProtectionAction parameter specifies the action to take on detected user impersonation messages. You specify the protected users in the TargetedUsersToProtect parameter. Valid values are: - NoAction: This is the default value. - BccMessage: Add the recipients specified by the TargetedDomainActionRecipients parameter to the Bcc field of the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are only available to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. -- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. +- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. +- Quarantine: Move the message to quarantine. Quarantined high confidence phishing messages are available only to admins. As of April 2020, quarantined phishing messages are available to the intended recipients. +- Redirect: Redirect the message to the recipients specified by the TargetedDomainActionRecipients parameter. ```yaml Type: MultiValuedProperty @@ -719,8 +876,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetedUserQuarantineTag +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. + +The TargetedUserQuarantineTag specifies the quarantine policy that's used on messages that are quarantined by user impersonation protection (the TargetedUserProtectionAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined by user impersonation protection as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetedUsersToProtect -This setting is part of impersonation protection and is only available in Microsoft Defender for Office 365. +This setting is part of impersonation protection and is available only in Microsoft Defender for Office 365. The TargetedUsersToProtect parameter specifies the users that are included in user impersonation protection when the EnableTargetedUserProtection parameter is set to $true. @@ -728,7 +913,8 @@ This parameter uses the syntax: "DisplayName;EmailAddress". - DisplayName specifies the display name of the user that could be a target of impersonation. This value can contain special characters. - EmailAddress specifies the internal or external email address that's associated with the display name. -- You can specify multiple values by using the syntax: "DisplayName1;EmailAddress1","DisplayName2;EmailAddress2",..."DisplayNameN;EmailAddressN". The combination of DisplayName and EmailAddress needs to be unique for each value. +- You can specify multiple values that overwrite any existing values by using the syntax: `"DisplayName1;EmailAddress1","DisplayName2;EmailAddress2",..."DisplayNameN;EmailAddressN"`. The combination of DisplayName and EmailAddress needs to be unique for each value. +- You can append new values by using the syntax: `@{Add="NewDisplayName1;NewEmailAddress1","NewDisplayName2;NewEmailAddress2",..."NewDisplayNameN;NewEmailAddressN"}` or remove an existing value using the syntax: `@{Remove="OldDisplayName1;OldEmailAddress1"}`. ```yaml Type: MultiValuedProperty @@ -764,12 +950,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md index 7cd7913660..9d41dff174 100644 --- a/exchange/exchange-ps/exchange/Set-AntiPhishRule.md +++ b/exchange/exchange-ps/exchange/Set-AntiPhishRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-antiphishrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-antiphishrule applicable: Exchange Online, Exchange Online Protection title: Set-AntiPhishRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-AntiPhishRule cmdlet to modify antiphish rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +38,10 @@ Set-AntiPhishRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Common policy settings](https://learn.microsoft.com/defender-office-365/anti-phishing-policies-about#common-policy-settings). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -129,7 +130,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -170,7 +171,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -235,7 +236,7 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -276,7 +277,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -323,12 +324,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-App.md b/exchange/exchange-ps/exchange/Set-App.md index 9422855e91..af5a021961 100644 --- a/exchange/exchange-ps/exchange/Set-App.md +++ b/exchange/exchange-ps/exchange/Set-App.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-app +online version: https://learn.microsoft.com/powershell/module/exchange/set-app applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-App schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-App cmdlet to modify the availability of organization apps. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,15 +39,16 @@ The Set-App cmdlet can only be used when configuring the availability of an orga Default apps in Outlook on the web and apps that you've installed for use by users in your organization are known as organization apps. Organization apps can't be removed by end users, but can be enabled or disabled. If an app is an organization app (scope default or organization), the delete control on the toolbar is disabled for end users. Administrators are able to remove organization apps. Administrators can't remove default apps, but they can disable them for the entire organization. -For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://docs.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://docs.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). +For more information, see [Manage user access to add-ins for Outlook in Exchange Server](https://learn.microsoft.com/Exchange/manage-user-access-to-add-ins-exchange-2013-help) and [Manage deployment of add-ins in the Microsoft 365 admin center](https://learn.microsoft.com/office365/admin/manage/manage-deployment-of-add-ins). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $a= Get-DistributionGroupMember -Identity "Finance Team" + Set-App -OrganizationApp -Identity 3f10017a-9bbe-4a23-834b-6a8fe3af0e37 -ProvidedTo SpecificUsers -UserList $a.Identity -DefaultStateForUser Enabled ``` @@ -212,7 +213,7 @@ Accept wildcard characters: False ``` ### -UserList -The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://docs.microsoft.com/office/dev/add-ins/publish/centralized-deployment). +The UserList parameter specifies who can use an organizational app. This parameter is limited to 1000 users. In the cloud-based service, this value is less relevant as Office Add-in management is moving to [Centralized Deployment](https://learn.microsoft.com/office/dev/add-ins/publish/centralized-deployment). Valid values are mailboxes or mail users in your organization. You can use any value that uniquely identifies the user. For example: @@ -265,12 +266,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md new file mode 100644 index 0000000000..d7b88cea53 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AppRetentionCompliancePolicy.md @@ -0,0 +1,660 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancepolicy +applicable: Security & Compliance +title: Set-AppRetentionCompliancePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-AppRetentionCompliancePolicy + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Set-AppRetentionCompliancePolicy to modify app retention compliance policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### Identity (Default) +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-AddExchangeLocation ] + [-AddExchangeLocationException ] + [-AddModernGroupLocation ] + [-AddModernGroupLocationException ] + [-Applications ] + [-Comment ] + [-Confirm] + [-DeletedResources ] + [-Enabled ] + [-Force] + [-PolicyRBACScopes ] + [-RemoveExchangeLocation ] + [-RemoveExchangeLocationException ] + [-RemoveModernGroupLocation ] + [-RemoveModernGroupLocationException ] + [-RestrictiveRetention ] + [-WhatIf] + [] +``` + +### AdaptiveScopeLocation +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-AddAdaptiveScopeLocation ] + [-Applications ] + [-Comment ] + [-Confirm] + [-DeletedResources ] + [-Enabled ] + [-Force] + [-RemoveAdaptiveScopeLocation ] + [-WhatIf] + [] +``` + +### DisableRestrictiveRetentionParameterSet +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-DeletedResources ] + [-WhatIf] + [] +``` + +### InformationBarrierDefault +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-DeletedResources ] + [-Force] + [-WhatIf] + [] +``` + +### OrganizationSegmentsDefault +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-DeletedResources ] + [-WhatIf] + [] +``` + +### RetryDistributionParameterSet +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Confirm] + [-RetryDistribution] + [-WhatIf] + [] +``` + +### TeamLocation +``` +Set-AppRetentionCompliancePolicy [-Identity] + [-Comment ] + [-Confirm] + [-DeletedResources ] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +## DESCRIPTION +\*-AppRetentionCompliance\* cmdlets are used for policies with adaptive policy scopes and all static policies in the locations described in [Retention cmdlets for newer locations](https://learn.microsoft.com/purview/retention-cmdlets#retention-cmdlets-for-newer-locations). You can only set the list of included or excluded scopes for all included workloads, which means you likely need to create one policy per workload. + +\*-RetentionCompliance\* cmdlets continue to primarily support the locations described in [Retention cmdlets for older locations](https://learn.microsoft.com/purview/retention-cmdlets#retention-cmdlets-for-older-locations). + +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AppRetentionCompliancePolicy -Identity "Regulation 563 Marketing" -Applications "User:MicrosoftTeams","Group:MicrosoftTeams,VivaEngage" -AddExchangeLocation "Scott Smith" -Comment "Added new counsel, 9/9/21" +``` + +This example adds a new user to the existing static scope retention policy named Regulation 563 Marketing that's set up for Teams private channels messages. + +### Example 2 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'SalesUser@contoso.onmicrosoft.com' +}] +"@ +Set-AppRetentionCompliancePolicy -Identity "Teams Private Channel Retention Policy" -AddExchangeLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` +This example excludes the specified soft-deleted mailbox or mail user from the retention policy configured for Teams private channel messages. You can identify the deleted resources using the mailbox or mail user's email address. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +Policy exclusions must remain within the supported limits for retention policies. For more information, see [Limits for Microsoft 365 retention policies and retention label policies](https://learn.microsoft.com/purview/retention-limits#maximum-number-of-items-per-policy). + +### Example 3 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com' +}, +{ + 'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com' +}] +"@ +Set-AppRetentionCompliancePolicy -Identity "Teams Private Chat Retention Policy" -AddExchangeLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +This example is similar to Example 2, except multiple deleted resources are specified. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -RetryDistribution +The RetryDistribution switch specifies whether to redistribute the policy to all locations. You don't need to specify a value with this switch. + +Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. + +**Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. + +```yaml +Type: SwitchParameter +Parameter Sets: RetryDistributionParameterSet +Aliases: +Applicable: Security & Compliance + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddAdaptiveScopeLocation +The AddAdaptiveScopeLocation parameter specifies the adaptive scope location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocation +The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group (all mailboxes that are currently members of the group). + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddExchangeLocationException +The AddExchangeLocationException parameter specifies the mailboxes to add to the list of excluded mailboxes when you're using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddModernGroupLocation +The AddModernGroupLocation parameter specifies the Microsoft 365 Groups to add to the list of included Microsoft 365 Groups when you aren't using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddModernGroupLocationException +The AddModernGroupLocationException parameter specifies the Microsoft 365 Groups to add to the list of excluded Microsoft 365 Groups when you're using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Applications +The Applications parameter specifies the applications to include in the policy. + +This parameter uses the following syntax: `"LocationType:App1,LocationType:App2,...LocationType:AppN`: + +`LocationType` is User or Group. + +`App` is a supported value as shown in the following examples. + +- **Microsoft 365 apps**: For example: + + `"User:Exchange,User:OneDriveForBusiness,Group:Exchange,Group:SharePoint"` or `"User:MicrosoftTeams","User:VivaEngage"` + +- **Microsoft Copilot experiences**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:M365Copilot,CopilotForSecurity,CopilotinFabricPowerBI,CopilotStudio,CopilotinBusinessApplicationplatformsSales,SQLCopilot"` + + **Note**: Even though you must use `CopilotinBusinessApplicationplatformsSales` and `SQLCopilot`, those values are currently irrelevant. + +- **Enterprise AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:Entrabased3PAIApps,ChatGPTEnterprise,AzureAIServices"` + +- **Other AI apps**: Currently in Preview. You must use *all* of the following values at the same time: + + `"User:CloudAIAppChatGPTConsumer,CloudAIAppGoogleGemini,BingConsumer,DeepSeek"` + +```yaml +Type: String[] +Parameter Sets: Identity, AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedResources +The DeletedResources parameter specifies the deleted mailbox or mail user to add as an exclusion to the respective location list. Use this parameter with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users that need to be excluded from a Teams only retention policy. + +A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. + +For information about the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365). + +**CAUTION**: This parameter uses the SMTP address of the deleted mailbox or mail user, which might also be specified for other mailboxes or mail users. If you use this parameter without first taking additional steps, other mailboxes and mail users with the same SMTP address in the retention policy will also be excluded. To check for additional mailboxes or mail users with the same SMTP address, use the following command and replace `user@contoso.com` with the SMTP address to check: `Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com | Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted` + +To prevent active mailboxes or mail users with the same SMTP address from being excluded, put the mailbox on [Litigation Hold](https://learn.microsoft.com/purview/ediscovery-create-a-litigation-hold) before you run the command with the DeletedResources parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +The Enabled parameter enables or disables the policy. Valid values are: + +- $true: The policy is enabled. This is the default value. +- $false: The policy is disabled. + +```yaml +Type: Boolean +Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, AdaptiveScopeLocation, TeamLocation, InformationBarrierDefault +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +**Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. + +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAdaptiveScopeLocation +The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocationException +The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: + +- A mailbox +- A distribution group or mail-enabled security group + +To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveModernGroupLocation +The RemoveModernGroupLocation parameter specifies the Microsoft 365 Groups to remove from the list of included groups when you aren't using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveModernGroupLocationException +The RemoveModernGroupLocationException parameter specifies the Microsoft 365 Groups to remove from the list of excluded groups when you're using the value All for the ModernGroupLocation parameter. + +You can use any value that uniquely identifies the Microsoft 365 Group. For example: + +- Name +- Distinguished name (DN) +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictiveRetention +The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy. Valid values are: + +- $true: Preservation Lock is enabled for the policy. No one -- including an administrator -- can turn off the policy or make it less restrictive. +- $false: Preservation Lock isn't enabled for the policy. This is the default value. + +After a policy has been locked, no one can turn off or disable it, or remove apps from the policy. The only ways that you can modify the policy are by adding apps to it, or extending its duration. A locked policy can be increased or extended, but it can't be reduced, disabled, or turned off. + +Therefore, before you lock a policy, it's critical that you understand your organization's compliance requirements, and that you don't lock a policy until you are certain that it's what you need. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md new file mode 100644 index 0000000000..a6b2925a84 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-AppRetentionComplianceRule.md @@ -0,0 +1,314 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-appretentioncompliancerule +applicable: Security & Compliance +title: Set-AppRetentionComplianceRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-AppRetentionComplianceRule + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +Use the Set-AppRetentionComplianceRule to modify app retention compliance rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-AppRetentionComplianceRule [-Identity] + [-Comment ] + [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentDateFrom ] + [-ContentDateTo ] + [-ContentMatchQuery ] + [-ExcludedItemClasses ] + [-ExpirationDateOption ] + [-RetentionComplianceAction ] + [-RetentionDuration ] + [-RetentionDurationDisplayHint ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-AppRetentionComplianceRule -Identity "563 Marketing Rule" -RetentionDuration 180 -RetentionDurationDisplayHint Days +``` + +This example updates the length of the retention duration for a rule named 563 Marketing Rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the app retention compliance rule that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. + +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. + +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateFrom +{{ Fill ContentDateFrom Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentDateTo +{{ Fill ContentDateTo Description }} + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchQuery +The ContentMatchQuery parameter specifies a content search filter. + +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludedItemClasses +The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won't exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy. Common Skype for Business values include: + +- IPM.Note.Microsoft.Conversation +- IPM.Note.Microsoft.Conversation.Voice +- IPM.Note.Microsoft.Missed +- IPM.Note.Microsoft.Missed.Voice +- IPM.Note.Microsoft.Voicemail +- IPM.Note.Microsoft.VoiceMessage.UA +- IPM.Note.Microsoft.Voicemail.UM +- IPM.Note.Microsoft.Voicemail.UM.CA + +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. + +You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDateOption +The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: + +- CreationAgeInDays +- ModificationAgeInDays + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionComplianceAction +The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: + +- Delete +- Keep +- KeepAndDelete + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDuration +The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: + +- An integer: The hold duration in days. +- Unlimited: The content is held indefinitely. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RetentionDurationDisplayHint +The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. + +- Days +- Months +- Years + +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. + +```yaml +Type: HoldDurationHint +Parameter Sets: (All) +Aliases: +Accepted values: Days, Months, Years +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +The WhatIf switch doesn't work in Security & Compliance PowerShell. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md index 408b788d13..dd98f50127 100644 --- a/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ApplicationAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-applicationaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection title: Set-ApplicationAccessPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-ApplicationAccessPolicy cmdlet to modify the description of an application access policy. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +31,7 @@ Set-ApplicationAccessPolicy [-Identity] ## DESCRIPTION This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +116,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ArcConfig.md b/exchange/exchange-ps/exchange/Set-ArcConfig.md new file mode 100644 index 0000000000..5bf267a358 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ArcConfig.md @@ -0,0 +1,186 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-arcconfig +applicable: Exchange Online, Exchange Online Protection +title: Set-ArcConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ArcConfig + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ArcConfig cmdlet to modify the list of trusted Authenticated Received Chain (ARC) sealers that are configured in the cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ArcConfig [-Identity] -ArcTrustedSealers + [-Confirm] + [-WhatIf] + [] +``` + +## DESCRIPTION +Services that modify message content in transit before delivery can invalidate DKIM email signatures and affect the authentication of the message. These services can use ARC to provide details of the original authentication before the modifications occurred. Your organization can then trust these details to help authenticate the message. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ArcConfig -Identity Default -ArcTrustedSealers fabrikam.com +``` + +This example configures "fabrikam.com" as the only trusted ARC sealer in the organization. + +### Example 2 +```powershell +$DomainsAdd = @(Get-ArcConfig | select -Expand ArcTrustedSealers) + +$DomainsAdd += "cohovineyard.com","tailspintoys.com" + +Set-ArcConfig -Identity Default -ArcTrustedSealers $DomainsAdd +``` + +This example adds the trusted ARC sealers "cohovineyard.com" and "tailspintoys.com" without affecting the other trusted ARC sealer entries. + +### Example 3 +```powershell +$x = @(Get-ArcConfig | select -Expand ArcTrustedSealers) + +$y = $x.Split(",") + +$DomainsRemove = [System.Collections.ArrayList]($y) + +$DomainsRemove + +$DomainsRemove.RemoveAt(6) + +Set-ArcConfig -Identity Default -ArcTrustedSealers $DomainsRemove +``` + +This example modifies the trusted ARC sealers list by removing an existing ARC sealer without affecting other ARC sealers that are already specified. + +The first four commands return the existing list of ARC sealers. The first ARC sealer in the list has the index number 0, the second has the index number 1, and so on. Use the index number to specify the ARC sealer that you want to remove. + +The last two commands remove the seventh ARC sealer that's displayed in the list. + +### Example 4 +```powershell +$arcSealer = 'fabrikam.com' +$x = @(Get-ArcConfig | Select-Object -Expand ArcTrustedSealers) + +$y = @($x.Split(",")) +$DomainsRemove = [System.Collections.ArrayList]($y) +$DomainsRemove.Remove($arcSealer) + +if ($DomainsToRemove.Count -eq 0) { + Set-ArcConfig -Identity Default -ArcTrustedSealers " " + } +else { + Set-ArcConfig -Identity Default -ArcTrustedSealers $DomainsRemove + } +``` + +This example removes the specified ARC sealer from the list (`$arcSealer`). + +If no other ARC sealers exist after removing this entry from the list, using the value `" "` for the ArcTrustedSealers parameter avoids a bind argument error if the `$DomainsToRemove` value is empty. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the trusted ARC sealers list that you want to modify. Use one of the following values: + +- Default for your own organization. +- \\Default for delegated organizations. The \ value is a GUID that's visible in many admin portal URLs in Microsoft 365 (the tid= value). For example, a32d39e2-3702-4ff5-9628-31358774c091. + +```yaml +Type: HostedConnectionFilterPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -ArcTrustedSealers +The ArcTrustedSealers parameter specifies the domain name of the ARC sealers that you want to add. + +The domain name must match the domain that's shown in the `d` tag in the **ARC-Seal** and **ARC-Message-Signature** headers in affected email messages (for example, fabrikam.com). You can use Outlook to see these headers. + +To replace the existing list of ARC sealers with the values you specify, use the syntax `Domain1,Domain2,...DomainN`. To preserve existing values, be sure to include the entries that you want to keep along with the new values that you want to add. + +To add or remove values without affecting the other entries, see the Examples section in this article. + +To empty the list, use the value `" "` (a space enclosed in double quotation marks). + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md index 2b48796302..bcdc6c3dd1 100644 --- a/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md +++ b/exchange/exchange-ps/exchange/Set-AtpPolicyForO365.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-atppolicyforo365 -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-atppolicyforo365 +applicable: Exchange Online title: Set-AtpPolicyForO365 schema: 2.0.0 author: chrisda @@ -20,41 +20,34 @@ Use the Set-AtpPolicyForO365 cmdlet to modify the settings for the following fea - Safe Documents: Uses Microsoft Defender for Endpoint to scan documents and files that are opened in Protected View in Microsoft 365 apps for enterprise. - Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-AtpPolicyForO365 [[-Identity] ] - [-AllowClickThrough ] [-AllowSafeDocsOpen ] - [-BlockUrls ] [-Confirm] [-EnableATPForSPOTeamsODB ] [-EnableSafeDocs ] - [-EnableSafeLinksForO365Clients ] - [-EnableSafeLinksForWebAccessCompanion ] - [-TrackClicks ] [-WhatIf] [] ``` ## DESCRIPTION -Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see [Safe Links settings for Office 365 apps](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#safe-links-settings-for-office-365-apps). +Safe Links protection for Office 365 apps checks links in Office documents, not links in email messages. For more information, see [Safe Links settings for Office 365 apps](https://learn.microsoft.com/defender-office-365/safe-links-about#safe-links-settings-for-office-apps). -Safe Documents scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-docs). +Safe Documents scans documents and files that are opened in Protected View. For more information, see [Safe Documents in Microsoft 365 E5](https://learn.microsoft.com/defender-office-365/safe-documents-in-e5-plus-security-about). -Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-for-spo-odb-and-teams). +Safe Attachments for SharePoint, OneDrive, and Microsoft Teams prevents users from opening and downloading files that are identified as malicious. For more information, see [Safe Attachments for SharePoint, OneDrive, and Microsoft Teams](https://learn.microsoft.com/defender-office-365/safe-attachments-for-spo-odfb-teams-about). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-AtpPolicyForO365 -EnableSafeLinksForClients $true -EnableATPForSPOTeamsODB $true +Set-AtpPolicyForO365 -EnableATPForSPOTeamsODB $true ``` This example enables Safe Documents and Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. @@ -68,7 +61,7 @@ The Identity parameter specifies the policy that you want to modify. There's onl Type: AtpPolicyForO365IdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: 1 @@ -77,25 +70,6 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -AllowClickThrough -The AllowClickThrough parameter specifies whether to allow users to click through to the original blocked URL in Safe Links protection for Office apps. Valid values are: - -- $true: Users are allowed to click through to the original URL in supported Office apps. -- $false: Users aren't allowed to click through to the original URL in supported Office apps. This is the default value. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AllowSafeDocsOpen The AllowSafeDocsOpen parameter specifies whether users can click through and bypass the Protected View container even when Safe Documents identifies a file as malicious. Valid values are: @@ -117,28 +91,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BlockUrls -The BlockUrls parameter specifies the URLs that are always blocked by Safe Links in email messages and Safe Links for Office 365 apps. - -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. - -For details about the entry syntax, see [Entry syntax for the "Block the following URLs" list](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-block-the-following-urls-list). - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -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. @@ -149,7 +101,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -161,14 +113,14 @@ Accept wildcard characters: False ### -EnableATPForSPOTeamsODB The EnableATPForSPOTeamsODB parameter enables or disables Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. Valid values are: -- $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint Online admins can use the DisallowInfectedFileDownload parameter on the [Set-SPOTenant](https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant) cmdlet to control whether users are allowed to download files that are found to be malicious. +- $true: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is enabled. SharePoint admins can use the DisallowInfectedFileDownload parameter on the [Set-SPOTenant](https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOTenant) cmdlet to control whether users are allowed to download files that are found to be malicious. - $false: Safe Attachments for SharePoint, OneDrive, and Microsoft Teams is disabled. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -178,72 +130,18 @@ Accept wildcard characters: False ``` ### -EnableSafeDocs -The EnableSafeDocs parameter enables or disables Safe Documents in Microsoft 365 E5 or Microsoft 365 E5 Security organizations. Valid values are: +The EnableSafeDocs parameter enables or disables Safe Documents in organizations with Microsoft 365 A5 or Microsoft 365 E5 Security licenses. Valid values are: - $true: Safe Documents is enabled and will upload user files to Microsoft Defender for Endpoint for scanning and verification. - $false: Safe Documents is disabled. This is the default value. -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSafeLinksForO365Clients -The EnableSafeLinksForO365Clients parameter enables or disables Safe Links for Office 365 apps. Valid values are: - -- $true: Safe Links scanning is enabled in supported Office 365 apps. This is the default value. -- $false: Safe Links scanning is disabled in supported Office 365 apps. - -Note that this protection applies to links in Office documents, not links in email messages. Safe Links protection for links in email messages is controlled by Safe Links policies (the [New-SafeLinksPolicy](https://docs.microsoft.com/powershell/module/exchange/new-safelinkspolicy) or [Set-SafeLinksPolicy](https://docs.microsoft.com/powershell/module/exchange/set-safelinkspolicy) cmdlets). +For more information about Safe Documents, see [Safe Documents in Microsoft 365 A5 or E5 Security](https://learn.microsoft.com/defender-office-365/safe-documents-in-e5-plus-security-about) ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSafeLinksForWebAccessCompanion -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrackClicks -The TrackClicks parameter specifies whether to track user clicks related to blocked URLs in Safe Links for Office 365 apps. Valid values are: - -- $true: User clicks in supported Office 365 apps are tracked. -- $false: User clicks in supported Office 365 apps aren't tracked. This is the default value. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -259,7 +157,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -273,12 +171,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md b/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md index b6f2295735..0bc5e542b8 100644 --- a/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md +++ b/exchange/exchange-ps/exchange/Set-AttachmentFilterListConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-attachmentfilterlistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-AttachmentFilterListConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-AttachmentFilterListConfig cmdlet to modify the configuration of the Attachment Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -174,12 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AuditConfig.md b/exchange/exchange-ps/exchange/Set-AuditConfig.md index 3f0c221cd0..e2c5d20cfd 100644 --- a/exchange/exchange-ps/exchange/Set-AuditConfig.md +++ b/exchange/exchange-ps/exchange/Set-AuditConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-auditconfig -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-auditconfig +applicable: Security & Compliance title: Set-AuditConfig schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-AuditConfig ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-AuditConfig cmdlet to configure the auditing configuration in the Microsoft 365 compliance center. +Use the Set-AuditConfig cmdlet to configure the auditing configuration in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Set-AuditConfig [[-Identity] ] -Workload -AuditOperation - [-Confirm] - [-DomainController ] - [-WhatIf] - [] -``` - -## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-AuditConfigurationRule 989a3a6c-dc40-4fa4-8307-beb3ece992e9 -AuditOperation @{Add="CheckOut"} -``` - -This example modifies an existing SharePoint auditing rule. The check-out operation is added to the rule without affecting the existing operations that are already being audited. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the audit configuration rule that you want to modify. The name of the rule is a GUID value. For example, 989a3a6c-dc40-4fa4-8307-beb3ece992e9. You can find the name value by running the following command: Get-AuditConfigurationRule | Format-List Name,Workload,AuditOperation,Policy. - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -AuditOperation -The AuditOperation parameter specifies the operations that are audited by the rule. Valid values are: - -- Administrate -- CheckIn -- CheckOut -- Count -- CreateUpdate -- Delete -- Forward -- MoveCopy -- PermissionChange -- ProfileChange -- SchemaChange -- Search -- SendAsOthers -- View -- Workflow - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AuthConfig.md b/exchange/exchange-ps/exchange/Set-AuthConfig.md index d52506ff96..a6ffa805ac 100644 --- a/exchange/exchange-ps/exchange/Set-AuthConfig.md +++ b/exchange/exchange-ps/exchange/Set-AuthConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-authconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-authconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-AuthConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AuthConfig cmdlet to modify the authorization configuration for your Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -69,13 +69,13 @@ Set-AuthConfig [-Realm ] ## DESCRIPTION The Set-AuthConfig parameter defines Microsoft Exchange as a partner application for server-to-server authentication with other partner applications such as Microsoft SharePoint 2013 and Microsoft Lync 2013 or Skype for Business Server 2015, including the certificate used for signing tokens. It's generally not required for this configuration to be modified except in some cases where you must use a different certificate instead of the self-signed certificate created by Exchange Setup or to use a new certificate after the old one has expired. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-AuthConfig -NewCertificateThumbprint DB821B4FCA2A5DA9593B9DE00C86BC5EA35D0FC0 -NewCertificateEffectiveDate 4/17/2013 +Set-AuthConfig -NewCertificateThumbprint DB821B4FCA2A5DA9593B9DE00C86BC5EA35D0FC0 -NewCertificateEffectiveDate 4/17/2014 ``` This example specifies a new certificate and a date when the certificate will become effective. @@ -106,7 +106,7 @@ Accept wildcard characters: False ``` ### -ClearPreviousCertificate -The ClearPreviousCertificate switch clears the certificate saved as the previous certificate in the authorization configuration. +The ClearPreviousCertificate switch clears the certificate that was saved as the previous certificate in the authorization configuration. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -157,7 +157,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -205,7 +207,9 @@ Accept wildcard characters: False ``` ### -PublishCertificate -The PublishCertificate switch specifies that the specified certificate be immediately rolled over as the current certificate. The certificate is immediately deployed to all Client Access servers. +The PublishCertificate switch immediately rolls over the specified certificate as the current certificate. You don't need to specify a value with this switch. + +The certificate is immediately deployed to all Client Access servers. ```yaml Type: SwitchParameter @@ -271,7 +275,9 @@ Accept wildcard characters: False ``` ### -SkipImmediateCertificateDeployment -The SkipImmediateCertificateDeployment switch specifies that the certificate shouldn't be used immediately. We recommend that you don't use this parameter in a production environment. +The SkipImmediateCertificateDeployment switch specifies that the certificate shouldn't be used immediately. You don't need to specify a value with this switch. + +We don't recommend using this switch in a production environment. ```yaml Type: SwitchParameter @@ -307,12 +313,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AuthRedirect.md b/exchange/exchange-ps/exchange/Set-AuthRedirect.md index 131416885a..e39dde30f7 100644 --- a/exchange/exchange-ps/exchange/Set-AuthRedirect.md +++ b/exchange/exchange-ps/exchange/Set-AuthRedirect.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-authredirect +online version: https://learn.microsoft.com/powershell/module/exchange/set-authredirect applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-AuthRedirect schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AuthRedirect cmdlet to modify the existing OAuth redirection settings for Microsoft Exchange 2010 Client Access servers in your Microsoft Exchange 2013 organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,13 +30,13 @@ Set-AuthRedirect [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-AuthRedirect AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE -TargetUrl https://mbx01.contoso.com +Set-AuthRedirect -Identity AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE -TargetUrl https://mbx01.contoso.com ``` This example sets the TargetURL value to `https://mbx01.contoso.com` for the existing OAuth redirection object named `AuthRedirect-Bearer-C0B7AC3F-FE64-4B4B-A907-9226F8027CCE`. @@ -138,12 +138,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AuthServer.md b/exchange/exchange-ps/exchange/Set-AuthServer.md index d199209e90..7caef4d3c2 100644 --- a/exchange/exchange-ps/exchange/Set-AuthServer.md +++ b/exchange/exchange-ps/exchange/Set-AuthServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-authserver +online version: https://learn.microsoft.com/powershell/module/exchange/set-authserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-AuthServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AuthServer cmdlet to configure an authorization server that partner applications can use to obtain tokens recognized by Microsoft Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,12 +62,25 @@ Set-AuthServer [-Identity] [] ``` +### AppSecret +``` +Set-AuthServer [-Identity] + [-ApplicationIdentifier ] + [-Confirm] + [-DomainController ] + [-DomainName ] + [-Enabled ] + [-Name ] + [-WhatIf] + [] +``` + ## DESCRIPTION Partner applications authorized by Exchange can access their resources after they're authenticated using server-to-server authentication. A partner application can authenticate by using self-issued tokens trusted by Exchange or by using an authorization server trusted by Exchange. You can use the New-AuthServer cmdlet to create a trusted authorization server object in Exchange, which allows it to trust tokens issued by the authorization server. Use the Set-AuthServer cmdlet to enable or disable the authorization server, change the AuthMetadataUrl parameter or refresh authorization metadata. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -100,6 +113,24 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -ApplicationIdentifier +This parameter is available in the April 18, 2025 Hotfix update (HU) for Exchange 2019 CU15 and Exchange 2016 CU23. + +{{ Fill ApplicationIdentifier Description }} + +```yaml +Type: String +Parameter Sets: AppSecret +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AuthMetadataUrl The AuthMetadataUrl parameter specifies the URL of the authorization server. This can be the AuthMetadataUrl of your Exchange Online organization. @@ -152,7 +183,11 @@ Accept wildcard characters: False ``` ### -DomainName -{{ Fill DomainName Description }} +This parameter is available only in Exchange Server 2016 (CU18 or higher) and Exchange Server 2019 (CU7 or higher). + +The DomainName parameter specifies the tenant domain that's linked with the AuthServer object. This parameter uses the syntax: "tenantname.onmicrosoft.com". + +This parameter is used to link Tenant to the corresponding authserver object in the Multi-Tenant Exchange Hybrid. For example, if DomainName is contoso.onmicrosoft.com, then the AuthServer object will be associated with the contoso tenant. ```yaml Type: MultiValuedProperty @@ -241,7 +276,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether Exchange should accept certificates from an untrusted certification authority. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. We don't recommend using this switch in a production environment. @@ -279,12 +314,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md b/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md index 459950286b..5f9a01b922 100644 --- a/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AuthenticationPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-authenticationpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-authenticationpolicy applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-AuthenticationPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-AuthenticationPolicy cmdlet to modify authentication policies in your organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,6 +34,7 @@ Set-AuthenticationPolicy [-Identity] [-AllowBasicAuthRpc] [-AllowBasicAuthSmtp] [-AllowBasicAuthWebServices] + [-AllowLegacyExchangeTokens] [-BlockLegacyAuthActiveSync] [-BlockLegacyAuthAutodiscover] [-BlockLegacyAuthImap] @@ -44,13 +43,23 @@ Set-AuthenticationPolicy [-Identity] [-BlockLegacyAuthPop] [-BlockLegacyAuthRpc] [-BlockLegacyAuthWebServices] + [-BlockLegacyExchangeTokens] + [-BlockModernAuthActiveSync] + [-BlockModernAuthAutodiscover] + [-BlockModernAuthImap] + [-BlockModernAuthMapi] + [-BlockModernAuthOfflineAddressBook] + [-BlockModernAuthPop] + [-BlockModernAuthRpc] + [-BlockModernAuthWebServices] [-Confirm] + [-TenantId ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,6 +77,13 @@ Set-AuthenticationPolicy -Identity "Research and Development Group" -BlockLegacy In Exchange 2019, this example re-enables Basic authentication for Exchange Reporting Web Services in the authentication policy named Research and Development Group. +### Example 3 +```powershell +Set-AuthenticationPolicy -Identity "LegacyExchangeTokens" -BlockLegacyExchangeTokens +``` + +In Exchange Online, this example blocks legacy Exchange tokens from being issued to Outlook add-ins. The switch applies to the entire organization, and the Identity parameter must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. + ## PARAMETERS ### -Identity @@ -96,7 +112,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthActiveSync switch specifies whether to allow Basic authentication with Exchange Active Sync. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthActiveSync:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthActiveSync:$false`. ```yaml Type: SwitchParameter @@ -117,7 +133,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthAutodiscover switch specifies whether to allow Basic authentication with Autodiscover. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthAutodiscover:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthAutodiscover:$false`. ```yaml Type: SwitchParameter @@ -138,7 +154,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthImap switch specifies whether to allow Basic authentication with IMAP. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthImap:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthImap:$false`. ```yaml Type: SwitchParameter @@ -159,7 +175,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthMapi switch specifies whether to allow Basic authentication with MAPI. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAutMapi:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAutMapi:$false`. ```yaml Type: SwitchParameter @@ -180,7 +196,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthOfflineAddressBook switch specifies whether to allow Basic authentication with Offline Address Books. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthOfflineAddressBook:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthOfflineAddressBook:$false`. ```yaml Type: SwitchParameter @@ -201,7 +217,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthOutlookService switch specifies whether to allow Basic authentication with the Outlook service. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthOutlookService:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthOutlookService:$false`. ```yaml Type: SwitchParameter @@ -222,7 +238,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthPop switch specifies whether to allow Basic authentication with POP. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthPop:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthPop:$false`. ```yaml Type: SwitchParameter @@ -243,7 +259,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthPowerShell switch specifies whether to allow Basic authentication with PowerShell. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthPowershell:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthPowershell:$false`. ```yaml Type: SwitchParameter @@ -264,7 +280,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthReporting Web Services switch specifies whether to allow Basic authentication with reporting web services. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthReportingWebServices:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthReportingWebServices:$false`. ```yaml Type: SwitchParameter @@ -285,7 +301,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthRpc switch specifies whether to allow Basic authentication with RPC. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthRpc:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthRpc:$false`. ```yaml Type: SwitchParameter @@ -306,7 +322,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthSmtp switch specifies whether to allow Basic authentication with SMTP. - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthSmtp:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthSmtp:$false`. ```yaml Type: SwitchParameter @@ -327,7 +343,7 @@ This parameter is available only in the cloud-based service. The AllowBasicAuthWebServices switch specifies whether to allow Basic authentication with Exchange Web Services (EWS). - To allow Basic authentication for the protocol, use this switch without a value. -- To block Basic authentication for the protocol, use this exact syntax: -AllowBasicAuthWebServices:$false. +- To block Basic authentication for the protocol, use this exact syntax: `-AllowBasicAuthWebServices:$false`. ```yaml Type: SwitchParameter @@ -342,13 +358,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowLegacyExchangeTokens +This parameter is available only in the cloud-based service. + +The AllowLegacyExchangeTokens switch specifies to allow legacy Exchange tokens to be issued to Outlook add-ins. You don't need to specify a value with this switch. + +Legacy Exchange tokens include Exchange user identity and callback tokens. + +The switch applies to the entire organization. The Identity parameter is required and must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. + +**Important**: + +- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes. +- It might take up to 24 hours for the change to take effect across your entire organization. +- As of February 17 2025, legacy Exchange tokens are blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BlockLegacyAuthActiveSync This parameter is available only in on-premises Exchange. The BlockLegacyAuthActiveSync switch specifies whether to allow only modern authentication with Exchange ActiveSync in Exchange 2019 CU2 or later hybrid environments. - To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for ActiveSync, use this switch without a value. -- To allow legacy authentication methods for ActiveSync, use this exact syntax: -BlockLegacyAuthActiveSync:$false. +- To allow legacy authentication methods for ActiveSync, use this exact syntax: `-BlockLegacyAuthActiveSync:$false`. ```yaml Type: SwitchParameter @@ -369,7 +413,7 @@ This parameter is available only in on-premises Exchange. The BlockLegacyAuthAutodiscover switch specifies whether to allow only modern authentication with Autodiscover in Exchange 2019 CU2 or later hybrid environments. - To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for Autodiscover, use this switch without a value. -- To allow legacy authentication methods for Autodiscover, use this exact syntax: -BlockLegacyAuthAutodiscover:$false. +- To allow legacy authentication methods for Autodiscover, use this exact syntax: `-BlockLegacyAuthAutodiscover:$false`. ```yaml Type: SwitchParameter @@ -390,7 +434,7 @@ This parameter is available only in on-premises Exchange. The BlockLegacyAuthImap switch specifies whether to allow only modern authentication with IMAP in Exchange 2019 CU2 or later hybrid environments. - To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for IMAP, use this switch without a value. -- To allow legacy authentication methods for IMAP, use this exact syntax: -BlockLegacyAuthImap:$false. +- To allow legacy authentication methods for IMAP, use this exact syntax: `-BlockLegacyAuthImap:$false`. ```yaml Type: SwitchParameter @@ -411,7 +455,7 @@ This parameter is available only in on-premises Exchange. The BlockLegacyAuthMapi switch specifies whether to allow only modern authentication with MAPI in Exchange 2019 CU2 or later hybrid environments. - To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for MAPI, use this switch without a value. -- To allow legacy authentication methods for MAPI, use this exact syntax: -BlockLegacyAuthMapi:$false. +- To allow legacy authentication methods for MAPI, use this exact syntax: `-BlockLegacyAuthMapi:$false`. ```yaml Type: SwitchParameter @@ -432,7 +476,7 @@ This parameter is available only in on-premises Exchange. The BlockLegacyAuthOfflineAddressBook switch specifies whether to allow only modern authentication with Offline Address Books in Exchange 2019 CU2 or later hybrid environments. - To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for Offline Address Books, use this switch without a value. -- To allow legacy authentication methods for OfflineAddressBooks, use this exact syntax: -BlockLegacyAuthOfflineAddressBook:$false. +- To allow legacy authentication methods for OfflineAddressBooks, use this exact syntax: `-BlockLegacyAuthOfflineAddressBook:$false`. ```yaml Type: SwitchParameter @@ -453,7 +497,7 @@ This parameter is available only in on-premises Exchange. The BlockLegacyAuthPop switch specifies whether to allow only modern authentication with POP in Exchange 2019 CU2 or later hybrid environments. - To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for POP, use this switch without a value. -- To allow legacy authentication methods for POP, use this exact syntax: -BlockLegacyAuthPop:$false. +- To allow legacy authentication methods for POP, use this exact syntax: `-BlockLegacyAuthPop:$false`. ```yaml Type: SwitchParameter @@ -474,7 +518,7 @@ This parameter is available only in on-premises Exchange. The BlockLegacyAuthRpc switch specifies whether to allow only modern authentication with RPC in Exchange 2019 CU2 or later hybrid environments. - To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for RPC, use this switch without a value. -- To allow legacy authentication methods for RPC, use this exact syntax: -BlockLegacyAuthRpc:$false. +- To allow legacy authentication methods for RPC, use this exact syntax: `-BlockLegacyAuthRpc:$false`. ```yaml Type: SwitchParameter @@ -495,7 +539,181 @@ This parameter is available only in on-premises Exchange. The BlockLegacyAuthWebServices switch specifies whether to allow only modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU2 or later hybrid environments. - To block Basic authentication, Digest authentication, and Windows authentication (NTLM and Kerberos) for EWS, use this switch without a value. -- To allow legacy authentication methods for EWS, use this exact syntax: -BlockLegacyAuthWebServices:$false. +- To allow legacy authentication methods for EWS, use this exact syntax: `-BlockLegacyAuthWebServices:$false`. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockLegacyExchangeTokens +This parameter is available only in the cloud-based service. + +The BlockLegacyExchangeTokens switch specifies to block legacy Exchange tokens being issued to Outlook add-ins. You don't need to specify a value with this switch. + +Legacy Exchange tokens include Exchange user identity and callback tokens. + +The switch applies to the entire organization. The Identity parameter is required and must be set to the value "LegacyExchangeTokens". Specific authentication policies can't be applied. + +**Important**: + +- Apart from the Identity parameter, this switch disregards other authentication policy parameters used in the same command. We recommend running separate commands for other authentication policy changes. +- It might take up to 24 hours for the change to take effect across your entire organization. +- Legacy Exchange tokens issued to Outlook add-ins before token blocking was implemented in your organization will remain valid until they expire. +- Blocking legacy Exchange tokens might cause some Microsoft add-ins to stop working. These add-ins are being updated to no longer use legacy tokens. +- As of February 17 2025, legacy Exchange tokens are blocked by default in all cloud-based organizations. For more information, see [Nested app authentication and Outlook legacy tokens deprecation FAQ](https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens#what-is-the-timeline-for-shutting-down-legacy-exchange-online-tokens). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthActiveSync +This parameter is available only in on-premises Exchange. + +The BlockModernAuthActiveSync switch specifies whether to block modern authentication with Exchange ActiveSync in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthAutodiscover +This parameter is available only in on-premises Exchange. + +The BlockModernAuthAutodiscover switch specifies whether to block modern authentication with Autodiscover in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthImap +This parameter is available only in on-premises Exchange. + +The BlockModernAuthImap switch specifies whether to block modern authentication with IMAP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthMapi +This parameter is available only in on-premises Exchange. + +The BlockModernAuthMapi switch specifies whether to block modern authentication with MAPI in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthOfflineAddressBook +This parameter is available only in on-premises Exchange. + +The BlockModernAuthOfflineAddressBook switch specifies whether to block modern authentication with Offline Address Books in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthPop +This parameter is available only in on-premises Exchange. + +The BlockModernAuthPop switch specifies whether to block modern authentication with POP in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthRpc +This parameter is available only in on-premises Exchange. + +The BlockModernAuthRpc switch specifies whether to block modern authentication with RPC in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockModernAuthWebServices +This parameter is available only in on-premises Exchange. + +The BlockModernAuthWebServices switch specifies whether to block modern authentication with Exchange Web Services (EWS) in Exchange 2019 CU13 or later. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -529,6 +747,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TenantId +This parameter is available only in the cloud-based service. + +{{ Fill TenantId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -550,12 +786,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md index 06930dba1a..08f50e337c 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-autosensitivitylabelpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-autosensitivitylabelpolicy +applicable: Security & Compliance title: Set-AutoSensitivityLabelPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-AutoSensitivityLabelPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-AutoSensitivityLabelPolicy cmdlet to modify auto-labeling policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,21 +29,39 @@ Set-AutoSensitivityLabelPolicy [-Identity] [-AddSharePointLocation ] [-AddSharePointLocationException ] [-ApplySensitivityLabel ] + [-AutoEnableAfter ] [-Comment ] [-Confirm] [-Enabled ] + [-ExceptIfOneDriveSharedBy ] + [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] [-ExchangeSender ] [-ExchangeSenderException ] [-ExchangeSenderMemberOf ] [-ExchangeSenderMemberOfException ] + [-ExternalMailRightsManagementOwner ] [-Force] + [-Locations ] [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] + [-OneDriveSharedBy ] + [-OneDriveSharedByMemberOf ] + [-OverwriteLabel ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] [-Priority ] [-RemoveExchangeLocation ] [-RemoveOneDriveLocation ] [-RemoveOneDriveLocationException ] [-RemoveSharePointLocation ] [-RemoveSharePointLocationException ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] + [-SpoAipIntegrationEnabled ] + [-StartSimulation ] [-WhatIf] [] ``` @@ -71,7 +89,7 @@ Set-AutoSensitivityLabelPolicy [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -80,7 +98,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Set-AutoSensitivityLabelPolicy -Identity "Main PII" -AddSharePointLocation "https://my.url1/","https://my.url2/" -AddOneDriveLocation "https://my.url3/","https://my.url4/" ``` -This example adds the specified URLs to the SharePoint Online and OneDrive for Business locations for the autolabeling policy named Main PII without affecting the existing URL values. +This example adds the specified URLs to the SharePoint and OneDrive locations for the autolabeling policy named Main PII without affecting the existing URL values. ## PARAMETERS @@ -95,7 +113,7 @@ The Identity parameter specifies the auto-labeling policy that you want to modif Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -105,13 +123,27 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation -This AddExchangeLocation parameter specifies new Exchange locations to be added to the policy without affecting the existing ones. +The AddExchangeLocation parameter adds email messages to the policy if they're not already included. The valid value for this parameter is All. + +If the policy doesn't already include email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is blank), you can use this parameter in the following procedures: + +- If you use `-AddExchangeLocation All` by itself, the policy applies to email for all internal users. + +- To include email of specific internal or external users in the policy, use `-AddExchangeLocation All` with the ExchangeSender parameter in the same command. Only email of the specified users is included in the policy. + +- To include email of specific group members in the policy, use `-AddExchangeLocation All` with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy. + +- To exclude email of specific internal users from the policy, use `-AddExchangeLocation All` with the ExchangeSenderException parameter in the same command. Only email of the specified users is excluded from the policy. + +- To exclude email of specific group members from the policy, use `-AddExchangeLocation All` with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy. + +You can't specify inclusions and exclusions in the same policy. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -121,15 +153,15 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation -The AddOneDriveLocation parameter specifies the OneDrive for Business sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. +The AddOneDriveLocation parameter specifies the OneDrive sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: ,,.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "","",..."". +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -139,15 +171,15 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException -The AddOneDriveLocationException parameter specifies the OneDrive for Business sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. +The AddOneDriveLocationException parameter specifies the OneDrive sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: ,,.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "","",..."". +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -157,17 +189,17 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -SharePoint Online sites can't be added to the policy until they have been indexed. +SharePoint sites can't be added to the policy until they have been indexed. -To enter multiple values, use the following syntax: ,,.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "","",..."". +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -177,15 +209,15 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException -The AddSharePointLocationException parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocationException parameter specifies the SharePoint sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: ,,.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "","",..."". }} +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -201,7 +233,29 @@ The ApplySensitivityLabel parameter selects which label to be used for the polic Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoEnableAfter +The AutoEnableAfter parameter allows you to automatically turn on the policy after a set time period in simulation with no modifications to the policy. You need to explicitly set this parameter after each policy edit to keep or reset the automatic turn on timeline. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +A valid value is between 1 hour and 25 days. To clear an existing AutoEnableAfter schedule that's associated with a policy, use the value $null. + +You must use this parameter with the -StartSimulation parameter. + +```yaml +Type: System.TimeSpan +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -217,7 +271,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -236,7 +290,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -255,7 +309,80 @@ The Enabled parameter enables or disables the policy. Valid values are: Type: Boolean Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedBy +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, one of the following statements must be true: + +- The policy already includes OneDrive sites (in the output of Get-AutoSensitivityLabelPolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfOneDriveSharedByMemberOf +{{ Fill ExceptIfOneDriveSharedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopes +{{ Fill ExchangeAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopesException +{{ Fill ExchangeAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -265,13 +392,22 @@ Accept wildcard characters: False ``` ### -ExchangeSender -The ExchangeSender parameter specifies the sender list in Exchange for which the policy should include. +The ExchangeSender parameter specifies the users whose email is included in the policy. You specify the users by email address. You can specify internal or external email addresses. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters. ```yaml Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -281,13 +417,22 @@ Accept wildcard characters: False ``` ### -ExchangeSenderException -The ExchangeSenderException parameter specifies the sender list in Exchange for which the policy should exclude. +The ExchangeSenderException parameter specifies the internal users whose email is excluded from the policy. You identify the users by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of Get-AutoSensitivityLabelPolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. ```yaml Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -297,9 +442,16 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf -The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the autolabeling policy. You identify the group by its email address. +The ExchangeSenderMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. -To enter multiple values, use the following syntax: ,,.... +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of Get-AutoSensitivityLabelPolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSenderException or ExchangeSenderMemberOfException parameters. You can't use this parameter to specify Microsoft 365 Groups. @@ -307,7 +459,7 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -317,9 +469,16 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException -The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the autolabeling policy. You identify the group by its email address. +The ExchangeSenderMemberOfException parameter specifies the distribution groups or mail-enabled security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: + +- The policy already includes email messages (in the output of Get-AutoSensitivityLabelPolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. -To enter multiple values, use the following syntax: ,,.... +You can't use this parameter with the ExchangeSender or ExchangeSenderMemberOf parameters. You can't use this parameter to specify Microsoft 365 Groups. @@ -327,7 +486,27 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: SmtpAddress[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExternalMailRightsManagementOwner +The ExternalMailRightsManagementOwner parameter specifies the email address of a user mailbox that's used to encrypt incoming email messages from external senders using RMS. + +This parameter works only on Exchange locations, and the policy must apply a label that has an encryption action. + +To clear an existing email address, use the value $null. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -337,13 +516,31 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +{{ Fill Locations Description }} + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -353,7 +550,7 @@ Accept wildcard characters: False ``` ### -Mode -The Mode parameter specifies the action and notification level of the autolabel policy. Valid values are: +The Mode parameter specifies the action and notification level of the auto-labeling policy. Valid values are: - Enable: The policy is enabled for actions and notifications. - Disable: The policy is disabled. @@ -365,7 +562,135 @@ Type: PolicyMode Parameter Sets: (All) Aliases: Accepted values: Enable, TestWithNotifications, TestWithoutNotifications, Disable, PendingDeletion -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopes +{{ Fill OneDriveAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopesException +{{ Fill OneDriveAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedBy +The OneDriveSharedBy parameter specifies the users to include in the policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, one of the following statements must be true: + +- The policy already includes OneDrive sites (in the output of Get-AutoSensitivityLabelPolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveSharedByMemberOf +{{ Fill OneDriveSharedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteLabel +The OverwriteLabel parameter specifies whether to overwrite a manual label. Valid values are: + +- $true: Overwrite the manual label. +- $false: Don't overwrite the manual label. This is the default value. + +This parameter works only on Exchange locations. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -389,7 +714,7 @@ If you modify the priority value of a policy, the position of the policy in the Type: System.Int32 Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -399,13 +724,17 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation -The RemoveExchangeLocation parameter removes locations on Exchange from the policy. +The RemoveExchangeLocation parameter removes email messages from the policy if they're already included. The valid value for this parameter is All. + +If the policy already includes email messages (in the output of the Get-AutoSensitivityLabelPolicy cmdlet, the ExchangeLocation property value is All), you can use `-RemoveExchangeLocation All` to prevent the policy from applying to email messages. + +You can't use this parameter if email (the value Exchange) is used by any of the associated rules. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -415,15 +744,15 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation -The RemoveOneDriveLocation parameter specifies the OneDrive for Business sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. +The RemoveOneDriveLocation parameter specifies the OneDrive sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: ,,.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "","",..."". +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -433,15 +762,15 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException -This RemoveOneDriveLocationException parameter specifies the OneDrive for Business sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. +This RemoveOneDriveLocationException parameter specifies the OneDrive sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: ,,.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "","",..."". +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -451,15 +780,15 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: ,,.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "","",..."". +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -469,15 +798,15 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException -The RemoveSharePointLocationException parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocationException parameter specifies the SharePoint sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. -To enter multiple values, use the following syntax: ,,.... If the values contain spaces or otherwise require quotation marks, use the following syntax: "","",..."". +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -487,7 +816,7 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. You don't need to specify a value with this switch. +The RetryDistribution switch redistributes the policy to all OneDrive and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -497,7 +826,7 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistributionParameterSet Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -506,14 +835,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SharePointAdaptiveScopes +{{ Fill SharePointAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopesException +{{ Fill SharePointAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SpoAipIntegrationEnabled +The SpoAipIntegrationEnabled parameter enables or disables built-in labeling for supported Office files in SharePoint and OneDrive. Valid values are: + +- $true: Users can apply your sensitivity labels in Office for the web. Users see the Sensitivity button on the ribbon so they can apply labels, and they see the name of any applied label on the status bar. +- $false: Users can't apply your sensitivity labels in Office for the web. Also, coauthoring, eDiscovery, Microsoft Purview data loss prevention, search, and other collaborative features don't work for encrypted files. + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartSimulation +Use the StartSimulation parameter to restart the simulation for updated results. Valid values are: + +- $true: Restart the simulation for updated results. **Any edits to an auto-labeling policy require restarting the simulation by using this value.** +- $false: This is the default value + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -527,12 +926,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md index 9e5014a8d6..f477c1b30d 100644 --- a/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md +++ b/exchange/exchange-ps/exchange/Set-AutoSensitivityLabelRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-autosensitivitylabelrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-autosensitivitylabelrule +applicable: Security & Compliance title: Set-AutoSensitivityLabelRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-AutoSensitivityLabelRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-AutoSensitivityLabelPolicy cmdlet to modify auto-labeling policy rules in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,41 +24,67 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-AutoSensitivityLabelRule [-Identity] [-AccessScope ] [-ActivationDate ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] [-Comment ] [-Confirm] [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] + [-ContentPropertyContainsWords ] + [-DefaultSpoDocLibraryHasLabel ] [-Disabled ] + [-DocumentCreatedBy ] [-DocumentIsPasswordProtected ] [-DocumentIsUnsupported ] + [-DocumentNameMatchesWords ] + [-DocumentSizeOver ] [-ExceptIfAccessScope ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentContainsSensitiveInformation ] [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentPropertyContainsWords ] + [-ExceptIfDocumentCreatedBy ] [-ExceptIfDocumentIsPasswordProtected ] [-ExceptIfDocumentIsUnsupported ] + [-ExceptIfDocumentNameMatchesWords ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] [-ExceptIfFromMemberOf ] + [-ExceptIfHeaderMatchesPatterns ] [-ExceptIfProcessingLimitExceeded ] [-ExceptIfRecipientDomainIs ] + [-ExceptIfSenderDomainIs ] [-ExceptIfSenderIPRanges ] [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-ExceptIfSubjectMatchesPatterns ] [-ExpiryDate ] [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] [-FromMemberOf ] + [-HeaderMatchesPatterns ] [-Priority ] [-ProcessingLimitExceeded ] [-RecipientDomainIs ] [-ReportSeverityLevel ] [-RuleErrorAction ] + [-SenderDomainIs ] [-SenderIPRanges ] [-SentTo ] + [-SentToMemberOf ] + [-SourceType ] + [-SubjectMatchesPatterns ] [-WhatIf] [-Workload ] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -82,7 +108,7 @@ The Identity parameter specifies the auto-labeling policy rule that you want to Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -103,7 +129,7 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -119,7 +145,51 @@ Accept wildcard characters: False Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressContainsWords +The AnyOfRecipientAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AnyOfRecipientAddressMatchesPatterns +The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -135,7 +205,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -154,7 +224,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -168,11 +238,15 @@ The ContentContainsSensitiveInformation parameter specifies a condition for the This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"; minCount="1"; minConfidence="85"})`. +Exact Data Match sensitive types are not supported outside of Groups. + +To use groups: `@(@{operator="And"; groups=@(@{name="Default"; operator="Or"; sensitivetypes=@(@{id="<>"; name="<>"; maxcount="-1"; classifiertype="ExactMatch"; mincount="100"; confidencelevel="Medium"})})})` + ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -188,7 +262,41 @@ The ContentExtensionMatchesWords parameter specifies a condition for the auto-la Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentPropertyContainsWords +The ContentPropertyContainsWords parameter specifies a condition for the auto-labeling policy rule that's based on a property match in content. The rule is applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSpoDocLibraryHasLabel +{{ Fill DefaultSpoDocLibraryHasLabel Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -207,7 +315,23 @@ The Disabled parameter specifies whether the case hold rule is enabled or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedBy +{{ Fill DocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -217,7 +341,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -226,7 +350,7 @@ The DocumentIsPasswordProtected parameter specifies a condition for the auto-lab Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -245,7 +369,56 @@ The DocumentIsUnsupported parameter specifies a condition for the auto-labeling Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentNameMatchesWords +The DocumentNameMatchesWords parameter specifies a condition for the auto-labeling policy rule that looks for whole word matches in the name of message attachments. You can specify multiple words separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` + +The maximum individual word length is 128 characters. The maximum number of words is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentSizeOver +The DocumentSizeOver parameter specifies a condition for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in auto-labeling policy rules that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -266,7 +439,51 @@ Type: AccessScope Parameter Sets: (All) Aliases: Accepted values: InOrganization, NotInOrganization, None -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressContainsWords +The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in recipient email addresses. You can specify multiple words separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfAnyOfRecipientAddressMatchesPatterns +The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -278,13 +495,13 @@ Accept wildcard characters: False ### -ExceptIfContentContainsSensitiveInformation The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the auto-labeling policy rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. -This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, @(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"}). +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -300,7 +517,41 @@ The ExceptIfContentExtensionMatchesWords parameter specifies an exception for th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfContentPropertyContainsWords +The ExceptIfContentPropertyContainsWords parameter specifies an exception for the auto-labeling policy rule that's based on a property match in content. The rule is not applied to content that contains the specified property. + +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentCreatedBy +{{ Fill ExceptIfDocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -310,7 +561,7 @@ Accept wildcard characters: False ``` ### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the auto-labeling policy rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -319,7 +570,7 @@ The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -338,7 +589,57 @@ The ExceptIfDocumentIsUnsupported parameter specifies an exception for the auto- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesWords +The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentSizeOver +The ExceptIfDocumentSizeOver parameter specifies an exception for the auto-labeling policy rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this exception in auto-labeling policy rules that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -361,7 +662,51 @@ The ExceptIfFrom parameter specifies an exception for the auto-labeling policy r Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressContainsWords +The ExceptIfFromAddressContainsWords parameter specifies an exception for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFromAddressMatchesPatterns +The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -379,7 +724,25 @@ You can enter multiple values separated by commas. If the values contain spaces Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfHeaderMatchesPatterns +The HeaderMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -389,7 +752,7 @@ Accept wildcard characters: False ``` ### -ExceptIfProcessingLimitExceeded -The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule rule that looks for files where scanning couldn't complete. Valid values are: +The ExceptIfProcessingLimitExceeded parameter specifies an exception for the auto-labeling policy rule that looks for files where scanning couldn't complete. Valid values are: - $true: Look for files where scanning couldn't complete. - $false: Don't look for files where scanning couldn't complete. @@ -398,7 +761,7 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the aut Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -408,13 +771,31 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +The ExceptIfSenderDomainIs parameter specifies an exception for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -424,7 +805,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIPRanges -The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: +The ExceptIfSenderIpRanges parameter specifies an exception for the auto-labeling policy rule that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: - Single IP address: For example, 192.168.1.1. - IP address range: For example, 192.168.0.1-192.168.0.254. @@ -436,7 +817,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -463,7 +844,45 @@ You can use this exception in auto-labeling policies that are scoped only to Exc Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectMatchesPatterns +The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this exception in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -479,7 +898,7 @@ This parameter is reserved for internal Microsoft use. Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -495,7 +914,51 @@ This parameter is reserved for internal Microsoft use. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressContainsWords +The FromAddressContainsWords parameter specifies a condition for the auto-labeling policy rule that looks for words or phrases in the sender's email address. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word length is 128 characters. The maximum number of words or phrases is 50. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FromAddressMatchesPatterns +The FromAddressMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -511,7 +974,25 @@ This parameter is reserved for internal Microsoft use. Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HeaderMatchesPatterns +The HeaderMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in a header field by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1","regular expression2",..."regular expressionN"`. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -527,7 +1008,7 @@ This parameter is reserved for internal Microsoft use. Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -546,7 +1027,7 @@ The ProcessingLimitExceeded parameter specifies a condition for the auto-labelin Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -556,13 +1037,13 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -584,7 +1065,7 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -605,7 +1086,25 @@ Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderDomainIs +The SenderDomainIs parameter specifies a condition for the auto-labeling policy rule that looks for messages from senders with email address in the specified domains. You can specify multiple values separated by commas. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -627,7 +1126,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -654,7 +1153,61 @@ You can use this condition in auto-sensitivity policies that are scoped only to Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition for the auto-labeling policy rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You identify the groups by email address. You can specify multiple values separated by commas. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +{{ Fill SourceType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubjectMatchesPatterns +The SubjectMatchesPatterns parameter specifies a condition for the auto-labeling policy rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +You can use this condition in auto-labeling policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -664,13 +1217,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -691,7 +1244,7 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: Exchange, SharePoint, OneDriveForBusiness -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -705,12 +1258,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md index 6ed6d85ebd..21d6376337 100644 --- a/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-AutodiscoverVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-autodiscovervirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/set-autodiscovervirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-AutodiscoverVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-AutodiscoverVirtualDirectory cmdlet to configure Autodiscover virtual directories that are used in Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Set-AutodiscoverVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -338,12 +338,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md b/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md index 4a39d052df..7fc266524e 100644 --- a/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md +++ b/exchange/exchange-ps/exchange/Set-AvailabilityConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-availabilityconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-availabilityconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-AvailabilityConfig schema: 2.0.0 @@ -16,12 +16,14 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-AvailabilityConfig cmdlet to set the access level for free/busy information. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-AvailabilityConfig [-Confirm] +Set-AvailabilityConfig + [-AllowedTenantIds ] + [-Confirm] [-DomainController ] [-OrgWideAccount ] [-PerUserAccount ] @@ -34,26 +36,57 @@ The Set-AvailabilityConfig cmdlet defines two accounts or security groups: a per For cross-forest availability services to retrieve free/busy information in the current forest, they must be using one of the specified accounts, belong to one of the specified security groups, or have a username and password for one of the specified accounts or security groups. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +In Exchange Online, this cmdlet lets you update the set of tenant ids that free/busy information sharing is allowed with. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-AvailabilityConfig -PerUserAccount +Set-AvailabilityConfig -PerUserAccount exchangeserversgroup@fabrikam.com ``` -This example is useful with a trusted cross-forest Availability service. If the remote forest is trusted, and a per-user free/busy proxy account or group in the remote forest is configured to use the service account, the configuration is added to the current forest to authorize the Microsoft ActiveSync request from the remote forest. +In on-premises Exchange, this example is useful with a trusted cross-forest Availability service. If the remote forest is trusted, and a per-user free/busy proxy account or group in the remote forest is configured to use the service account, the configuration is added to the current forest to authorize the Microsoft ActiveSync request from the remote forest. ### Example 2 ```powershell -Set-AvailabilityConfig -OrgWideAccount +Set-AvailabilityConfig -OrgWideAccount orgwide@contoso.com +``` + +In on-premises Exchange, this example is useful if the remote forest isn't trusted. Because this account is used for a cross-forest free/busy proxy account or group, minimize security vulnerabilities by using the credentials of a user who doesn't have an Exchange mailbox. When you're prompted, type the username and password. + +### Example 3 +```powershell +Set-AvailabilityConfig -AllowedTenantIds "d6b0a40e-029b-43f2-9852-f3724f68ead9","87d5bade-cefc-4067-a221-794aea71922d" ``` -This example is useful if the remote forest isn't trusted. Because this account is used for a cross-forest free/busy proxy account or group, minimize security vulnerabilities by using the credentials of a user who doesn't have an Exchange mailbox. When you're prompted, type the username and password. +In Exchange Online, this example allows free/busy sharing only with the specified tenants. ## PARAMETERS +### -AllowedTenantIds +This parameter is available only in the cloud-based service. + +The AllowedTenantIds parameter specifies the tenant ID values of Microsoft 365 organization that you want to share free/busy information with (for example, d6b0a40e-029b-43f2-9852-f3724f68ead9). You can specify multiple values separated by commas. A maximum of 25 values are allowed. + +To replace all existing tenant IDs with the values you specify, use the following syntax: `"TenantID1","TenantID2",..."TenantID25"`. + +To add or remove tenant IDs without affecting other existing values, use the following syntax: `@{Add="TenantID1","TenantID2",...; Remove="TenantID3","TenantID4",...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -92,6 +125,8 @@ Accept wildcard characters: False ``` ### -OrgWideAccount +This parameter is functional only in on-premises Exchange. + The OrgWideAccount parameter specifies who has permission to issue proxy Availability service requests on an organization-wide basis. You can specify the following types of users or groups (security principals) for this parameter: - Mailbox users @@ -129,6 +164,19 @@ This parameter is available only in on-premises Exchange. The PerUserAccount parameter specifies an account or security group that has permission to issue proxy Availability service requests on a per-user basis. +You can use any value that uniquely identifies the user or group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + ```yaml Type: SecurityPrincipalIdParameter Parameter Sets: (All) @@ -163,12 +211,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md b/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md index e1744b2a66..051ad1654f 100644 --- a/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md +++ b/exchange/exchange-ps/exchange/Set-AvailabilityReportOutage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-availabilityreportoutage +online version: https://learn.microsoft.com/powershell/module/exchange/set-availabilityreportoutage applicable: Exchange Server 2010 title: Set-AvailabilityReportOutage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-AvailabilityReportOutage cmdlet to set the outages that contribute to the overall reported availability for the day. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ Set-AvailabilityReportOutage [-Identity] - ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -107,7 +107,7 @@ Accept wildcard characters: False ``` ### -ResetToOriginal -The ResetToOriginal parameter specifies whether to reset the previously selected outage value to the default value. +The ResetToOriginal switch resets the previously selected outage value to the default value. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -158,7 +158,9 @@ Accept wildcard characters: False ``` ### -Force -The Force parameter suppresses the warning or confirmation messages that appear during specific configuration changes. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -226,12 +228,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-CASMailbox.md b/exchange/exchange-ps/exchange/Set-CASMailbox.md index 4f1ea6f602..6ff7e5c704 100644 --- a/exchange/exchange-ps/exchange/Set-CASMailbox.md +++ b/exchange/exchange-ps/exchange/Set-CASMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-casmailbox +online version: https://learn.microsoft.com/powershell/module/exchange/set-casmailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-CASMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-CASMailbox cmdlet to configure client access settings on a mailbox. For example, you can configure settings for Exchange ActiveSync, Outlook, Outlook on the web, POP3, and IMAP4. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -57,6 +57,7 @@ Set-CASMailbox [-Identity] [-MAPIEnabled ] [-MapiHttpEnabled ] [-Name ] + [-OneWinNativeOutlookEnabled ] [-OutlookMobileEnabled ] [-OWAEnabled ] [-OWAforDevicesEnabled ] @@ -79,7 +80,7 @@ Set-CASMailbox [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -202,7 +203,7 @@ The ActiveSyncEnabled parameter enables or disables access to the mailbox using - $true: Access to the mailbox using ActiveSync is enabled. This is the default value. - $false. Access to the mailbox using ActiveSync is disabled. Other ActiveSync settings in this cmdlet are ignored. -For more information, see [Enable or disable Exchange ActiveSync for a mailbox in Exchange Online](https://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-exchange-activesync), or [Enable or disable Exchange ActiveSync access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/exchange-activesync/activesync-mailbox-access). +For more information, see [Enable or disable Exchange ActiveSync for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-exchange-activesync), or [Enable or disable Exchange ActiveSync access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/exchange-activesync/activesync-mailbox-access). ```yaml Type: Boolean @@ -337,16 +338,16 @@ Accept wildcard characters: False ### -EmailAddresses This parameter is available only in on-premises Exchange. -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -501,7 +502,9 @@ Accept wildcard characters: False The EwsEnabled parameter enables or disables access to the mailbox using Exchange Web Services clients. Valid values are: - $true: Access to the mailbox using EWS is enabled. This is the default value. -- $false: Access to the mailbox using EWS is disabled. The other Exchange Web Services settings in this cmdlet are ignored. +- $false: Access to the mailbox using EWS is disabled. Other Exchange Web Services settings in this cmdlet are ignored. + +The value of this parameter is meaningful only if the EwsEnabled parameter on the Set-OrganizationConfig parameter isn't set to the value $false. ```yaml Type: Boolean @@ -511,7 +514,7 @@ Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Ex Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` @@ -540,9 +543,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -566,7 +569,7 @@ The ImapEnabled parameter enables or disables access to the mailbox using IMAP4 - $true: Access to the mailbox using IMAP4 is enabled. This is the default value. - $fale: Access to the mailbox using IMAP4 is disabled. The other IMAP4 settings in this cmdlet are ignored. -For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Exchange Online](https://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). +For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Exchange Online](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). ```yaml Type: Boolean @@ -699,7 +702,7 @@ Accept wildcard characters: False ``` ### -IsOptimizedForAccessibility -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The IsOptimizedForAccessibility parameter specifies whether the mailbox is configured to use the light version of Outlook on the web. Valid values are: @@ -835,7 +838,7 @@ The MAPIEnabled parameter enables or disables access to the mailbox using MAPI c - $true: Access to the mailbox using MAPI clients is enabled. This is the default value. - $false: Access to the mailbox using MAPI clients is disabled. The other MAPI settings in this cmdlet are ignored. -For more information, see[Enable or disable MAPI for a mailbox in Exchange Online](https://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-mapi), or [Enable or disable MAPI access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/mapi-mailbox-access). +For more information, see[Enable or disable MAPI for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-mapi), or [Enable or disable MAPI access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/mapi-mailbox-access). ```yaml Type: Boolean @@ -890,6 +893,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OneWinNativeOutlookEnabled +This parameter is available only in the cloud-based service. + +The OneWinNativeOutlookEnabled parameter enables or disables access to the mailbox using the new Outlook for Windows. +Valid values are: + +- $true: Access to the mailbox using the new Outlook for Windows is enabled. This is the default value. +- $false: Access to the mailbox using the new Outlook for Windows is disabled. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OutlookMobileEnabled This parameter is available only in the cloud-based service. @@ -912,12 +937,12 @@ Accept wildcard characters: False ``` ### -OWAEnabled -The OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA). Valid values are: +The OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA) and the new Outlook for Windows. Valid values are: - $true: Access to the mailbox using Outlook on the web is enabled. This is the default value. -- $false: Access to the mailbox using Outlook on the web is disabled. The other Outlook on the web settings in this cmdlet are ignored. +- $false: Access to the mailbox using Outlook on the web and the new Outlook for Windows is disabled. The other Outlook on the web settings in this cmdlet are ignored. -For more information, see [Enable or disable Outlook on the web for a mailbox in Exchange Online](https://docs.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-outlook-web-app), or [Enable or disable Outlook on the web access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/outlook-on-the-web/mailbox-access). +For more information, see [Enable or disable Outlook on the web for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-outlook-web-app), or [Enable or disable Outlook on the web access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/outlook-on-the-web/mailbox-access). ```yaml Type: Boolean @@ -979,7 +1004,7 @@ The PopEnabled parameter enables or disables access to the mailbox using POP3 cl - $true: Access to the mailbox using POP3 clients is enabled. This is the default value. - $false: Access to the mailbox using POP3 clients is disabled. The other POP3 settings in this cmdlet are ignored. -For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Exchange Online](https://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://docs.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). +For more information, see [Enable or Disable POP3 or IMAP4 access for a user in Exchange Online](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/pop3-and-imap4/enable-or-disable-pop3-or-imap4-access), or [Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server](https://learn.microsoft.com/exchange/clients/pop3-and-imap4/configure-mailbox-access). ```yaml Type: Boolean @@ -1088,8 +1113,8 @@ Accept wildcard characters: False ### -PopUseProtocolDefaults The PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox. Valid values are: -- $true: Use the protocol defaults for IMAP4 access to the mailbox. This is the default value. -- $false: Use custom protocol settings for IMAP4 access to the mailbox. +- $true: Use the protocol defaults for POP3 access to the mailbox. This is the default value. +- $false: Use custom protocol settings for POP3 access to the mailbox. You need to set this parameter to $false when you use any of following parameters: @@ -1132,8 +1157,8 @@ Accept wildcard characters: False ### -PublicFolderClientAccess The PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: -- $true: The user can access public folders in Outlook if the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is set to the $true (the default value is $false). -- $false: The user can't access public folders in Outlook. This is the default value. +- $true: The user can access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true (the default value is $false). +- $false: The user can't access public folders in Outlook if the value of the PublicFolderShowClientControl parameter on the Set-OrganizationConfig cmdlet is $true. This is the default value. ```yaml Type: Boolean @@ -1276,12 +1301,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md b/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md new file mode 100644 index 0000000000..5901e16225 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-CASMailboxPlan.md @@ -0,0 +1,265 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-casmailboxplan +applicable: Exchange Online, Exchange Online Protection +title: Set-CASMailboxPlan +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-CASMailboxPlan + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-CASMailboxPlan cmdlet to modify Client Access services (CAS) mailbox plans in cloud-based organizations. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-CASMailboxPlan [-Identity] + [-ActiveSyncEnabled ] + [-Confirm] + [-ECPEnabled ] + [-EwsEnabled ] + [-ImapEnabled ] + [-MAPIEnabled ] + [-OWAEnabled ] + [-OwaMailboxPolicy ] + [-PopEnabled ] + [-WhatIf] + [] +``` + +## DESCRIPTION +A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-CASMailboxPlan -Identity ExchangeOnlineEnterprise -ActiveSyncEnabled $false -PopEnabled $false +``` + +This example disables Exchange ActiveSync and POP3 access to mailboxes in the CAS mailbox plan named ExchangeOnlineEnterprise. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the CAS mailbox plan that you want to modify. You can use any value that uniquely identifies the CAS mailbox plan. For example: + +- Name +- Distinguished name (DN) +- GUID + +The display name and name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, `ExchangeOnlineEnterprise` and `ExchangeOnlineEnterprise-`, respectively). + +```yaml +Type: MailboxPlanIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + +### -ActiveSyncEnabled +The ActiveSyncEnabled parameter enables or disables access to the mailbox by using Exchange Active Sync (EAS). Valid values are: + +- $true: ActiveSync access to the mailbox is enabled. This is the default value. +- $false: ActiveSync access to the mailbox is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ECPEnabled +{{ Fill ECPEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EwsEnabled +{{ Fill EwsEnabled Description }} + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ImapEnabled +The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients. Valid values are: + +- $true: IMAP4 access to the mailbox is enabled. This is default value for all CAS mailbox plans except ExchangeOnlineDeskless. +- $false: IMAP4 access to the mailbox is disabled. This is default value for ExchangeOnlineDeskless. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MAPIEnabled +{{ Fill MAPIEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OWAEnabled +{{ Fill OWAEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OwaMailboxPolicy +The OwaMailboxPolicy parameter specifies the Outlook on the web (formerly known as Outlook Web App) mailbox policy for the mailbox. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +The default value is OwaMailboxPolicy-Default. + +You can use the Get-OwaMailboxPolicy cmdlet to view the available Outlook on the web mailbox policies. + +```yaml +Type: MailboxPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PopEnabled +The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients. Valid values are: + +- $true: POP3 access to the mailbox is enabled. This is the default value. +- $false: POP3 access to the mailbox is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-CalendarNotification.md b/exchange/exchange-ps/exchange/Set-CalendarNotification.md index f7b1865804..29fe0d712f 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarNotification.md +++ b/exchange/exchange-ps/exchange/Set-CalendarNotification.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-calendarnotification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-calendarnotification +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-CalendarNotification schema: 2.0.0 author: chrisda @@ -12,11 +12,13 @@ ms.reviewer: # Set-CalendarNotification ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. The Set-CalendarNotification cmdlet allows users to set text message notification options for calendar events in their own calendar. By default, the MyTextMessaging end-user role gives access to this cmdlet, so admins can't configure text messaging notification for calendar events in user calendars. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: This cmdlet has been deprecated in Exchange Online PowerShell. The text message notification service has been discontinued in Microsoft 365. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,30 +41,20 @@ Set-CalendarNotification [-Identity] ## DESCRIPTION Users can receive text message notifications of changes to calendar events and daily agendas. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-CalendarNotification -Identity "tony@contoso.com" -CalendarUpdateNotification $true -``` - -This example enables calendar updates to be sent in text messages to the user Tony Smith. - -### Example 2 -```powershell -Set-CalendarNotification -Identity "TonySmith" -CalendarUpdateNotification $true -MeetingReminderNotification $true -MeetingReminderSendDuringWorkHour $true +Set-CalendarNotification -Identity "TonySmith" -CalendarUpdateNotification $true -MeetingReminderNotification $true -MeetingReminderSendDuringWorkHour $true -DailyAgendaNotification $true ``` -This example enables calendar updates and meeting reminders to be sent in text messages to the user Tony Smith. +This example configures the calendar in Tony's mailbox to send the following text message notifications to his mobile device: -### Example 3 -```powershell -Set-CalendarNotification -Identity contoso\tonysmith -DailyAgendaNotification $true -``` - -This example enables a daily agenda to be sent in text messages to the user Tony Smith. +- Calendar updates. +- Meeting reminders during business hours. +- Daily agendas. ## PARAMETERS @@ -84,7 +76,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -94,16 +86,16 @@ Accept wildcard characters: False ``` ### -CalendarUpdateNotification -The CalendarUpdateNotification parameter specifies whether calendar update notifications are sent to the user's mobile device. Valid values are: +The CalendarUpdateNotification parameter specifies whether calendar update text message notifications are sent to the user's mobile device. Valid values are: -- $true: Calendar update notifications are enabled. -- $false: Calendar update notifications aren't enabled. This is the default value. +- $true: Calendar update text message notifications are enabled. +- $false: Calendar update text message notifications aren't enabled. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -113,16 +105,16 @@ Accept wildcard characters: False ``` ### -CalendarUpdateSendDuringWorkHour -The CalendarUpdateSendDuringWorkHour parameter specifies whether calendar update notifications are only sent to the user's mobile device during working hours. Valid values are: +The CalendarUpdateSendDuringWorkHour parameter specifies whether calendar update text notifications are sent to the user's mobile device during working hours only. Valid values are: -- $true: Calendar update notifications are only sent during working hours. -- $false: Calendar update notifications are sent anytime. This is the default value. +- $true: Calendar update text message notifications are sent during working hours only. +- $false: Calendar update text message notifications are sent anytime. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -141,7 +133,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -151,16 +143,16 @@ Accept wildcard characters: False ``` ### -DailyAgendaNotification -The DailyAgendaNotification parameter specifies whether daily agenda notifications are sent to the user's mobile device. Valid values are: +The DailyAgendaNotification parameter specifies whether daily agenda text message notifications are sent to the user's mobile device. Valid values are: -- $true: Daily agenda notifications are sent. -- $false: Daily agenda notifications are not sent. This is the default value. +- $true: Daily agenda text message notifications are sent. +- $false: Daily agenda text message notifications aren't sent. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -170,7 +162,7 @@ Accept wildcard characters: False ``` ### -DailyAgendaNotificationSendTime -The DailyAgendaNotificationSendTime parameter specifies the time to send daily agenda notifications to the user's mobile device. +The DailyAgendaNotificationSendTime parameter specifies the time to send daily agenda text message notifications to the user's mobile device. To specify a value, enter it as a time span: hh:mm:ss where hh = hours, mm = minutes and ss = seconds. @@ -180,7 +172,7 @@ The default value is 08:00:00. Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -190,8 +182,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -214,7 +204,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -224,16 +214,16 @@ Accept wildcard characters: False ``` ### -MeetingReminderNotification -The MeetingReminderNotification parameter specifies whether meeting reminder notifications are sent to the user's mobile device. Valid values are: +The MeetingReminderNotification parameter specifies whether meeting reminder text message notifications are sent to the user's mobile device. Valid values are: -- $true: Meeting reminder notifications are sent. -- $false: Meeting reminder notifications are not sent. This is the default value. +- $true: Meeting reminder text message notifications are sent. +- $false: Meeting reminder text message notifications aren't sent. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -243,16 +233,16 @@ Accept wildcard characters: False ``` ### -MeetingReminderSendDuringWorkHour -The MeetingReminderSendDuringWorkHour parameter specifies whether meeting reminder notifications are only sent to the user's mobile device during working hours. Valid values are: +The MeetingReminderSendDuringWorkHour parameter specifies whether meeting reminder text message notifications are sent to the user's mobile device during working hours only. Valid values are: -- $true: Meeting update notifications are only sent during working hours. +- $true: Meeting update notifications are sent during working hours only. - $false: Meeting update notifications are sent anytime. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -262,13 +252,13 @@ Accept wildcard characters: False ``` ### -NextDays -The NextDays parameter specifies how many days should be sent in the daily agenda notification to the user's mobile device. A valid value is an integer between 1 and 7. The default value is 1. +The NextDays parameter specifies how many days should be sent in the daily agenda text message notification to the user's mobile device. A valid value is an integer between 1 and 7. The default value is 1. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -284,7 +274,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -298,12 +288,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md index 9184d95308..edc2b0bc9a 100644 --- a/exchange/exchange-ps/exchange/Set-CalendarProcessing.md +++ b/exchange/exchange-ps/exchange/Set-CalendarProcessing.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-calendarprocessing +online version: https://learn.microsoft.com/powershell/module/exchange/set-calendarprocessing applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-CalendarProcessing schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-CalendarProcessing cmdlet to modify calendar processing options for resource mailboxes, which include the Calendar Attendant, resource booking assistant, and calendar configuration. Note that this cmdlet is effective only on resource mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,6 +42,7 @@ Set-CalendarProcessing [-Identity] [-DeleteNonCalendarItems ] [-DeleteSubject ] [-DomainController ] + [-EnableAutoRelease ] [-EnableResponseDetails ] [-EnforceCapacity ] [-EnforceSchedulingHorizon ] @@ -51,7 +52,9 @@ Set-CalendarProcessing [-Identity] [-MaximumDurationInMinutes ] [-MinimumDurationInMinutes ] [-OrganizerInfo ] + [-PostReservationMaxClaimTimeInMinutes ] [-ProcessExternalMeetingMessages ] + [-RemoveCanceledMeetings ] [-RemoveForwardedMeetingNotifications ] [-RemoveOldMeetingMessages ] [-RemovePrivateProperty ] @@ -65,7 +68,7 @@ Set-CalendarProcessing [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -111,16 +114,39 @@ Set-CalendarProcessing -Identity "Car 53" -AutomateProcessing AutoAccept -BookIn This example allows a list of users to submit in-policy meeting requests to the equipment mailbox for Car 53. +The users you specify for the BookInPolicy using this syntax overwrite any existing values. + ### Example 7 ```powershell +$CurrentBIP = (Get-CalendarProcessing -Identity "Conference Room 1").BookInPolicy + +$AddToBIP = "shiraz@contoso.com","chris@contoso.com" + +$UpdatedBIP = $CurrentBIP + $AddToBIP + +Set-CalendarProcessing -Identity "Conference Room 1" -BookInPolicy $UpdatedBIP +``` + +This example adds Shiraz and Chris to the BookInPolicy of the room mailbox named Conference Room 1 without affecting any existing BookInPolicy values. + +The first command retrieves the current BookInPolicy values of Conference Room 1 and stores them in a variable. + +The next two commands identify the new users to add to the BookInPolicy, combine the old and new values, and store the updated list a variable. + +The last command updates the BookInPolicy value with the combined list. + +### Example 8 +```powershell $group = New-DistributionGroup "Room 221 Booking Allowed" + Update-DistributionGroupMember -Identity $group.Identity -Members karina@contoso.com,tony@contoso.com -BypassSecurityGroupManagerCheck:$true + Set-CalendarProcessing -Identity "Room 221" -AutomateProcessing AutoAccept -BookInPolicy $group.Identity -AllBookInPolicy $false ``` This example rejects meeting requests from any user who isn't a member of the "Room 221 Booking Allowed" distribution group. -### Example 8 +### Example 9 ```powershell Set-CalendarProcessing -Identity "Room 221" -ProcessExternalMeetingMessages $false ``` @@ -220,6 +246,8 @@ The AddOrganizerToSubject parameter specifies whether the meeting organizer's na This parameter is used only on resource mailboxes where the AutomateProcessing parameter is set to AutoAccept. +**Note**: Default Calendar folder permissions use the AvailabilityOnly role, which doesn't allow viewing Subject fields in meeting requests. At a minimum, the LimitedDetails role is required to view Subject fields in meeting requests. Use the **\*-MailboxFolderPermission** cmdlets to manage mailbox folder permissions. + ```yaml Type: Boolean Parameter Sets: (All) @@ -255,8 +283,12 @@ Accept wildcard characters: False ### -AllowConflicts The AllowConflicts parameter specifies whether to allow conflicting meeting requests. Valid values are: -- $true: Conflicts are allowed. The recurring meeting series is accepted regardless of whether any occurrences conflict with existing bookings. Where conflicts occur, the individual occurrences are declined without notification messages to the meeting organizer. The values of the ConflictPercentageAllowed or MaximumConflictInstances parameters are ignored. -- $false: Conflicts aren't allowed. This is the default value. Whether the entire series is declined depends on the amount of conflicts in the series:
• The series is declined if the number or percentage of conflicts is higher than the ConflictPercentageAllowed or MaximumConflictInstances parameter values.
• The series is accepted, but conflicting occurrences are declined if the number or percentage of conflicts is lower than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. If the EnableResponseDetails parameter value is $true, the organizer will receive a notification email for each declined occurrence. +- $true: Conflicts are allowed. A recurring meeting series is accepted regardless of whether any occurrences conflict with existing bookings. The values of the ConflictPercentageAllowed or MaximumConflictInstances parameters are ignored. +- $false: Conflicts aren't allowed. This is the default value. Whether an entire series is declined depends on the amount of conflicts in the series: + + • The series is declined if the number or percentage of conflicts is higher than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. + + • The series is accepted, but conflicting occurrences are declined if the number or percentage of conflicts is lower than the ConflictPercentageAllowed or MaximumConflictInstances parameter values. If the EnableResponseDetails parameter value is $true, the organizer will receive a notification email for each declined occurrence. ```yaml Type: Boolean @@ -293,7 +325,7 @@ Accept wildcard characters: False ### -AllRequestInPolicy The AllRequestInPolicy parameter specifies whether to allow all users to submit in-policy requests to the resource mailbox. Valid values are: -- $true: All users are allowed to submit in-policy requests to the resource mailbox. These requests require approval by a resource mailbox delegate if the AllBookInPolicy parameter is set to $false (the default value is $true). +- $true: All users are allowed to submit in-policy requests to the resource mailbox. These requests require approval by a resource mailbox delegate if the AllBookInPolicy parameter is set to $false (the default value of AllBookInPolicy is $true). - $false: All users can't submit in-policy requests to the resource mailbox. This is the default value. ```yaml @@ -401,7 +433,13 @@ The BookInPolicy parameter specifies users or groups who are allowed to submit i - Email address - GUID -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +Query-based groups (for example, dynamic distribution groups) aren't supported. + +In delegate and principal scenarios, if the delegate or principal is specified by the BookInPolicy parameter, in-policy meeting requests to the resource mailbox are automatically approved. + +To replace the existing list of users or groups with the values you specify, use the syntax `UserOrGroup1,UserOrGroup2,...UserOrGroupN`. If the values contain spaces or otherwise require quotation marks, use the syntax `"UserOrGroup1","UserOrGroup2",..."UserOrGroupN"`. + +To add users or groups without affecting the other entries, see Example 7. ```yaml Type: RecipientIdParameter[] @@ -553,6 +591,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableAutoRelease +This parameter is available only in the cloud-based service. + +{{ Fill EnableAutoRelease Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EnableResponseDetails The EnableResponseDetails parameter specifies whether to include the reasons for accepting or declining a meeting in the response email message. Valid values are: @@ -575,7 +631,7 @@ Accept wildcard characters: False ### -EnforceCapacity This parameter is available only in the cloud-based service. -The EnforceCapacity parameter specifies whether to restrict the number of attendees to the capacity of the workspace. For example, if capacity is set to 10, then only 10 people can book the workspace. Valid values are: +The EnforceCapacity parameter specifies whether to restrict the number of attendees to the capacity of the workspace. For example, if capacity is set to 10, then only 10 people can book the workspace. Valid values are: - $true: Capacity is enforced. - $false: Capacity is not enforced. This is the default value. @@ -632,9 +688,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -729,6 +785,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PostReservationMaxClaimTimeInMinutes +This parameter is available only in the cloud-based service. + +{{ Fill PostReservationMaxClaimTimeInMinutes Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProcessExternalMeetingMessages The ProcessExternalMeetingMessages parameter specifies whether to process meeting requests that originate outside the Exchange organization. Valid values are: @@ -748,6 +822,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoveCanceledMeetings +This parameter is available only in the cloud-based service. + +The RemoveCanceledMeetings parameter specifies whether to automatically delete meetings that were cancelled by the organizer from the resource mailbox's calendar. Valid values are: + +- $true: Canceled meetings are deleted. +- $false: Canceled meetings aren't deleted. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemoveForwardedMeetingNotifications The RemoveForwardedMeetingNotifications parameter specifies whether forwarded meeting notifications are moved to the Deleted Items folder after they're processed by the Calendar Attendant. Valid values are: @@ -941,12 +1036,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md index 0267efee54..db1f2c2ede 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-caseholdpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-caseholdpolicy +applicable: Security & Compliance title: Set-CaseHoldPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,13 @@ ms.reviewer: # Set-CaseHoldPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft 365 compliance center. +Use the Set-CaseHoldPolicy cmdlet to modify existing case hold policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: Running this cmdlet causes a full synchronization across your organization, which is a significant operation. If you need to update multiple policies, wait until the policy distribution is successful before running the cmdlet again for the next policy. If you need to update a policy multiple times, make all changes in a single call of the cmdlet. For information about the distribution status, see [Get-CaseHoldPolicy](https://learn.microsoft.com/powershell/module/exchange/get-caseholdpolicy). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +27,6 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-CaseHoldPolicy [-Identity] [-RetryDistribution] [-Confirm] - [-UpdateStatistics] [-WhatIf] [] ``` @@ -43,13 +44,14 @@ Set-CaseHoldPolicy [-Identity] [-RemoveExchangeLocation ] [-RemovePublicFolderLocation ] [-RemoveSharePointLocation ] - [-UpdateStatistics] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}`. ## EXAMPLES @@ -61,7 +63,7 @@ Set-CaseHoldPolicy -Identity "Regulation 123 Compliance" -AddExchangeLocation "K This example makes the following changes to the existing case hold policy named "Regulation 123 Compliance": - Adds the mailbox for the user named Kitty Petersen. -- Adds the SharePoint Online site `https://contoso.sharepoint.com/sites/teams/finance`. +- Adds the SharePoint site `https://contoso.sharepoint.com/sites/teams/finance`. - Removes public folders. - Updates the comment. @@ -78,7 +80,7 @@ The Identity parameter specifies the case hold policy that you want to modify. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -88,7 +90,7 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -98,7 +100,7 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -116,8 +118,8 @@ The AddExchangeLocation parameter specifies the mailboxes to add to the list of To specify a mailbox or distribution group, you can use the following values: - Name -- SMTP address -- Azure AD ObjectId (You can use the [Get-AzureADUser](https://docs.microsoft.com/powershell/module/azuread/get-azureaduser) cmdlet to obtain this value.) +- SMTP address. To specify an inactive mailbox, precede the address with a period (.). +- Microsoft Entra ObjectId. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) or [Get-MgGroup](https://learn.microsoft.com/powershell/module/microsoft.graph.groups/get-mggroup) cmdlets in Microsoft Graph PowerShell to find this value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -125,7 +127,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -141,7 +143,7 @@ The AddPublicFolderLocation parameter specifies that you want to add all public Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -151,17 +153,17 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. +SharePoint sites can't be added to the policy until they have been indexed. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -177,7 +179,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -196,7 +198,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -215,7 +217,7 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -225,13 +227,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -249,9 +253,8 @@ The RemoveExchangeLocation parameter specifies the existing mailboxes to remove To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: - Name -- Distinguished name (DN) -- Email address -- GUID +- SMTP address. To specify an inactive mailbox, precede the address with a period (.). +- Microsoft Entra ObjectId. Use the [Get-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/get-mguser) or [Get-MgGroup](https://learn.microsoft.com/powershell/module/microsoft.graph.groups/get-mggroup) cmdlets in Microsoft Graph PowerShell to find this value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -259,7 +262,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -275,7 +278,7 @@ The RemovePublicFolderLocation parameter specifies that you want to remove all p Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -285,7 +288,7 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -293,23 +296,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateStatistics -The UpdateStatistics switch specifies whether you want to update the search results for the hold. You don't need to specify a value with this switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -319,13 +306,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -339,12 +326,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md b/exchange/exchange-ps/exchange/Set-CaseHoldRule.md index 6e2a4b0262..3935336a80 100644 --- a/exchange/exchange-ps/exchange/Set-CaseHoldRule.md +++ b/exchange/exchange-ps/exchange/Set-CaseHoldRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-caseholdrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-caseholdrule +applicable: Security & Compliance title: Set-CaseHoldRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-CaseHoldRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-CaseHoldRule cmdlet to modify existing case hold rules in the Microsoft 365 compliance center. +Use the Set-CaseHoldRule cmdlet to modify existing case hold rules in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Set-CaseHoldRule [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -55,7 +55,7 @@ The Identity parameter specifies the case hold rule that you want to modify. You Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -71,7 +71,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -90,7 +90,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -102,13 +102,13 @@ Accept wildcard characters: False ### -ContentMatchQuery The ContentMatchQuery parameter specifies a content search filter. -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -127,7 +127,7 @@ The Disabled parameter specifies whether the case hold rule is enabled or disabl Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -137,13 +137,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -157,12 +157,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md b/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md index 6eb6aa761c..1848e06aee 100644 --- a/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md +++ b/exchange/exchange-ps/exchange/Set-ClassificationRuleCollection.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-classificationrulecollection +online version: https://learn.microsoft.com/powershell/module/exchange/set-classificationrulecollection applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-ClassificationRuleCollection schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ClassificationRuleCollection cmdlet to update existing classification rule collections in your organization. -In the Microsoft 365 compliance center, use the Set-DlpSensitiveInformationTypeRulePackage cmdlet. +In the Microsoft Purview compliance portal, use the Set-DlpSensitiveInformationTypeRulePackage cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,13 +31,13 @@ Set-ClassificationRuleCollection [-FileData] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-ClassificationRuleCollection -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External Classification Rule Collection.xml" -Encoding Byte -ReadCount 0)) +Set-ClassificationRuleCollection -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External Classification Rule Collection.xml')) ``` This example imports the classification rule collection file C:\\My Documents\\External Classification Rule Collection.xml. @@ -47,7 +47,7 @@ This example imports the classification rule collection file C:\\My Documents\\E ### -FileData The FileData parameter specifies the classification rule collection file you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -68,6 +68,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -120,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessArray.md b/exchange/exchange-ps/exchange/Set-ClientAccessArray.md index 9570c618bf..caa657f795 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessArray.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessArray.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-clientaccessarray +online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessarray applicable: Exchange Server 2010 title: Set-ClientAccessArray schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-ClientAccessArray cmdlet to modify RPC Client Access arrays (load-balanced arrays of Client Access servers within a single Active Directory site). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Set-ClientAccessArray [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,7 +60,7 @@ This example associates the existing Client Access array named ContosoArray with ## PARAMETERS ### -Identity -The Identity parameter specifies the Client Access array that you want to modify. You can use these values: +The Identity parameter specifies the Client Access array that you want to modify. You can use these values: - Name (if the value doesn't contain spaces) - Distinguished name (DN) @@ -149,7 +149,7 @@ Accept wildcard characters: False ``` ### -Site -The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: +The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example: - Name - Distinguished name (DN) @@ -191,12 +191,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md index f9f7782fd9..9a82144d26 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-clientaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-ClientAccessRule schema: 2.0.0 @@ -12,11 +12,14 @@ ms.reviewer: # Set-ClientAccessRule ## SYNOPSIS -This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Set-ClientAccessRule cmdlet to modify existing client access rules. Client access rules help you control access to your organization based on the properties of the connection. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,7 +52,9 @@ Set-ClientAccessRule [-Identity] ## DESCRIPTION Client access rules are like mail flow rules (also known as transport rules) for client connections to your organization. You use conditions and exceptions to identify the connections based on their properties, and actions that allow or block the connections. -**Note**: Not all authentication types are supported for all protocols. The supported authentication types per protocol are described in this list: +**Note**: Not all protocols support authentication type filters, and even protocols that support authentication type filters don't support all authentication types. The supported combinations are described in the following lists. Use caution when mixing protocols and authentication types in the same rule. + +Protocols that support authentication type filters: - ExchangeActiveSync: BasicAuthentication, OAuthAuthentication, and CertificateBasedAuthentication. - ExchangeAdminCenter: BasicAuthentication and AdfsAuthentication. @@ -58,7 +63,16 @@ Client access rules are like mail flow rules (also known as transport rules) for - POP3: BasicAuthentication and OAuthAuthentication. - RemotePowerShell: BasicAuthentication and NonBasicAuthentication. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +Protocols that don't support authentication type filters: + +- ExchangeWebServices +- OfflineAddressBook +- OutlookAnywhere +- PowerShellWebServices +- REST +- UniversalOutlook + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -108,7 +122,7 @@ Accept wildcard characters: False ``` ### -AnyOfAuthenticationTypes -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The AnyOfAuthenticationTypes parameter specifies a condition for the client access rule that's based on the client's authentication type. @@ -124,6 +138,8 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +**Note**: Refer to the Description section to see which authentication types can be used with what protocols. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -148,7 +164,7 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://docs.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). +For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://learn.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). ```yaml Type: MultiValuedProperty @@ -270,7 +286,7 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfAuthenticationTypes -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The ExceptAnyOfAuthenticationTypes parameter specifies an exception for the client access rule that's based on the client's authentication type. @@ -286,6 +302,8 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +**Note**: Refer to the Description section to see which authentication types can be used with what protocols. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -310,7 +328,7 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://docs.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). +For more information about IPv6 addresses and syntax, see this Exchange 2013 topic: [IPv6 address basics](https://learn.microsoft.com/exchange/ipv6-support-in-exchange-2013-exchange-2013-help#ipv6-address-basics). ```yaml Type: MultiValuedProperty @@ -326,7 +344,7 @@ Accept wildcard characters: False ``` ### -ExceptAnyOfProtocols -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The ExceptAnyOfProtocols parameter specifies an exception for the client access rule that's based on the client's protocol. @@ -395,7 +413,7 @@ Accept wildcard characters: False ``` ### -ExceptUsernameMatchesAnyOfPatterns -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -484,7 +502,7 @@ Accept wildcard characters: False ``` ### -UsernameMatchesAnyOfPatterns -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that's based on the user's account name in the format `\` (for example, `contoso.com\jeff`). This parameter accepts text and the wildcard character (\*) (for example, `*jeff*`, but not `jeff*`). Non-alphanumeric characters don't require an escape character. @@ -506,24 +524,15 @@ Accept wildcard characters: False ``` ### -UserRecipientFilter -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. -The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPath filter syntax to identify the user. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"City -eq 'Redmond'"`). +The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPATH filter syntax to identify the user based on a limited set of recipient properties. Client Access Rules don't support the full list of available recipient properties. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). - -You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. - -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). - -The filterable properties that you can use with this parameter are: +You can use the following properties with this parameter: - City - Company -- CountryOrRegion +- CountryOrRegion (ISO 3166-1 alpha-2 country code.) - CustomAttribute1 to CustomAttribute15 - Department - Office @@ -531,6 +540,25 @@ The filterable properties that you can use with this parameter are: - StateOrProvince - StreetAddress +The basic syntax for this parameter is `"Property -ComparisonOperator 'Value'"`: + +- Property is one of the filterable properties in the list above (for example `City` or `CustomAttribute1`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. + +For example: + +- `"City -eq 'Redmond'"` +- `"CountryOrRegion -eq 'SG'"`. + +You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example: + +- `"CustomAttribute1 -eq 'AllowOWA' -and CountryOrRegion -eq AU'"` +- `"(CountryOrRegion -eq 'US' -and Department -eq 'Sales') -or Department -eq 'Research'"`. + +For detailed information about OPATH filter syntax in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). + ```yaml Type: String Parameter Sets: (All) @@ -565,12 +593,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md b/exchange/exchange-ps/exchange/Set-ClientAccessServer.md index 41841db253..343bf8d337 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessServer.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-clientaccessserver +online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ClientAccessServer schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Set-ClientAccessServer cmdlet to modify settings that are associated wit **Note**: In Exchange 2013 or later, use the Set-ClientAccessService cmdlet instead. If you have scripts that use Set-ClientAccessServer, update them to use Set-ClientAccessService. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -59,7 +59,7 @@ Set-ClientAccessServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -96,7 +96,7 @@ Accept wildcard characters: False ### -AlternateServiceAccountCredential The AlternateServiceAccountCredential parameter specifies an alternative service account username and password that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. You can specify multiple values separated by commas. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential[] @@ -148,9 +148,7 @@ The AutoDiscoverSiteScope parameter specifies the Active Directory site that the To see the available Active Directory sites, use the Get-ADSite cmdlet. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +To specify multiple values, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -390,12 +388,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ClientAccessService.md b/exchange/exchange-ps/exchange/Set-ClientAccessService.md index aee9e65391..bff2cc0183 100644 --- a/exchange/exchange-ps/exchange/Set-ClientAccessService.md +++ b/exchange/exchange-ps/exchange/Set-ClientAccessService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-clientaccessservice +online version: https://learn.microsoft.com/powershell/module/exchange/set-clientaccessservice applicable: Exchange Server 2016, Exchange Server 2019 title: Set-ClientAccessService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ClientAccessService cmdlet to modify settings that are associated with the Client Access server role. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ Set-ClientAccessService [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,7 +82,7 @@ Accept wildcard characters: False ### -AlternateServiceAccountCredential The AlternateServiceAccountCredential parameter specifies an alternative service account that's typically used for Kerberos authentication in Exchange Server 2010 coexistence environments. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential[] @@ -134,9 +134,7 @@ The AutoDiscoverSiteScope parameter specifies the Active Directory site that the To see the available Active Directory sites, use the Get-ADSite cmdlet. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. - -To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +To specify multiple values, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: MultiValuedProperty @@ -239,12 +237,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-Clutter.md b/exchange/exchange-ps/exchange/Set-Clutter.md index a38cb70268..980d6d409c 100644 --- a/exchange/exchange-ps/exchange/Set-Clutter.md +++ b/exchange/exchange-ps/exchange/Set-Clutter.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.Management-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-clutter +online version: https://learn.microsoft.com/powershell/module/exchange/set-clutter applicable: Exchange Online, Exchange Online Protection title: Set-Clutter schema: 2.0.0 @@ -16,20 +16,19 @@ This cmdlet is available only in the cloud-based service. Use the Set-Clutter cmdlet to configure Clutter settings for mailboxes in your organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-Clutter -Identity [-Enable ] + [-UseCustomRouting] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,17 +87,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md b/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md index db6f761b43..4fcef9f94d 100644 --- a/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md +++ b/exchange/exchange-ps/exchange/Set-CmdletExtensionAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-cmdletextensionagent +online version: https://learn.microsoft.com/powershell/module/exchange/set-cmdletextensionagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-CmdletExtensionAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-CmdletExtensionAgent cmdlet to modify cmdlet extension agents. To enable or disable cmdlet extension agents, use the Enable-CmdletExtensionAgent and Disable-CmdletExtensionAgent cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Cmdlet extension agents are used by Exchange cmdlets in Exchange Server 2010 and The changes that you make by using the Set-CmdletExtensionAgent cmdlet are applied to every Exchange server in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -156,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ComplianceCase.md b/exchange/exchange-ps/exchange/Set-ComplianceCase.md index e84ac37b76..2975872e51 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceCase.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceCase.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancecase -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancecase +applicable: Security & Compliance title: Set-ComplianceCase schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-ComplianceCase ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-ComplianceCase cmdlet to modify eDiscovery cases in the Microsoft 365 compliance center. +Use the Set-ComplianceCase cmdlet to modify eDiscovery cases in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Set-ComplianceCase [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -58,7 +58,7 @@ The Identity parameter specifies the compliance case that you want to modify. Yo Type: ComplianceCaseIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -74,7 +74,7 @@ This parameter is reserved for internal Microsoft use. Type: ComplianceCaseType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -90,7 +90,7 @@ The Close switch specifies that you want to close the compliance case. You don't Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -109,7 +109,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -125,7 +125,7 @@ The Description parameter specifies a description for the compliance case. The m Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -141,7 +141,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -157,7 +157,7 @@ The ExternalId parameter specifies an optional ID or external case number that y Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -173,7 +173,7 @@ The Name parameter specifies the unique name of the compliance case. The maximum Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -189,7 +189,7 @@ The Reopen switch specifies that you want to re-open a closed compliance case. Y Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -199,13 +199,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -219,12 +219,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md index 4408a6ce13..095fd20c7a 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceRetentionEventType.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Set-ComplianceRetentionEventType -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-complianceretentioneventtype +applicable: Security & Compliance title: Set-ComplianceRetentionEventType schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-ComplianceRetentionEventType ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-ComplianceRetentionEventType cmdlet to modify retention event types in the Microsoft 365 compliance center. +Use the Set-ComplianceRetentionEventType cmdlet to modify retention event types in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Set-ComplianceRetentionEventType -Identity ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,7 +53,7 @@ The Identity parameter specifies the retention event type that you want to modif Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -69,7 +69,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -88,7 +88,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -98,13 +98,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -118,12 +118,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md index 7b5560cc62..2f6e6859f5 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesearch +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Set-ComplianceSearch schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Set-ComplianceSearch cmdlet to modify non-running compliance searches in Exchange Server 2016 or later and in the Microsoft 365 compliance center. +Use the Set-ComplianceSearch cmdlet to modify non-running compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,11 +52,11 @@ Set-ComplianceSearch [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -72,7 +72,7 @@ This example changes the existing compliance search named Project X. The scope o Set-ComplianceSearch -Identity "Contoso Case Search 1" -HoldNames All -ExchangeLocation $null -SharePointLocation $null ``` -This example changes an existing compliance search that's associated with an eDiscovery case in the Microsoft 365 compliance center. The scope of the search is changed from searching selected mailboxes and SharePoint sites to searching all content locations that have been placed on hold in the eDiscovery case. +This example changes an existing compliance search that's associated with an eDiscovery case in the Microsoft Purview compliance portal. The scope of the search is changed from searching selected mailboxes and SharePoint sites to searching all content locations that have been placed on hold in the eDiscovery case. ### Example 3 ```powershell @@ -99,7 +99,7 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -120,7 +120,7 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -130,7 +130,7 @@ Accept wildcard characters: False ``` ### -AddExchangeLocationExclusion -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to add to the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -143,7 +143,7 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -155,7 +155,7 @@ Accept wildcard characters: False ### -AddSharePointLocation This parameter is available only in the cloud-based service. -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -163,7 +163,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -181,7 +181,7 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -207,7 +207,7 @@ The mailbox types that are affected by the value of this parameter include: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -226,7 +226,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -238,13 +238,13 @@ Accept wildcard characters: False ### -ContentMatchQuery The ContentMatchQuery parameter specifies a content search filter. -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -260,7 +260,7 @@ The Description parameter specifies a description for the compliance search. If Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -284,7 +284,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -294,7 +294,7 @@ Accept wildcard characters: False ``` ### -ExchangeLocationExclusion -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to exclude when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -307,7 +307,7 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -317,13 +317,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -337,7 +339,7 @@ This parameter is available only in the cloud-based service. The HoldNames parameter specifies that the content locations that have been placed on hold in the eDiscovery case will be searched. You use the value All for this parameter. You can use this parameter only for compliance searches that are associated with an eDiscovery case. -If the content locations in the compliance search include mailboxes, you also need to use the ExchangeLocation parameter with the value $null. Similarly, if the compliance search includes SharePoint sites, you also need to use the SharePointLocation parameter withthe value $null. +If the content locations in the compliance search include mailboxes, you also need to use the ExchangeLocation parameter with the value $null. Similarly, if the compliance search includes SharePoint sites, you also need to use the SharePointLocation parameter with the value $null. Also, if a content location was placed on a query-based case hold, only items that are on hold will be searched when you restart this compliance search. For example, if a user was placed on a query-based case hold that preserves items that were sent or created before a specific date, only those items would be searched by using the search criteria specified by this compliance search. @@ -345,7 +347,7 @@ Also, if a content location was placed on a query-based case hold, only items th Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -361,7 +363,7 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -382,7 +384,7 @@ The IncludeUserAppContent parameter specifies that you want to search the cloud- Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -394,13 +396,13 @@ Accept wildcard characters: False ### -Language The Language parameter specifies the language for the compliance search. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -416,7 +418,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -434,7 +436,7 @@ The PublicFolderLocation parameter specifies that you want to include all public Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -452,7 +454,7 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -473,7 +475,7 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -483,7 +485,7 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationExclusion -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: @@ -496,7 +498,7 @@ To specify a mailbox or distribution group, use the email address. You can speci Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -514,7 +516,7 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -526,7 +528,7 @@ Accept wildcard characters: False ### -RemoveSharePointLocation This parameter is available only in the cloud-based service. -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -534,7 +536,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -552,7 +554,7 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -564,7 +566,7 @@ Accept wildcard characters: False ### -SharePointLocation This parameter is available only in the cloud-based service. -The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites. +The SharePointLocation parameter specifies the SharePoint sites to include. You identify the site by its URL value, or you can use the value All to include all sites. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -572,7 +574,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -590,7 +592,7 @@ This parameter is reserved for internal Microsoft use. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -600,7 +602,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -608,7 +610,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -622,12 +624,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md index 6e5ed7c1e9..a490fa06ca 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSearchAction.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancesearchaction -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesearchaction +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Set-ComplianceSearchAction schema: 2.0.0 author: chrisda @@ -12,11 +12,14 @@ ms.reviewer: # Set-ComplianceSearchAction ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +> [!NOTE] +> After May 26, 2025, this cmdlet is no longer functional. For more information, see [Upcoming changes to Microsoft Purview eDiscovery](https://techcommunity.microsoft.com/blog/microsoft-security-blog/upcoming-changes-to-microsoft-purview-ediscovery/4405084). + +This cmdlet is functional only in on-premises Exchange. Use the Set-ComplianceSearchAction cmdlet to change the export key on export compliance search actions in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +33,7 @@ Set-ComplianceSearchAction [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. @@ -55,7 +58,7 @@ The Identity parameter specifies the compliance search action that you want to m Type: ComplianceSearchActionIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -67,13 +70,13 @@ Accept wildcard characters: False ### -ChangeExportKey The ChangeExportKey switch creates a new export key for the compliance search action. You don't need to specify a value with this switch. -This parameter is only meaningful on export compliance search actions. +This switch is meaningful only on export compliance search actions. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -92,7 +95,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -108,7 +111,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -124,7 +127,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -138,12 +141,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md index 60dd0b7e55..5301f61588 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceSecurityFilter.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancesecurityfilter -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancesecurityfilter +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Set-ComplianceSecurityFilter schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-ComplianceSecurityFilter ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-ComplianceSecurityFilter cmdlet to modify compliance security filters in the Microsoft 365 compliance center. +Use the Set-ComplianceSecurityFilter cmdlet to modify compliance security filters in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,15 +33,17 @@ Set-ComplianceSecurityFilter -FilterName ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell $filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" + $filterusers.users.add("pilarp@contoso.com") -Set-ComplianceSecurityFilter -FilterName OttawaUsersFilter -Users $filterusers.users + +Set-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" -Users $filterusers.users ``` This example adds user pilarp@contoso.com to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter. @@ -49,8 +51,10 @@ This example adds user pilarp@contoso.com to the compliance security filter name ### Example 2 ```powershell $filterusers = Get-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" + $filterusers.users.remove("annb@contoso.com") -Set-ComplianceSecurityFilter -FilterName OttawaUsersFilter -Users $filterusers.users + +Set-ComplianceSecurityFilter -FilterName "Ottawa Users Filter" -Users $filterusers.users ``` This example removes user annb@contoso.com to the compliance security filter named Ottawa Users Filter without affecting other users assigned to the filter. @@ -64,7 +68,7 @@ The FilterName parameter specifies the name of the compliance security filter th Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: Named @@ -74,9 +78,9 @@ Accept wildcard characters: False ``` ### -Action -The Action parameter specifies that type of search action that the filter is applied to. Valid values are: +The Action parameter specifies that type of search action that the filter is applied to. A valid value for this parameter is All, which means the filter is applied to all search actions. -- Export: The filter is applied when exporting search results, or preparing them for analysis in Microsoft 365 Advanced eDiscovery. +- Export: The filter is applied when exporting search results, or preparing them for analysis in eDiscovery Premium. - Preview: The filter is applied when previewing search results. - Purge: The filter is applied when purging search results. How the items are deleted is controlled by the PurgeType parameter value on the New-ComplianceSearchAction cmdlet. The default value is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires. - Search: The filter is applied when running a search. @@ -86,7 +90,7 @@ The Action parameter specifies that type of search action that the filter is app Type: ComplianceSecurityFilterActionType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -105,7 +109,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -121,7 +125,7 @@ The Description parameter specifies a description for the compliance security fi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -133,9 +137,9 @@ Accept wildcard characters: False ### -Filters The Filters parameter specifies the search criteria for the compliance security filter. You can create three different types of filters: -- Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is `MailboxContent_:`, where `` specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, `MailboxContent_recipients:contoso.com` allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable message properties, see [Keyword queries for Compliance Search](https://docs.microsoft.com/microsoft-365/compliance/keyword-queries-and-search-conditions). -- Site and site content filter: There are two SharePoint Online and OneDrive for Business site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://docs.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. +- Mailbox filter: Specifies the mailboxes that can be searched by the assigned users. Valid syntax is `Mailbox_`, where `` is a mailbox property value. For example,`"Mailbox_CustomAttribute10 -eq 'OttawaUsers'"` allows users to only search mailboxes that have the value OttawaUsers in the CustomAttribute10 property. For a list of supported mailbox properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- Mailbox content filter: Specifies the mailbox content the assigned users can search for. Valid syntax is `MailboxContent_`, where `` specifies a Keyword Query Language (KQL) property that can be specified in a compliance search. For example, `"MailboxContent_Recipients -like 'contoso.com'"` allows users to only search for messages sent to recipients in the contoso.com domain. For a list of searchable email properties, see [Keyword queries for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions#searchable-email-properties). +- Site and site content filter: There are two SharePoint and OneDrive site-related filters that you can create: `Site_` (specifies site-related properties. For example,`"Site_Path -eq 'https://contoso.sharepoint.com/sites/doctors'"` allows users to only search for content in the `https://contoso.sharepoint.com/sites/doctors` site collection) and `SiteContent_` (specifies content-related properties. For example, `"SiteContent_FileExtension -eq 'docx'"` allows users to only search for Word documents). For a list of searchable site properties, see [Overview of crawled and managed properties in SharePoint Server](https://learn.microsoft.com/SharePoint/technical-reference/crawled-and-managed-properties-overview). Properties marked with a Yes in the Queryable column can be used to create a site or site content filter. You can specify multiple filters of the same type. For example, `"Mailbox_CustomAttribute10 -eq 'FTE' -and Mailbox_MemberOfGroup -eq '$($DG.DistinguishedName)'"`. @@ -143,7 +147,7 @@ You can specify multiple filters of the same type. For example, `"Mailbox_Custom Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -172,7 +176,7 @@ If you don't use this parameter in a multi-geo tenant, eDiscovery searches are p Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -196,7 +200,7 @@ The values you specify will overwrite any existing entries. See the Examples sec Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -206,13 +210,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -226,12 +230,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ComplianceTag.md b/exchange/exchange-ps/exchange/Set-ComplianceTag.md index 25e1e1d4eb..ef1e0e1fd7 100644 --- a/exchange/exchange-ps/exchange/Set-ComplianceTag.md +++ b/exchange/exchange-ps/exchange/Set-ComplianceTag.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-compliancetag -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-compliancetag +applicable: Security & Compliance title: Set-ComplianceTag schema: 2.0.0 author: chrisda @@ -12,20 +12,24 @@ ms.reviewer: # Set-ComplianceTag ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-ComplianceTag cmdlet to modify retention labels in the Microsoft 365 compliance center. Retention labels apply retention settings to content. +Use the Set-ComplianceTag cmdlet to modify retention labels in the Microsoft Purview compliance portal. Retention labels apply retention settings to content. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Default ``` Set-ComplianceTag [-Identity] + [-AutoApprovalPeriod ] [-Comment ] + [-ComplianceTagForNextStage ] [-Confirm] [-EventType ] [-FilePlanProperty ] + [-FlowId ] [-Force] [-MultiStageReviewProperty ] [-Notes ] @@ -35,8 +39,21 @@ Set-ComplianceTag [-Identity] [] ``` +### PriorityCleanup +``` +Set-ComplianceTag [-Identity] [-PriorityCleanup] + [-Comment ] + [-Confirm] + [-Force] + [-MultiStageReviewProperty ] + [-Notes ] + [-RetentionDuration ] + [-WhatIf] + [] +``` + ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -60,7 +77,7 @@ The Identity parameter specifies the label that you want to modify. You can use Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -69,6 +86,22 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AutoApprovalPeriod +{{ Fill AutoApprovalPeriod Description }} + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Comment The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". @@ -76,7 +109,23 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComplianceTagForNextStage +{{ Fill ComplianceTagForNextStage Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -95,7 +144,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -117,7 +166,7 @@ You can use the Get-RetentionComplianceRule cmdlet to view the available retenti Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -160,7 +209,30 @@ You use the second variable as the value for this parameter. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowId +**Note**: This parameter is currently in Preview, is not available in all organizations, and is subject to change. + +The FlowId parameter specifies the Power Automate flow to run at the end of the retention period. A valid value for this parameter is the GUID value of the flow. + +You can find the GUID value of the flow by using either of the following methods: + +- Navigate to the flow from the Power Automate portal. The GUID value of the flow is in the URL. +- Use the Power Automate action named 'List flows as admin'. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -170,13 +242,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -200,7 +274,7 @@ This syntax is a JSON object that defines each review stage id, review stage nam Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -216,7 +290,23 @@ The Notes parameter specifies an optional note. If you specify a value that cont Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: PriorityCleanup +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -235,7 +325,7 @@ The RetentionDuration parameter specifies the number of days to retain the conte Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -251,7 +341,7 @@ The ReviewerEmail parameter specifies the email address of a reviewer for Delete Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -261,13 +351,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -281,12 +371,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-Contact.md b/exchange/exchange-ps/exchange/Set-Contact.md index ced1e7e660..a173246fe3 100644 --- a/exchange/exchange-ps/exchange/Set-Contact.md +++ b/exchange/exchange-ps/exchange/Set-Contact.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-contact +online version: https://learn.microsoft.com/powershell/module/exchange/set-contact applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-Contact schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-Contact cmdlet to modify contact object settings. If the contact is a mail contact, you can use the Set-MailContact cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Contact cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -67,7 +67,7 @@ Set-Contact [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -321,6 +321,8 @@ The GeoCoordinates parameter specifies the contact's location in latitude, longi - Latitude and longitude: For example, "47.644125;-122.122411" - Latitude, longitude, and altitude: For example, "47.644125;-122.122411;161.432" +**Note**: If period separators don't work for you, use commas instead. + ```yaml Type: GeoCoordinates Parameter Sets: (All) @@ -353,9 +355,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -726,7 +728,7 @@ The UMCallingLineIds parameter specifies telephone numbers or extensions that ca Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -823,12 +825,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md b/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md index 048962bb17..80deb1646f 100644 --- a/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md +++ b/exchange/exchange-ps/exchange/Set-ContentFilterConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-contentfilterconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-contentfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ContentFilterConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ContentFilterConfig cmdlet to modify the content filter configuration on a Mailbox server or an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ Set-ContentFilterConfig [-BypassedRecipients ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,14 +63,16 @@ This example makes the following modifications to the Content Filter agent confi It enables and configures the SCL threshold functionalities that quarantine, reject and delete messages to 5, 6 and 8 respectively. -It specifies SpamQuarantineMailbox@contoso.com as the spam quarantine mailbox. +It specifies `SpamQuarantineMailbox@contoso.com` as the spam quarantine mailbox. It defines two users for whom the Content Filter won't process messages. ## PARAMETERS ### -BypassedRecipients -The BypassedRecipients parameter specifies the SMTP address values of recipients in your organization. The Content Filter agent doesn't process any content filtering for messages bound to the addresses listed on this parameter. To enter multiple SMTP addresses, separate the addresses by using a comma, for example: recipient1@contoso.com,recipient2@contoso.com. The maximum number of recipients you can input is 100. +The BypassedRecipients parameter specifies the SMTP addresses of recipients who skip processing by the Content Filter agent. + +You can specify multiple recipients separated by commas (for example, `"recipient1@contoso.com","recipient2@contoso.com"`). The maximum number of recipient entries is 100. ```yaml Type: MultiValuedProperty @@ -86,7 +88,9 @@ Accept wildcard characters: False ``` ### -BypassedSenderDomains -The BypassedSenderDomains parameter specifies domain name values of sending domains. The Content Filter agent doesn't process any content filtering for messages received from the domains listed on this parameter. To enter multiple domains, separate the addresses by using a comma, for example: contoso.com, example.com. A wildcard character (\*) can be used to specify all subdomains, for example: \*.contoso.com. The maximum number of domains you can input is 100. +The BypassedSenderDomains parameter specifies the sender email address domains of senders who skip processing by the Content Filter agent. + +You can specify multiple sender domains separated by commas (`"contoso.com","fabrikam.com"`). Use a wildcard character (\*) to specify a domain and all subdomains (for example: `*.contoso.com`). The maximum number of domain entries is 100. ```yaml Type: MultiValuedProperty @@ -102,7 +106,9 @@ Accept wildcard characters: False ``` ### -BypassedSenders -The BypassedSenders parameter specifies the SMTP address values of senders. The Content Filter agent doesn't process any content filtering for messages received from the addresses listed on this parameter. To enter multiple SMTP addresses, separate the addresses by using a comma, for example: sender1@contoso.com, sender2@example.com. The maximum number of SMTP addresses you can input is 100. +The BypassedSenders parameter specifies the SMTP addresses of senders who skip processing by the Content Filter agent. + +You can specify multiple senders separated by commas (for example, `"sender1@contoso.com","sender2@contoso.com"`). The maximum number of recipient entries is 100. ```yaml Type: MultiValuedProperty @@ -155,7 +161,10 @@ Accept wildcard characters: False ``` ### -Enabled -The Enabled parameter enables or disables the Content Filter agent on the computer on which you're running the command. Valid input for the Enabled parameter is $true or $false. The default setting is $true. +The Enabled parameter enables or disables the Content Filter agent on the computer on which you're running the command. Valid values are: + +- $true: The Content Filter agent is enabled. This is the default value. +- $false: The Content Filter agent is disabled. ```yaml Type: Boolean @@ -171,7 +180,10 @@ Accept wildcard characters: False ``` ### -ExternalMailEnabled -The ExternalMailEnabled parameter specifies whether all messages from unauthenticated connections from sources external to your Exchange organization are passed through the Content Filter agent for processing. Valid input for the ExternalMailEnabled parameter is $true or $false. The default setting is $true. When the ExternalMailEnabled parameter is set to $true, all messages from unauthenticated connections are passed through the Content Filter agent for processing. +The ExternalMailEnabled parameter specifies whether all messages from unauthenticated connections from sources external to your Exchange organization are processed by the Content Filter agent. Valid values are: + +- $true: Messages from unauthenticated connections are processed by the Content Filter agent. This is the default value. +- $false: Messages from unauthenticated connections aren't processed by the Content Filter agent. ```yaml Type: Boolean @@ -187,7 +199,10 @@ Accept wildcard characters: False ``` ### -InternalMailEnabled -The InternalMailEnabled parameter specifies whether all messages from authenticated connections and from authoritative domains in your enterprise are passed through the Content Filter agent for processing. Valid input for the InternalMailEnabled parameter is $true or $false. The default setting is $false. When the InternalMailEnabled parameter is set to $true, all messages from authenticated connections and from authoritative domains in your enterprise are passed through the Content Filter agent for processing. +The InternalMailEnabled parameter specifies whether all messages from authenticated connections and from authoritative domains in your enterprise are processed by the Content Filter agent. Valid values are: + +- $true: Messages from authenticated connections are processed by the Content Filter agent. +- $false: Messages from authenticated connections aren't processed by the Content Filter agent. This is the default value. ```yaml Type: Boolean @@ -203,7 +218,15 @@ Accept wildcard characters: False ``` ### -OutlookEmailPostmarkValidationEnabled -The OutlookEmailPostmarkValidationEnabled parameter specifies whether the Content Filter agent sends a computational puzzle to the sender's system for processing. Valid input for the OutlookEmailPostmarkValidationEnabled parameter is $true or $false. When the OutlookEmailPostmarkValidationEnabled parameter is set to $true, the Content Filter agent sends a computational puzzle to the sender's system for processing. The results of the puzzle validation are factored into the overall spam confidence level (SCL). This functionality is exposed to the Microsoft Outlook user as Outlook E-mail Postmark validation. The default setting is $false. +The OutlookEmailPostmarkValidationEnabled parameter specifies whether Outlook Email Postmark validation is enabled. + +- For outbound messages, the Content Filter agent applies a computational postmark header to help destination email systems distinguish legitimate email from spam. +- For inbound messages, the Content Filter agent looks for a computational postmark header in the message. The presence of a valid, solved computational postmark header indicates the client computer that generated the message solved the computational postmark, so the Content Filter agent is likely to lower the message's spam confidence level (SCL) rating. + +Valid values are: + +- $true: Outlook Email Postmark validation is enabled. +- $false: Outlook Email Postmark validation is disabled. This is the default value. ```yaml Type: Boolean @@ -251,7 +274,10 @@ Accept wildcard characters: False ``` ### -SCLDeleteEnabled -The SCLDeleteEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLDeleteThreshold parameter are deleted. Valid input for the SCLDeleteEnabled parameter is $true or $false. The default setting is $false. When the SCLDeleteEnabled parameter is set to $true, all messages that meet or exceed the value set in the SCLDeleteThreshold parameter are deleted. +The SCLDeleteEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLDeleteThreshold parameter are deleted. Valid values are: + +- $true: Messages that meet or exceed the value set in the SCLDeleteThreshold parameter are deleted. +- $false: Messages aren't deleted. This is the default value. ```yaml Type: Boolean @@ -283,7 +309,10 @@ Accept wildcard characters: False ``` ### -SCLQuarantineEnabled -The SCLQuarantineEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the spam quarantine mailbox specified in the QuarantineMailbox parameter. Valid input for the SCLQuarantineEnabled parameter is $true or $false. The default setting is $false. When the SCLQuarantineEnabled parameter is set to $true, all messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the spam quarantine mailbox specified in the QuarantineMailbox parameter. +The SCLQuarantineEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the spam quarantine mailbox specified in the QuarantineMailbox parameter. Valid values are: + +- $true: Messages that meet or exceed the value set in the SCLQuarantineThreshold parameter are sent to the spam quarantine mailbox specified in the QuarantineMailbox parameter. +- $false: Messages aren't quarantined. This is the default value. ```yaml Type: Boolean @@ -315,7 +344,10 @@ Accept wildcard characters: False ``` ### -SCLRejectEnabled -The SCLRejectEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLRejectThreshold parameter are rejected, and an NDR is sent to the sender. Valid input for the SCLRejectEnabled parameter is $true or $false. The default setting is $false. When SCLRejectEnabled parameter is set to $true, all messages that meet or exceed the value set in the SCLRejectThreshold parameter are rejected, and an NDR is sent to the sender. +The SCLRejectEnabled parameter specifies whether all messages that meet or exceed the value set in the SCLRejectThreshold parameter are rejected in an NDR to the sender. Valid values are: + +- $true: Messages that meet or exceed the value set in the SCLRejectThreshold parameter are rejected in an NDR is to the sender. +- $false: Messages aren't rejected. This is the default value. ```yaml Type: Boolean @@ -367,12 +399,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-DataClassification.md b/exchange/exchange-ps/exchange/Set-DataClassification.md index 1aa6d5c850..a31254e845 100644 --- a/exchange/exchange-ps/exchange/Set-DataClassification.md +++ b/exchange/exchange-ps/exchange/Set-DataClassification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dataclassification +online version: https://learn.microsoft.com/powershell/module/exchange/set-dataclassification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-DataClassification schema: 2.0.0 @@ -12,13 +12,13 @@ ms.reviewer: # Set-DataClassification ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. -In Exchange Online, this cmdlet has been replaced by the [Set-DlpSensitiveInformationType](https://docs.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype) cmdlet in Security & Compliance Center PowerShell. +In Exchange Online, this cmdlet has been replaced by the [Set-DlpSensitiveInformationType](https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype) cmdlet in Security & Compliance PowerShell. Use the Set-DataClassification cmdlet to modify data classification rules that use document fingerprints. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ Set-DataClassification [-Identity] ## DESCRIPTION Classification rule packages are used by data loss prevention (DLP) to detect sensitive content in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -58,11 +58,16 @@ This example removes the existing Spanish translation from the data classificati ### Example 3 ```powershell -$Benefits_Template = Get-Content "C:\My Documents\Contoso Benefits Template.docx" -Encoding byte +$Benefits_Template = [System.IO.File]::ReadAllBytes('C:\My Documents\Contoso Benefits Template.docx') + $Benefits_Fingerprint = New-Fingerprint -FileData $Benefits_Template -Description "Contoso Benefits Template" + $Contoso_Confidential = Get-DataClassification "Contoso Confidential" + $Array = [System.Collections.ArrayList]($Contoso_Confidential.Fingerprints) + $Array.Add($Benefits_FingerPrint) + Set-DataClassification $Contoso_Confidential.Identity -FingerPrints $Array ``` @@ -71,9 +76,13 @@ This example modifies the existing data classification rule named "Contoso Confi ### Example 4 ```powershell $cc = Get-DataClassification "Contoso Confidential" + $a = [System.Collections.ArrayList]($cc.Fingerprints) + $a + $a.RemoveAt(0) + Set-DataClassification $cc.Identity -FingerPrints $a ``` @@ -155,7 +164,7 @@ Accept wildcard characters: False ``` ### -Fingerprints -The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the data classification rule. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://docs.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing data classification rule, see the Examples section. +The Fingerprints parameter specifies the byte-encoded document files that are used as fingerprints by the data classification rule. For instructions on how to import documents to use as templates for fingerprints, see [New-Fingerprint](https://learn.microsoft.com/powershell/module/exchange/new-fingerprint) or the Examples section. For instructions on how to add and remove document fingerprints from an existing data classification rule, see the Examples section. ```yaml Type: MultiValuedProperty @@ -171,7 +180,9 @@ Accept wildcard characters: False ``` ### -IsDefault -The IsDefault switch is used with the Locale parameter to specify the default language for the data classification rule. The default Locale value is stored in the DefaultCulture property. +The IsDefault switch is used with the Locale parameter to specify the default language for the data classification rule. You don't need to specify a value with this switch. + +The default Locale value is stored in the DefaultCulture property. When you change the default Locale value, the Name value of the data classification rule changes to match the Name value that's associated with the new default locale. The original Name value when the rule was created is permanently stored the LocalizedName property. @@ -191,7 +202,7 @@ Accept wildcard characters: False ### -Locale The Locale parameter adds or removes languages that are associated with the data classification rule. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). Typically, you use the Locale parameter with the Name and Description parameters to add or remove translated names and descriptions for the data classification rule. You can also use the Locale parameter with the IsDefault switch to designate an existing translated name and description as the default. Before you can remove the default translation, you need to set another translation as the default. @@ -249,12 +260,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md index b99a6aba17..729b74f9f7 100644 --- a/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DataEncryptionPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dataencryptionpolicy -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-dataencryptionpolicy +applicable: Exchange Online, Exchange Online Protection title: Set-DataEncryptionPolicy schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-DataEncryptionPolicy cmdlet to modify data encryption policies in Exchange Online. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -63,7 +61,7 @@ Set-DataEncryptionPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -112,7 +110,7 @@ You need to use this parameter with the PermanentDataPurgeRequested and Permanen Type: String Parameter Sets: TenantAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -125,7 +123,7 @@ Accept wildcard characters: False Type: String Parameter Sets: DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -143,7 +141,7 @@ You need to use this parameter with the PermanentDataPurgeRequested and Permanen Type: String Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -163,7 +161,7 @@ After you use this switch, you can't assign the data encryption policy to other Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -194,11 +192,13 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -230,7 +230,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -249,7 +249,7 @@ The Enabled parameter enables or disable the data encryption policy. Valid value Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -259,13 +259,15 @@ Accept wildcard characters: False ``` ### -Force -Use the Force switch when you're trying to initiate the deletion of all data that's encrypted by the data encryption policy (the PermanentDataPurgeRequested switch), but the associated Azure Key Vault has also been deleted. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to delete all data that's encrypted by the data encryption policy (the PermanentDataPurgeRequested switch), but the associated Azure Key Vault has also been deleted. ```yaml Type: SwitchParameter Parameter Sets: TenantAdminPurgeKeyRequest, DCAdminPurgeKeyRequest Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -297,7 +299,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -311,12 +313,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md index 9278e87bd2..d5e6a1b952 100644 --- a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroup +online version: https://learn.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-DatabaseAvailabilityGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-DatabaseAvailabilityGroup cmdlet to configure properties of a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -68,7 +68,7 @@ DAG property values are stored in both Active Directory and the cluster database - NetworkEncryption - DiscoverNetworks -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -708,12 +708,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md index 542412f2ff..1cf2e33f62 100644 --- a/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md +++ b/exchange/exchange-ps/exchange/Set-DatabaseAvailabilityGroupNetwork.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroupnetwork +online version: https://learn.microsoft.com/powershell/module/exchange/set-databaseavailabilitygroupnetwork applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-DatabaseAvailabilityGroupNetwork schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-DatabaseAvailabilityGroupNetwork cmdlet to configure a network for a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Set-DatabaseAvailabilityGroupNetwork [-Identity] + [-ResultSize ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +``` +Set-DefaultTenantBriefingConfig -IsEnabledByDefault Opt-in + +This example sets the default Briefing email configuration for the organization to receive the Briefing email. +``` + +## PARAMETERS + +### -IsEnabledByDefault +The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are: + +- Opt-in: By default, all users in the organization are subscribed to receive the Briefing email. +- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value. + +This setting affects the following users: + +- Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email. +- New users that you create. + +This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32] +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md new file mode 100644 index 0000000000..9c1ba06bb4 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-DefaultTenantMyAnalyticsFeatureConfig.md @@ -0,0 +1,161 @@ +--- +external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml +Module Name: ExchangeOnlineManagement +online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig +applicable: Exchange Online +title: Set-DefaultTenantMyAnalyticsFeatureConfig +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-DefaultTenantMyAnalyticsFeatureConfig + +## SYNOPSIS +This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). + +Use the Set-DefaultTenantMyAnalyticsFeatureConfig cmdlet to update the availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-DefaultTenantMyAnalyticsFeatureConfig + [-Feature ] + [-IsEnabled ] + [-ResultSize ] + [-SamplingRate ] + [] +``` + +## DESCRIPTION +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: + +- Global Administrator +- Exchange Administrator +- Insights Administrator + +For more information, see [Microsoft Entra built-in roles](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature All -IsEnabled $true +``` + +This example enables all available Viva Insights features for the organization: add-in, dashboard, digest email, meeting effectiveness survey, schedule send suggestions. + +### Example 2 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Add-in -IsEnabled $false +``` + +This example disables Viva Insight add-in feature for the organization. + +### Example 3 +```powershell +Set-DefaultTenantMyAnalyticsFeatureConfig -Feature Meeting-Effectiveness-Survey-Sampling-Rate -SamplingRate 0.2 +``` + +This example sets the meeting effectiveness survey sampling rate to 20%. + +## PARAMETERS + +### -Feature +The Feature parameter specifies the Viva Insights feature to enable or disable. Valid values are: + +- Add-in +- Dashboard +- Digest-email +- Meeting-effectiveness-survey +- Meeting-effectiveness-survey-sampling-rate +- Schedule-send +- All (all features) + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: Dashboard, Add-in, Digest-email, Meeting-effectiveness-survey, Scheduled-send, All +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsEnabled +The IsEnabled parameter enables or disables the Viva Insights feature specified by the Feature parameter. Valid values are: + +- $true: The feature is enabled. +- $false: The feature is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SamplingRate +This parameter is available only in version 3.2.0 or later. + +The SamplingRate parameter specifies the meeting effectiveness survey sampling rate. The percentage value is expressed a a decimal (for example, 0.1 indicates 10%). A valid value is from 0.1 to 0.7. + +```yaml +Type: Double +Parameter Sets: (All) +Aliases: +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide) diff --git a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md b/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md index 13c57dd220..e1280caf99 100644 --- a/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md +++ b/exchange/exchange-ps/exchange/Set-DeliveryAgentConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deliveryagentconnector +online version: https://learn.microsoft.com/powershell/module/exchange/set-deliveryagentconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-DeliveryAgentConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-DeliveryAgentConnector cmdlet to configure a specific delivery agent connector in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,9 +40,9 @@ Set-DeliveryAgentConnector [-Identity] ``` ## DESCRIPTION -Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://docs.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). +Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see [Delivery agents and Delivery Agent connectors](https://learn.microsoft.com/exchange/delivery-agents-and-delivery-agent-connectors-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,7 +62,9 @@ Sets the maximum concurrent connections to 10. ### Example 2 ```powershell $ConnectorConfig = Get-DeliveryAgentConnector "Contoso X.400 Connector" + $ConnectorConfig.AddressSpaces += "X400:c=US;p=Fabrikam;a=Contoso;o=Sales;1" + $ConnectorConfig.SourceTransportServers += Hub04; Set-DeliveryAgentConnector "Contoso X.400 Connector" -AddressSpaces $ConnectorConfig.AddressSpaces -SourceTransportServers $ConnectorConfig.SourceTransportServers ``` @@ -190,7 +192,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -339,12 +343,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-DetailsTemplate.md b/exchange/exchange-ps/exchange/Set-DetailsTemplate.md index dc2796c1ab..dfeb2f1c61 100644 --- a/exchange/exchange-ps/exchange/Set-DetailsTemplate.md +++ b/exchange/exchange-ps/exchange/Set-DetailsTemplate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-detailstemplate +online version: https://learn.microsoft.com/powershell/module/exchange/set-detailstemplate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-DetailsTemplate schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-DetailsTemplate cmdlet to modify the attributes of a details template. To make changes to the details template format and layout, you need to use the Details Templates Editor in the Exchange Toolbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Set-DetailsTemplate [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -138,12 +138,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md index 7ece095de6..0bbba58e9e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deviceconditionalaccesspolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconditionalaccesspolicy +applicable: Security & Compliance title: Set-DeviceConditionalAccessPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceConditionalAccessPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-DeviceConditionalAccessPolicy cmdlet to modify mobile device conditional access policies in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,9 +48,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -74,7 +74,7 @@ The Identity parameter specifies the mobile device conditional access policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -90,7 +90,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -106,7 +106,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -125,7 +125,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -144,7 +144,7 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -154,13 +154,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -170,13 +172,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -190,12 +192,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md index b073bce03a..f9e793ed4e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConditionalAccessRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deviceconditionalaccessrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconditionalaccessrule +applicable: Security & Compliance title: Set-DeviceConditionalAccessRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceConditionalAccessRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-DeviceConditionalAccessRule cmdlet to modify mobile device conditional access rules in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -84,9 +84,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -106,7 +106,7 @@ The Identity parameter specifies the mobile device conditional access rule that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -124,7 +124,7 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -143,7 +143,7 @@ The AccountName parameter specifies the account name. Valid values for this para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -162,7 +162,7 @@ The AccountUserName parameter specifies the account user name. Valid values for Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -187,7 +187,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -209,7 +209,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -231,7 +231,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -257,7 +257,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -282,7 +282,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -307,7 +307,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -332,7 +332,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -357,7 +357,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -379,7 +379,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -404,7 +404,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -430,7 +430,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -452,7 +452,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -474,7 +474,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -496,7 +496,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -517,7 +517,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -538,7 +538,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -563,7 +563,7 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -588,7 +588,7 @@ This setting is available only on Windows 8.1 RT devices. Type: CAAutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -610,7 +610,7 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -636,7 +636,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -655,7 +655,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -671,7 +671,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -690,7 +690,7 @@ The EmailAddress parameter specifies the email address. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -712,7 +712,7 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -731,7 +731,7 @@ The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -752,7 +752,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -774,7 +774,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -799,7 +799,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -825,7 +825,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -845,7 +845,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -855,7 +855,7 @@ Accept wildcard characters: False ``` ### -MoviesRating -The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. +The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: @@ -945,7 +945,7 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -964,7 +964,7 @@ The PasswordComplexity parameter specifies the password complexity. Valid values Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -990,7 +990,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1016,7 +1016,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1035,7 +1035,7 @@ The PasswordMinComplexChars parameter specifies the minimum number of complex ch Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1061,7 +1061,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1084,7 +1084,7 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1110,7 +1110,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1135,7 +1135,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1160,7 +1160,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1170,7 +1170,7 @@ Accept wildcard characters: False ``` ### -RegionRatings -The RegionRatings parameter specifies the rating system (country) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. +The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: @@ -1191,7 +1191,7 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1211,7 +1211,7 @@ The RequireEmailProfile parameter specifies whether an email profile is required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1233,7 +1233,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1255,7 +1255,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1265,7 +1265,7 @@ Accept wildcard characters: False ``` ### -TVShowsRating -The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. +The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: @@ -1344,7 +1344,7 @@ This setting is available only on Apple iOS 6+ devices. Type: CARatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1368,7 +1368,7 @@ This setting is available only on Windows 8.1 RT devices. Type: CAUserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1378,13 +1378,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1406,7 +1406,7 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1426,7 +1426,7 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1440,12 +1440,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md index 0cac0109f2..ed19ba795f 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deviceconfigurationpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconfigurationpolicy +applicable: Security & Compliance title: Set-DeviceConfigurationPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceConfigurationPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-DeviceConfigurationPolicy cmdlet to modify mobile device configuration policies in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,9 +48,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -74,7 +74,7 @@ The Identity parameter specifies the mobile device configuration policy that you Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -90,7 +90,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -106,7 +106,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -125,7 +125,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -144,7 +144,7 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -154,13 +154,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -170,13 +172,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -190,12 +192,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md index fd624d43e3..3ea511f71e 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceConfigurationRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-deviceconfigurationrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-deviceconfigurationrule +applicable: Security & Compliance title: Set-DeviceConfigurationRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceConfigurationRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-DeviceConfigurationRule cmdlet to modify mobile device configuration rules in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -83,9 +83,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -105,7 +105,7 @@ The Identity parameter specifies the mobile device configuration rule that you w Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -123,7 +123,7 @@ You can specify multiple groups separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -142,7 +142,7 @@ The AccountName parameter specifies the account name. Valid values for this para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -161,7 +161,7 @@ The AccountUserName parameter specifies the account user name. Valid values for Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -186,7 +186,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -208,7 +208,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -230,7 +230,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -256,7 +256,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -281,7 +281,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -306,7 +306,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -331,7 +331,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -353,7 +353,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -378,7 +378,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -404,7 +404,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -426,7 +426,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -448,7 +448,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -470,7 +470,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -491,7 +491,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -512,7 +512,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -537,7 +537,7 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingAppsEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -562,7 +562,7 @@ This setting is available only on Windows 8.1 RT devices. Type: AutoUpdateStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -584,7 +584,7 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -610,7 +610,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -629,7 +629,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -645,7 +645,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -664,7 +664,7 @@ The EmailAddress parameter specifies the email address. Valid values are: Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -686,7 +686,7 @@ This setting is available only on Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -705,7 +705,7 @@ The ExchangeActiveSyncHost parameter specifies the Exchange ActiveSync host. Val Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -726,7 +726,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Required Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -748,7 +748,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -773,7 +773,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -799,7 +799,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -819,7 +819,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -829,7 +829,7 @@ Accept wildcard characters: False ``` ### -MoviesRating -The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. +The MoviesRating parameter species the maximum or most restrictive rating of movies that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the MoviesRating parameter are: @@ -919,7 +919,7 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingMovieEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -938,7 +938,7 @@ The PasswordComplexity parameter specifies the password complexity. Valid values Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -964,7 +964,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -990,7 +990,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1009,7 +1009,7 @@ The PasswordMinComplexChars parameter specifies the minimum number of complex ch Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1035,7 +1035,7 @@ This setting is available on the following types of devices: Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1058,7 +1058,7 @@ This setting is available only on Android 4+ devices. Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1084,7 +1084,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1109,7 +1109,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = h Type: TimeSpan Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1134,7 +1134,7 @@ This setting is available on the following types of devices: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1144,7 +1144,7 @@ Accept wildcard characters: False ``` ### -RegionRatings -The RegionRatings parameter specifies the rating system (country) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. +The RegionRatings parameter specifies the rating system (country/region) to use for movie and television ratings with the MoviesRating and TVShowsRating parameters. Valid values for the RegionRating parameter are: @@ -1165,7 +1165,7 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingRegionEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1185,7 +1185,7 @@ The RequireEmailProfile parameter specifies whether an email profile is required Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1207,7 +1207,7 @@ This setting is available only on Windows 8.1 RT devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1229,7 +1229,7 @@ This setting is available only on Apple iOS 6+ devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1239,7 +1239,7 @@ Accept wildcard characters: False ``` ### -TVShowsRating -The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country rating system to use with the RegionRatings parameter. +The TVShowsRating parameter species the maximum or most restrictive rating of television shows that are allowed on devices. You specify the country/region rating system to use with the RegionRatings parameter. Valid values for the TVShowsRating parameter are: @@ -1318,7 +1318,7 @@ This setting is available only on Apple iOS 6+ devices. Type: RatingTvShowEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1342,7 +1342,7 @@ This setting is available only on Windows 8.1 RT devices. Type: UserAccountControlStatusEntry Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1352,13 +1352,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1380,7 +1380,7 @@ This setting is available only on Microsoft Windows Phone 8.1 devices. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1400,7 +1400,7 @@ This setting is available only on Windows 8.1 RT devices. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1414,12 +1414,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md b/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md index 3665b17e6c..4642570323 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DeviceTenantPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-devicetenantpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-devicetenantpolicy +applicable: Security & Compliance title: Set-DeviceTenantPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceTenantPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-DeviceTenantPolicy cmdlet to modify your organization's mobile device tenant policy in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,9 +48,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -70,7 +70,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -86,7 +86,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -105,7 +105,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -124,7 +124,7 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -134,13 +134,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -156,7 +158,7 @@ The Identity parameter specifies the name of the mobile device tenant policy tha Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -166,13 +168,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -186,12 +188,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md b/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md index a3291d87f9..e931196275 100644 --- a/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md +++ b/exchange/exchange-ps/exchange/Set-DeviceTenantRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-devicetenantrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-devicetenantrule +applicable: Security & Compliance title: Set-DeviceTenantRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DeviceTenantRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-DeviceTenantRule cmdlet to modify your organization's mobile device tenant rule in Basic Mobility and Security in Microsoft 365. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,9 +39,9 @@ The cmdlets in Basic Mobility and Security are described in the following list: - DeviceConfigurationPolicy and DeviceConfigurationRule cmdlets: Policies that control mobile device settings for supported devices. These policies are applied to security groups. - Get-DevicePolicy: Returns all Basic Mobility and Security policies regardless of type (DeviceTenantPolicy, DeviceConditionalAccessPolicy or DeviceConfigurationPolicy). -For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://docs.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). +For more information about Basic Mobility and Security, see [Overview of Basic Mobility and Security for Microsoft 365](https://learn.microsoft.com/microsoft-365/admin/basic-mobility-security/overview). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 Defender portal](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-microsoft-365-security-center) or [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Defender portal](https://learn.microsoft.com/defender-office-365/mdo-portal-permissions) or [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,7 +61,7 @@ The Identity parameter specifies the name of the mobile device tenant rule that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -81,7 +81,7 @@ The ApplyPolicyTo parameter specifies where to apply the policy in your organiza Type: PolicyResourceScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -100,7 +100,7 @@ The BlockUnsupportedDevices parameter specifies whether to block access to your Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -119,7 +119,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -135,7 +135,7 @@ This parameter is reserved for internal Microsoft use. Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -155,7 +155,7 @@ To enter multiple values and overwrite any existing entries, use the following s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -165,13 +165,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -185,12 +185,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DistributionGroup.md b/exchange/exchange-ps/exchange/Set-DistributionGroup.md index 1361f9bdfd..7d84dcf397 100644 --- a/exchange/exchange-ps/exchange/Set-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-distributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/set-distributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-DistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-DistributionGroup cmdlet to modify the settings of existing distribution groups or mail-enabled security groups. To add or remove group members, use the Add-DistributionGroupMember, Remove-DistributionGroupMember or Update-DistributionGroupMember cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,6 +48,7 @@ Set-DistributionGroup [-Identity] [-CustomAttribute7 ] [-CustomAttribute8 ] [-CustomAttribute9 ] + [-Description ] [-DisplayName ] [-DomainController ] [-EmailAddresses ] @@ -88,6 +89,7 @@ Set-DistributionGroup [-Identity] [-SendOofMessageToOriginatorEnabled ] [-SimpleDisplayName ] [-UMDtmfMap ] + [-UpdateMemberCount] [-WhatIf] [-WindowsEmailAddress ] [] @@ -96,7 +98,7 @@ Set-DistributionGroup [-Identity] ## DESCRIPTION Distribution groups are used to consolidate groups of recipients into a single point of contact for email messages. Distribution groups aren't security principals, and therefore can't be assigned permissions. However, you can assign permissions to mail-enabled security groups. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -228,7 +230,7 @@ To specify senders for this parameter, you can use any value that uniquely ident You can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: `Sender1,Sender2,...SenderN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Sender1","Sender2",..."SenderN"`. -To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters. +To add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers parameters. The individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command. @@ -248,15 +250,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -308,7 +315,10 @@ Accept wildcard characters: False ### -BccBlocked This parameter is available only in the cloud-based service. -{{ Fill BccBlocked Description }} +The BccBlocked parameter specifies whether members of the group don't receive messages if the group is used in the Bcc line. Valid values are: + +- $true: If the group is used in the Bcc line, members of the group don't receive the message, and the sender receives a non-delivery report (also known as an NDR or bounce message). Other recipients of the message aren't blocked. If an external sender uses the group in the Bcc line, members of the group aren't blocked. For nested groups, the message is blocked only for members of the top-level group. +- $false: There are no restrictions for using the group in the Bcc line of messages. This is the default value. ```yaml Type: Boolean @@ -374,13 +384,13 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -674,6 +684,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +This parameter is available only in the cloud-based service. + +The Description parameter specifies an optional description for the distribution group. If the value contains spaces, enclose the value in quotation marks. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -711,16 +739,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -904,7 +932,7 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -976,7 +1004,11 @@ Accept wildcard characters: False ### -HiddenGroupMembershipEnabled This parameter is available only in the cloud-based service. -{{ Fill HiddenGroupMembershipEnabled Description }} +The HiddenGroupMembershipEnabled switch specifies whether to hide the members of the distribution group from users who aren't members of the group. You don't need to specify a value with this switch. + +You can use this setting to help comply with regulations that require you to hide group membership from members or outsiders (for example, a distribution group that represents students enrolled in a class). + +**Note**: If you hide the membership of the group with this parameter, you can't edit the group later to reveal the membership to the group. ```yaml Type: SwitchParameter @@ -994,9 +1026,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -1086,7 +1118,14 @@ The ManagedBy parameter specifies an owner for the group. A group must have at l - Approve member depart or join requests (if available) - Approve messages sent to the group if moderation is enabled, but no moderators are specified. -The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the owner. For example: +The owner you specify for this parameter must be a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). + +Considerations for mail-enabled security groups as group owners: + +- If you specify a mail-enabled security group as a group owner in on-premises Exchange, the mail-enabled security group doesn't sync to the cloud object. +- Group management in Outlook doesn't work if the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. If you specify a mail-enabled security group as the owner of the group, the group isn't visible in **Distribution groups I own** for the group owners (members of the mail-enabled security group). + +You can use any value that uniquely identifies the owner. For example: - Name - Alias @@ -1103,7 +1142,7 @@ To enter multiple owners and overwrite all existing entries, use the following s To add or remove owners without affecting other existing entries, use the following syntax: `@{Add="Owner1","Owner2",...; Remove="Owner3","Owner4"...}`. -An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. +Owners that you specify with this parameter are not added as group members. You need to manually add the owner as a member. ```yaml Type: MultiValuedProperty @@ -1290,7 +1329,7 @@ Accept wildcard characters: False ### -PrimarySmtpAddress The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the group are no longer automatically updated by email address policies. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. @@ -1409,10 +1448,10 @@ Accept wildcard characters: False ``` ### -ReportToManagerEnabled -The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the owners of the group (defined by the ManagedBy property). Valid values are: +The ReportToManagerEnabled parameter specifies whether delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) are sent to the owner (first one listed if more than one) of the group (defined by the ManagedBy property). Valid values are: -- $true: Delivery status notifications are sent to the owners of the group. -- $false: Delivery status notifications aren't sent to the owners of the group. This is the default value. +- $true: Delivery status notifications are sent to the owner (first one listed if more than one) of the group. +- $false: Delivery status notifications aren't sent to the owner (first one listed if more than one) of the group. This is the default value. The ReportToManagerEnabled and ReportToOriginatorEnabled parameters affect the return path for messages sent to the group. Some email servers reject messages that don't have a return path. Therefore, you should set one parameter to $false and one to $true, but not both to $false or both to $true. @@ -1616,6 +1655,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UpdateMemberCount +This parameter is available only in the cloud-based service. + +{{ Fill UpdateMemberCount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -1658,12 +1715,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md b/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md index fdeaf244a0..f2b0ed064b 100644 --- a/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md +++ b/exchange/exchange-ps/exchange/Set-DkimSigningConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dkimsigningconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-dkimsigningconfig applicable: Exchange Online, Exchange Online Protection title: Set-DkimSigningConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-DkimSigningConfig cmdlet to modify the DomainKeys Identified Mail (DKIM) signing policy settings for domains in a cloud-based organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Set-DkimSigningConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -197,12 +197,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md index a8b3ca2679..ef3708c0cf 100644 --- a/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-DlpCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpcompliancepolicy +applicable: Security & Compliance title: Set-DlpCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DlpCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-DlpCompliancePolicy cmdlet to modify Data Loss Prevention (DLP) policies in the Microsoft 365 compliance center. +Use the Set-DlpCompliancePolicy cmdlet to modify data loss prevention (DLP) policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,6 +30,8 @@ Set-DlpCompliancePolicy [-Identity] [-AddOneDriveLocationException ] [-AddOnPremisesScannerDlpLocation ] [-AddOnPremisesScannerDlpLocationException ] + [-AddPowerBIDlpLocation ] + [-AddPowerBIDlpLocationException ] [-AddSharePointLocation ] [-AddSharePointLocationException ] [-AddTeamsLocation ] @@ -38,14 +40,26 @@ Set-DlpCompliancePolicy [-Identity] [-AddThirdPartyAppDlpLocationException ] [-Comment ] [-Confirm] + [-EndpointDlpAdaptiveScopes ] + [-EndpointDlpAdaptiveScopesException ] + [-EndpointDlpExtendedLocations ] + [-EnforcementPlanes ] [-ExceptIfOneDriveSharedBy ] [-ExceptIfOneDriveSharedByMemberOf ] + [-ExchangeAdaptiveScopes ] + [-ExchangeAdaptiveScopesException ] [-ExchangeSenderMemberOf ] [-ExchangeSenderMemberOfException ] [-Force] + [-IsFromSmartInsights ] + [-Locations ] [-Mode ] + [-OneDriveAdaptiveScopes ] + [-OneDriveAdaptiveScopesException ] [-OneDriveSharedBy ] [-OneDriveSharedByMemberOf ] + [-PolicyRBACScopes ] + [-PolicyTemplateInfo ] [-Priority ] [-RemoveEndpointDlpLocation ] [-RemoveEndpointDlpLocationException ] @@ -53,13 +67,20 @@ Set-DlpCompliancePolicy [-Identity] [-RemoveOneDriveLocation ] [-RemoveOneDriveLocationException ] [-RemoveOnPremisesScannerDlpLocation ] - [-RemovePremisesScannerDlpLocationException ] + [-RemoveOnPremisesScannerDlpLocationException ] + [-RemovePowerBIDlpLocation ] + [-RemovePowerBIDlpLocationException ] [-RemoveSharePointLocation ] [-RemoveSharePointLocationException ] [-RemoveTeamsLocation ] [-RemoveTeamsLocationException ] [-RemoveThirdPartyAppDlpLocation ] [-RemoveThirdPartyAppDlpLocationException ] + [-SharePointAdaptiveScopes ] + [-SharePointAdaptiveScopesException ] + [-StartSimulation ] + [-TeamsLocation ] + [-TeamsLocationException ] [-WhatIf] [] ``` @@ -73,7 +94,9 @@ Set-DlpCompliancePolicy [-Identity] [-RetryDistribution] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-DlpCompliancePolicy -Identity "Main PII" -RemoveExchangeLocation $_}`. ## EXAMPLES @@ -82,7 +105,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Set-DlpCompliancePolicy -Identity "Main PII" -AddSharePointLocation "https://my.url1/","https://my.url2/" -AddOneDriveLocation "https://my.url3/","https://my.url4/" ``` -This example adds the specified URLs to the SharePoint Online and OneDrive for Business locations for the DLP policy named Main PII without affecting the existing URL values. +This example adds the specified URLs to the SharePoint and OneDrive locations for the DLP policy named Main PII without affecting the existing URL values. ### Example 2 ```powershell @@ -91,6 +114,13 @@ Set-DlpCompliancePolicy -Identity MainPII -Mode Disable This example disables the "MainPII" policy. +### Example 3 +```powershell +Set-DlpCompliancePolicy -Identity "PowerBIPolicy" -AddPowerBILocation "workspaceID1","workspaceID2","workspaceID3" +``` + +This example adds the specified workspace IDs to the Power BI location for the DLP policy named PowerBIPolicy without affecting the existing workspace IDs. + ## PARAMETERS ### -Identity @@ -105,7 +135,7 @@ The Identity parameter specifies the DLP policy that you want to modify. You can Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -115,9 +145,9 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch redistributes the policy to all OneDrive for Business and SharePoint Online locations. You don't need to specify a value with this switch. +The RetryDistribution switch redistributes the policy to all Exchange, OneDrive, and SharePoint locations. You don't need to specify a value with this switch. -Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. +Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported if you used this switch. **Note**: Because the process of retrying distribution is a significant operation, run it only if necessary and for one policy at a time. It is not intended to be run every time you update a policy. If you run a script to update multiple policies, wait until the policy distribution is successful before running the command again for the next policy. @@ -125,7 +155,7 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -135,15 +165,19 @@ Accept wildcard characters: False ``` ### -AddEndpointDlpLocation -The AddEndpointDLPLocation parameter specifies the user accounts to add to the list of included accounts when you aren't using the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The AddEndpointDLPLocation parameter specifies the user accounts to add to the list of included accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -153,15 +187,19 @@ Accept wildcard characters: False ``` ### -AddEndpointDlpLocationException -The AddEndpointDlpLocationException parameter specifies the user accounts to add to the list of excluded accounts when you use the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The AddEndpointDlpLocationException parameter specifies the user accounts to add to the list of excluded accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -171,13 +209,21 @@ Accept wildcard characters: False ``` ### -AddExchangeLocation -This parameter is reserved for internal Microsoft use. +The AddExchangeLocation parameter adds email messages to the DLP policy if they're not already included. The valid value for this parameter is All. + +If the policy doesn't already include email messages (in the output of the Get-DlpCompliancePolicy cmdlet, the ExchangeLocation property value is blank), you can use this parameter in the following procedures: + +- If you use `-AddExchangeLocation All` by itself, the policy applies to email for all users. + +- To include email of specific group members in the policy, use `-AddExchangeLocation All` with the ExchangeSenderMemberOf parameter in the same command. Only email of members of the specified groups is included in the policy. + +- To exclude email of specific group members from the policy, use `-AddExchangeLocation All` with the ExchangeSenderMemberOfException parameter in the same command. Only email of members of the specified groups is excluded from the policy. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -187,15 +233,29 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation -The AddOneDriveLocation parameter specifies the OneDrive for Business sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. +The AddOneDriveLocation parameter adds OneDrive sites to the DLP policy if they're not already included. The valid value for this parameter is All. + +If the policy doesn't already include OneDrive sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is blank), you can use this parameter in the following procedures: + +- If you use `-AddOneDriveLocation All` by itself, the policy applies to all OneDrive sites. + +- To include sites of specific OneDrive accounts in the policy, use `-AddOneDriveLocation All` and the OneDriveSharedBy parameter to specify the users. Only the sites of the specified users are included in the policy. + +- To include sites of specific group members in the policy, use `-AddOneDriveLocation All` and the OneDriveSharedByMemberOf parameter to specify the groups. Only the sites of members of the specified groups are included in the policy. + +- To exclude sites of specific OneDrive accounts from the policy, use `-AddOneDriveLocation All` and the ExceptIfOneDriveSharedBy parameter to specify the users. Only sites of the specified users are excluded from the policy. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +- To exclude sites of specific group members from the policy, use `-AddOneDriveLocation All` and the ExceptIfOneDriveSharedByMemberOf parameter to specify the groups. Only sites of members of the specified groups are excluded from the policy. + +You can't specify inclusions and exclusions in the same policy. + +**Note**: Although this parameter accepts site URLs, don't specify site URLs values. Use the OneDriveSharedBy, ExceptIfOneDriveShareBy, OneDriveSharedByMemberOf, and ExceptIfOneDriveSharedByMemberOf parameters instead. In the DLP policy settings in the Microsoft Defender portal, you can't specify sites to include or exclude by URL; you specify sites to include or exclude only by users or groups. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -205,15 +265,13 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException -This parameter specifies the OneDrive for Business sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. - -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +Don't use this parameter. See the AddOneDriveLocation parameter for an explanation. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -223,13 +281,17 @@ Accept wildcard characters: False ``` ### -AddOnPremisesScannerDlpLocation -{{ Fill AddOnPremisesScannerDlpLocation Description }} +The AddOnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to add to the list of included repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -239,13 +301,65 @@ Accept wildcard characters: False ``` ### -AddOnPremisesScannerDlpLocationException -{{ Fill AddOnPremisesScannerDlpLocationException Description }} +The AddOnPremisesScannerDlpLocationExclusion parameter specifies the on-premises file shares and SharePoint document libraries and folders to add to the list of excluded repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddPowerBIDlpLocation +The AddPowerBIDlpLocation parameter specifies the Power BI workspace IDs to add to the list of included workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using one of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the command **Get-PowerBIWorkspace**. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddPowerBIDlpLocationException +The AddPowerBIDlpLocationException parameter specifies the Power BI workspace IDs to add to the list of excluded workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using one of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the command **Get-PowerBIWorkspace**. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -255,17 +369,17 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites if you used the value All for the SharePointLocation parameter. You identify the site by its URL value. -SharePoint Online sites can't be added to the policy until they have been indexed. +You can't add SharePoint sites to the policy until they have been indexed. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -275,15 +389,17 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException -This parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocationException parameter specifies the SharePoint sites to add to the list of excluded sites if you used the value All for the SharePointLocation parameter. You identify the site by its URL value. + +You can't add SharePoint sites to the policy until they have been indexed. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -293,15 +409,15 @@ Accept wildcard characters: False ``` ### -AddTeamsLocation -The AddTeamsLocation parameter specifies the Teams accounts to add to the list of included accounts when you aren't using the value All for the TeamsLocation parameter. You identify the account by its name or email address. +The AddTeamsLocation parameter specifies the accounts, distribution groups, or mail-enabled security groups to add to the list of included Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -311,15 +427,15 @@ Accept wildcard characters: False ``` ### -AddTeamsLocationException -The AddTeamsLocationException parameter specifies the Teams accounts to add to the list of excluded accounts when you use the value All for the TeamsLocation parameter. You identify the account by its name or email address. +The AddTeamsLocationException parameter specifies the accounts, distribution groups, or mail-enabled security groups to add to the list of excluded Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -329,13 +445,19 @@ Accept wildcard characters: False ``` ### -AddThirdPartyAppDlpLocation -{{ Fill AddThirdPartyAppDlpLocation Description }} +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The AddThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to add to the list of included apps if you used the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -345,13 +467,19 @@ Accept wildcard characters: False ``` ### -AddThirdPartyAppDlpLocationException -{{ Fill AddThirdPartyAppDlpLocationException Description }} +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The AddThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps to add to the list of excluded apps if you used the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -367,7 +495,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -386,7 +514,75 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpAdaptiveScopes +{{ Fill EndpointDlpAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpAdaptiveScopesException +{{ Fill EndpointDlpAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpExtendedLocations +{{ Fill EndpointDlpExtendedLocations Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementPlanes +The EnforcementPlanes parameter defines the layer where policy actions are run. This parameter uses the following syntax: + +`-EnforcementPlanes @("")`. + +Currently, the only supported value is Entra, for use with policies applied to an Entra-registered enterprise application in the organization. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -396,15 +592,22 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedBy -The ExceptIfOneDriveSharedBy parameter specifies the users to exclude in the DLP policy. You identify the user by email address. +The ExceptIfOneDriveSharedBy parameter specifies the users to exclude from the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, one of the following statements must be true: -To enter multiple values, use the following syntax: `,,...`. +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMemberOf parameters. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -414,15 +617,56 @@ Accept wildcard characters: False ``` ### -ExceptIfOneDriveSharedByMemberOf -The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups, mail-enabled security groups, or Microsoft 365 groups to exclude in the DLP policy. You identify the group by its email address. +The ExceptIfOneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to exclude from the DLP policy (the OneDrive sites of group members are excluded from the policy). You identify the groups by email address. + +To use this parameter, one of the following statements must be true: -To enter multiple values, use the following syntax: `,,...`. +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the OneDriveSharedBy or OneDriveSharedByMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopes +{{ Fill ExchangeAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExchangeAdaptiveScopesException +{{ Fill ExchangeAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -432,9 +676,16 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOf -The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to include in the DLP policy. You identify the group by its email address. +The ExchangeSenderMemberOf parameter specifies the distribution groups or security groups to include in the policy (email of the group members is included in the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: -You can enter multiple values separated by commas. +- The policy already includes email messages (in the output of Get-DlpCOmpliancePolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSenderMemberOfException parameter. You can't use this parameter to specify Microsoft 365 Groups. @@ -442,7 +693,7 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -452,9 +703,16 @@ Accept wildcard characters: False ``` ### -ExchangeSenderMemberOfException -The ExchangeSenderMemberOf parameter specifies the distribution groups, mail-enabled security groups, or dynamic distribution groups to exclude from the DLP policy. You identify the group by its email address. +The ExchangeSenderMemberOfException parameter specifies the distribution groups or security groups to exclude from the policy (email of the group members is excluded from the policy). You identify the groups by email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +To use this parameter, one of the following statements must be true: -You can enter multiple values separated by commas. +- The policy already includes email messages (in the output of Get-DlpCOmpliancePolicy, the ExchangeLocation property value is All). +- Use `-AddExchangeLocation All` in the same command with this parameter. + +You can't use this parameter with the ExchangeSenderMemberOf parameter. You can't use this parameter to specify Microsoft 365 Groups. @@ -462,7 +720,7 @@ You can't use this parameter to specify Microsoft 365 Groups. Type: RecipientIdParameter[] Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -472,13 +730,68 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsFromSmartInsights +{{ Fill IsFromSmartInsights Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +The Locations parameter specifies to whom, what, and where the DLP policy applies. This parameter uses the following properties: + +- Workload: What the DLP policy applies to. Use the value `Applications`. +- Location: Where the DLP policy applies. For Microsoft 365 Copilot, (Preview), use the value `470f2276-e011-4e9d-a6ec-20768be3a4b0`. +- AddInclusions or RemoveInclusions: Add or remove security groups, distribution groups, or users to or from the scope of this DLP policy. For users, use the email address in this syntax: `{Type:IndividualResource,Identity:}`. For security groups or distribution groups, use the ObjectId value of the group from the Microsoft Entra portal in this syntax: `{Type:Group,Identity:}`. +- AddExclusions or RemoveExclusions: Add or remove security groups, distribution groups, or users to or from exclusions to the scope of this DLP policy. For users, use the email address in this syntax: `{Type:IndividualResource,Identity:}`. For security groups or distribution groups, use the ObjectId value of the group from the Microsoft Entra portal in this syntax: `{Type:Group,Identity:}`. + +You create and store the properties in a variable as shown in the following examples: + +DLP policy scoped to all users in the tenant: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","AddInclusions":[{Type:"Tenant",Identity:"All"}]}]"` + +DLP policy scoped to the specified user and groups: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","AddInclusions":[{"Type":"Group","Identity":"fef0dead-5668-4bfb-9fc2-9879a47f9bdb"},{"Type":"Group","Identity":"b4dc1e1d-8193-4525-b59c-6d6e0f1718d2"},{"Type":"IndividualResource","Identity":"yibing@contoso.com"}]}]"` + +DLP policy scoped to all users in the tenant except for members of the specified group: + +`$loc = "[{"Workload":"Applications","Location":"470f2276-e011-4e9d-a6ec-20768be3a4b0","AddInclusions":[{Type:"Tenant",Identity:"All"}],"AddExclusions": [{"Type":"Group","Identity":"fef0dead-5668-4bfb-9fc2-9879a47f9bdb"},{"Type":"Group","Identity":"b4dc1e1d-8193-4525-b59c-6d6e0f1718d2"}]}]` + +After you create the `$loc` variable as shown in the previous examples, use the value `$loc` for this parameter. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -492,14 +805,46 @@ The Mode parameter specifies the action and notification level of the DLP policy - Enable: The policy is enabled for actions and notifications. This is the default value. - Disable: The policy is disabled. -- TestWithNotifications: No actions are taken, but notifications are sent. -- TestWithoutNotifications: An audit mode where no actions are taken, and no notifications are sent. +- TestWithNotifications: Simulation mode where no actions are taken, but notifications **are** sent. +- TestWithoutNotifications: Simulation mode where no actions are taken, and no notifications are sent. ```yaml Type: PolicyMode Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopes +{{ Fill OneDriveAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OneDriveAdaptiveScopesException +{{ Fill OneDriveAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -509,15 +854,22 @@ Accept wildcard characters: False ``` ### -OneDriveSharedBy -The OneDriveSharedBy parameter specifies the users to include in the DLP policy. You identify the user by email address. +The OneDriveSharedBy parameter specifies the users to include in the DLP policy (the sites of the OneDrive user accounts are included in the policy). You identify the users by UPN (`laura@contoso.onmicrosoft.com`). + +To use this parameter, one of the following statements must be true: -To enter multiple values, use the following syntax: `,,...`. +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDriveSharedByMemberOf parameters. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -527,15 +879,60 @@ Accept wildcard characters: False ``` ### -OneDriveSharedByMemberOf -The OneDriveSharedByMemberOf parameter specifies the distribution groups, mail-enabled security groups, or Microsoft 365 groups to include in the DLP policy. You identify the group by its email address. +The OneDriveSharedByMemberOf parameter specifies the distribution groups or mail-enabled security groups to include in the DLP policy (the OneDrive sites of group members are included in the policy). You identify the groups by email address. + +To use this parameter, one of the following statements must be true: -To enter multiple values, use the following syntax: `,,...`. +- The policy already includes OneDrive sites (in the output of Get-DlpCOmpliancePolicy, the OneDriveLocation property value is All, which is the default value). +- Use `-AddOneDriveLocation All` in the same command with this parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +You can't use this parameter with the ExceptIfOneDriveSharedBy or ExceptIfOneDriveSharedByMemberOf parameters. + +You can't use this parameter to specify Microsoft 365 Groups. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +The PolicyTemplateInfo specifies the built-in or custom DLP policy templates to use in the DLP policy. + +For more information about DLP policy templates, see [What the DLP policy templates include](https://learn.microsoft.com/purview/what-the-dlp-policy-templates-include). + +```yaml +Type: PswsHashtable +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -559,7 +956,7 @@ If you modify the priority value of a policy, the position of the policy in the Type: Int32 Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -569,15 +966,19 @@ Accept wildcard characters: False ``` ### -RemoveEndpointDlpLocation -The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of included accounts when you aren't using the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of included accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You specify the account by name or email address. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -587,15 +988,19 @@ Accept wildcard characters: False ``` ### -RemoveEndpointDlpLocationException -The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of excluded accounts when you use the value All for the EndpointDLPLocation parameter. You identify the account by name or email address. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The RemoveEndpointDlpLocation parameter specifies the user accounts to remove from the list of excluded accounts for Endpoint DLP if you used the value All for the EndpointDLPLocation parameter. You specify the account by name or email address. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -605,13 +1010,15 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocation -This parameter is reserved for internal Microsoft use. +The RemoveExchangeLocation parameter removes email messages from the DLP policy if they're already included. The valid value for this parameter is All. + +If the policy already includes email messages (in the output of the Get-DlpCompliancePolicy cmdlet, the ExchangeLocation property value is All), you can use `-RemoveExchangeLocation All` to prevent the policy from applying to email messages. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -621,15 +1028,17 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation -The RemoveOneDriveLocation parameter specifies the OneDrive for Business sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. +The RemoveOneDriveLocation parameter removes OneDrive sites from the DLP policy if they're already included. The valid value for this parameter is All. + +If the policy already includes OneDrive sites (in the output of the Get-DlpCompliancePolicy cmdlet, the OneDriveLocation property value is All), you can use `-RemoveOneDriveLocation All` to prevent the policy from applying to OneDrive sites. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +**Note**: Although this parameter accepts site URLs, don't specify site URLs values. Use the OneDriveSharedBy, ExceptIfOneDriveShareBy, OneDriveSharedByMemberOf, and ExceptIfOneDriveSharedByMemberOf parameters instead. In the DLP policy settings in the Microsoft Defender portal, you can't specify sites to include or exclude by URL; you specify sites to include or exclude only by users or groups. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -639,15 +1048,13 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException -This parameter specifies the OneDrive for Business sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. - -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +Don't use this parameter. See the RemoveOneDriveLocation parameter for an explanation. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -657,13 +1064,17 @@ Accept wildcard characters: False ``` ### -RemoveOnPremisesScannerDlpLocation -{{ Fill RemoveOnPremisesScannerDlpLocation Description }} +The RemoveOnPremisesScannerDlpLocation parameter specifies the on-premises file shares and SharePoint document libraries and folders to remove from the list of included repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -673,13 +1084,65 @@ Accept wildcard characters: False ``` ### -RemoveOnPremisesScannerDlpLocationException -{{ Fill RemoveOnPremisesScannerDlpLocationException Description }} +The RemoveOnPremisesScannerDlpLocationException parameter specifies the on-premises file shares and SharePoint document libraries and folders to remove from the list of excluded repositories if you used the value All for the OnPremisesScannerDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about the DLP on-premises scanner, see [Learn about the data loss prevention on-premises scanner](https://learn.microsoft.com/purview/dlp-on-premises-scanner-learn). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePowerBIDlpLocation +The RemovePowerBIDlpLocation parameter specifies the Power BI workspace IDs to remove from the list of included workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using one of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the command **Get-PowerBIWorkspace**. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemovePowerBIDlpLocationException +The RemovePowerBIDlpLocationException parameter specifies the Power BI workspace IDs to remove the list of excluded workspaces if you used the value All for the PowerBIDlpLocation parameter. Only workspaces hosted in Premium Gen2 capacities are permitted. + +You can find the workspace ID using one of the following procedures: + +- In the Admin portal, choose **Workspaces**, then select a workspace and choose **\> More options (...) \> Details**. +- Look in the URL of a selected workspace. +- In PowerShell, use the command **Get-PowerBIWorkspace**. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -689,15 +1152,15 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites if you used the value All for the SharePointLocation parameter. You specify the site by its URL value. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -707,15 +1170,15 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException -This parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocationException parameter specifies the SharePoint sites to remove from the list of excluded sites if you used the value All for the SharePointLocation parameter. You specify the site by its URL value. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -725,15 +1188,15 @@ Accept wildcard characters: False ``` ### -RemoveTeamsLocation -The RemoveTeamsLocation parameter specifies the Teams accounts to remove from the list of included accounts when you use the value All for the TeamsLocation parameter. You identify the account by its name or email address. +The RemoveTeamsLocation parameter specifies the accounts, distribution groups, or mail-enabled security groups to remove from the list of included Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You specify the entries by the email address or name of the account, distribution group, or mail-enabled security group. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -743,15 +1206,15 @@ Accept wildcard characters: False ``` ### -RemoveTeamsLocationException -The RemoveTeamsLocation parameter specifies the Teams accounts to remove from the list of excluded accounts when you aren't using the value All for the TeamsLocation parameter. You identify the account by its name or email address. +The RemoveTeamsLocationException parameter specifies the accounts, distribution groups, or mail-enabled security groups to remove from the list of excluded Teams chat and channel messages if you used the value All for the TeamsLocation parameter. You identify the entries by the email address or name of the account, distribution group, or mail-enabled security group. -You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -761,13 +1224,19 @@ Accept wildcard characters: False ``` ### -RemoveThirdPartyAppDlpLocation -{{ Fill RemoveThirdPartyAppDlpLocation Description }} +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The RemoveThirdPartyAppDlpLocation parameter specifies the non-Microsoft cloud apps to remove from the list of included apps if you used the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -777,13 +1246,99 @@ Accept wildcard characters: False ``` ### -RemoveThirdPartyAppDlpLocationException -{{ Fill RemoveThirdPartyAppDlpLocationException Description }} +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The RemoveThirdPartyAppDlpLocationException parameter specifies the non-Microsoft cloud apps tp remove from the list of excluded apps if you used the value All for the ThirdPartyAppDlpLocation parameter. + +To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`. + +For more information about DLP for non-Microsoft cloud apps, see [Use data loss prevention policies for non-Microsoft cloud apps](https://learn.microsoft.com/purview/dlp-use-policies-non-microsoft-cloud-apps). + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopes +{{ Fill SharePointAdaptiveScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharePointAdaptiveScopesException +{{ Fill SharePointAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartSimulation +{{ Fill StartSimulation Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAdaptiveScopes +{{ Fill TeamsAdaptiveScopes Description }} ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAdaptiveScopesException +{{ Fill TeamsAdaptiveScopesException Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -793,13 +1348,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -813,12 +1368,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md index 8186f51013..4a833c4d4b 100644 --- a/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-DlpComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlpcompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpcompliancerule +applicable: Security & Compliance title: Set-DlpComplianceRule schema: 2.0.0 author: chrisda @@ -12,62 +12,87 @@ ms.reviewer: # Set-DlpComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-DlpComplianceRule to modify Data Loss Prevention (DLP) rules in the Microsoft 365 compliance center. DLP rules define sensitive information to be protected and the actions to take on rule violations. +Use the Set-DlpComplianceRule to modify data loss prevention (DLP) rules in the Microsoft Purview compliance portal. DLP rules define sensitive information to be protected and the actions to take on rule violations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-DlpComplianceRule [-Identity] - [-AccessScope ] - [-ActivationDate ] + [-AccessScope ] + [-ActivationDate ] [-AddRecipients ] + [-AdvancedRule ] [-AlertProperties ] [-AnyOfRecipientAddressContainsWords ] [-AnyOfRecipientAddressMatchesPatterns ] + [-ApplyBrandingTemplate ] [-ApplyHtmlDisclaimer ] + [-AttachmentIsNotLabeled ] [-BlockAccess ] - [-BlockAccessScope ] + [-BlockAccessScope ] [-Comment ] [-Confirm] [-ContentCharacterSetContainsWords ] [-ContentContainsSensitiveInformation ] [-ContentExtensionMatchesWords ] + [-ContentFileTypeMatches ] + [-ContentIsNotLabeled ] + [-ContentIsShared ] [-ContentPropertyContainsWords ] [-Disabled ] + [-DocumentContainsWords ] + [-DocumentCreatedBy ] + [-DocumentCreatedByMemberOf ] [-DocumentIsPasswordProtected ] [-DocumentIsUnsupported ] + [-DocumentMatchesPatterns ] [-DocumentNameMatchesPatterns ] [-DocumentNameMatchesWords ] - [-DocumentSizeOver ] + [-DocumentSizeOver ] + [-DomainCountOver ] [-EncryptRMSTemplate ] + [-EndpointDlpBrowserRestrictions ] [-EndpointDlpRestrictions ] - [-ExceptIfAccessScope ] + [-EnforcePortalAccess ] + [-EvaluateRulePerComponent ] + [-ExceptIfAccessScope ] [-ExceptIfAnyOfRecipientAddressContainsWords ] [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] [-ExceptIfContentCharacterSetContainsWords ] [-ExceptIfContentContainsSensitiveInformation ] [-ExceptIfContentExtensionMatchesWords ] + [-ExceptIfContentFileTypeMatches ] + [-ExceptIfContentIsShared ] [-ExceptIfContentPropertyContainsWords ] + [-ExceptIfDocumentContainsWords ] + [-ExceptIfDocumentCreatedBy ] + [-ExceptIfDocumentCreatedByMemberOf ] [-ExceptIfDocumentIsPasswordProtected ] [-ExceptIfDocumentIsUnsupported ] + [-ExceptIfDocumentMatchesPatterns ] [-ExceptIfDocumentNameMatchesPatterns ] [-ExceptIfDocumentNameMatchesWords ] - [-ExceptIfDocumentSizeOver ] + [-ExceptIfDocumentSizeOver ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] [-ExceptIfFromAddressMatchesPatterns ] [-ExceptIfFromMemberOf ] - [-ExceptIfFromScope ] + [-ExceptIfFromScope ] [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesPatterns ] - [-ExceptIfMessageTypeMatches ] + [-ExceptIfMessageSizeOver ] + [-ExceptIfMessageTypeMatches ] [-ExceptIfProcessingLimitExceeded ] + [-ExceptIfRecipientADAttributeContainsWords ] + [-ExceptIfRecipientADAttributeMatchesPatterns ] [-ExceptIfRecipientDomainIs ] + [-ExceptIfSenderADAttributeContainsWords ] + [-ExceptIfSenderADAttributeMatchesPatterns ] [-ExceptIfSenderDomainIs ] [-ExceptIfSenderIPRanges ] [-ExceptIfSentTo ] @@ -77,58 +102,81 @@ Set-DlpComplianceRule [-Identity] [-ExceptIfSubjectOrBodyContainsWords ] [-ExceptIfSubjectOrBodyMatchesPatterns ] [-ExceptIfUnscannableDocumentExtensionIs ] - [-ExceptIfWithImportance ] - [-ExpiryDate ] + [-ExceptIfWithImportance ] + [-ExpiryDate ] [-From ] [-FromAddressContainsWords ] [-FromAddressMatchesPatterns ] [-FromMemberOf ] - [-FromScope ] + [-FromScope ] [-GenerateAlert ] [-GenerateIncidentReport ] [-HasSenderOverride ] [-HeaderContainsWords ] [-HeaderMatchesPatterns ] [-IncidentReportContent ] + [-MessageIsNotLabeled ] + [-MessageSizeOver ] [-MessageTypeMatches ] + [-MipRestrictAccess ] [-Moderate ] + [-ModifySubject ] + [-NonBifurcatingAccessScope ] [-NotifyAllowOverride ] + [-NotifyEmailCustomSenderDisplayName ] [-NotifyEmailCustomSubject ] [-NotifyEmailCustomText ] + [-NotifyEmailExchangeIncludeAttachment ] + [-NotifyEmailOnedriveRemediationActions ] + [-NotifyEndpointUser ] + [-NotifyOverrideRequirements ] + [-NotifyPolicyTipCustomDialog ] [-NotifyPolicyTipCustomText ] [-NotifyPolicyTipCustomTextTranslations ] + [-NotifyPolicyTipDisplayOption ] + [-NotifyPolicyTipUrl ] [-NotifyUser ] + [-NotifyUserType ] [-OnPremisesScannerDlpRestrictions ] [-PrependSubject ] - [-Priority ] + [-Priority ] [-ProcessingLimitExceeded ] + [-Quarantine ] + [-RecipientADAttributeContainsWords ] + [-RecipientADAttributeMatchesPatterns ] + [-RecipientCountOver ] [-RecipientDomainIs ] [-RedirectMessageTo ] [-RemoveHeader ] + [-RemoveRMSTemplate ] [-ReportSeverityLevel ] - [-RuleErrorAction ] + [-RestrictAccess ] + [-RestrictBrowserAccess ] + [-RuleErrorAction ] + [-SenderADAttributeContainsWords ] + [-SenderADAttributeMatchesPatterns ] + [-SenderAddressLocation ] [-SenderDomainIs ] [-SenderIPRanges ] [-SentTo ] [-SentToMemberOf ] [-SetHeader ] + [-SharedByIRMUserRisk ] [-StopPolicyProcessing ] [-SubjectContainsWords ] [-SubjectMatchesPatterns ] [-SubjectOrBodyContainsWords ] [-SubjectOrBodyMatchesPatterns ] - [-ProcessingLimitExceeded ] - [-ReportSeverityLevel ] - [-RuleErrorAction ] [-ThirdPartyAppDlpRestrictions ] + [-TriggerPowerAutomateFlow ] [-UnscannableDocumentExtensionIs ] [-WhatIf] - [-WithImportance ] + [-WithImportance ] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -139,6 +187,75 @@ Set-DlpComplianceRule -Identity 25bf67b6-3783-4f74-bde9-98dd40333082 -AccessScop This example modifies the access scope and blocking behavior of a DLP compliance rule that's identified by its GUID value. +### Example 2 +```powershell +# Contents of the file named C:\Data\Sensitive Type.txt: + +{ +"Version": "1.0", +"Condition": { + "Operator": "And", + "SubConditions": [ + { + "ConditionName": "ContentContainsSensitiveInformation", + "Value": [ + { + "groups": [ + { + "Operator": "Or", + "labels": [ + { + "name": "defa4170-0d19-0005-000a-bc88714345d2", + "type": "Sensitivity" + } + ], + "name": "Default", + "sensitivetypes": [ + { + "confidencelevel": "Low", + "name": "Credit Card Number" + } + ] + } + ] + } + ] + }, + { + "Operator": "Not", + "SubConditions": [ + { + "Operator": "OR", + "SubConditions": [ + { + "ConditionName": "FromMemberOf", + "Value": [ + "janesteam@contoso.com" + ] + }, + { + "ConditionName": "SentTo", + "Value": [ + "adele@contoso.com" + ] + } + ], + } + ] + } + ] + } +} + +$data = Get-Content -Path "C:\Data\Sensitive Type.txt" -ReadCount 0 + +$AdvancedRuleString = $data | Out-string + +Set-DLPComplianceRule -Identity "Contoso Rule 1" -AdvancedRule $AdvancedRuleString +``` + +This example uses the AdvancedRule parameter to read the following complex condition from a file: "Content contains sensitive information: "Credit card number OR Highly confidential" AND (NOT (Sender is a member of "Jane's Team" OR Recipient is "adele@contoso.com")). + ## PARAMETERS ### -Identity @@ -153,7 +270,7 @@ The Identity parameter specifies the DLP rule that you want to modify. You can u Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -165,15 +282,15 @@ Accept wildcard characters: False ### -AccessScope The AccessScope parameter specifies a condition for the DLP rule that's based on the access scope of the content. The rule is applied to content that matches the specified access scope. Valid values are: -- InOrganization: The rule is applied to content that's accessible inside the organization. -- NotInOrganization: The rule is applied to content that's accessible outside the organization. +- InOrganization: The rule is applied to content that's accessible or delivered to a recipient inside the organization. +- NotInOrganization: The rule is applied to content that's accessible or delivered to a recipient outside the organization. - None: The condition isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -186,10 +303,10 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -210,7 +327,27 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdvancedRule +The AdvancedRule parameter uses complex rule syntax that supports multiple AND, OR, and NOT operators and nested groups. + +This parameter uses JSON syntax that's similar to the traditional advanced syntax, but is read from a file that contains additional operators and combinations that aren't traditionally supported. + +For syntax details, see Example 2. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -226,7 +363,7 @@ Accept wildcard characters: False Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -242,7 +379,7 @@ The AnyOfRecipientAddressContainsWords parameter specifies a condition for the D - Multiple words: `no_reply,urgent,...` - Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` -The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. You can use this condition in DLP policies that are scoped only to Exchange. @@ -250,7 +387,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -262,7 +399,7 @@ Accept wildcard characters: False ### -AnyOfRecipientAddressMatchesPatterns The AnyOfRecipientAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this condition in DLP policies that are scoped only to Exchange. @@ -270,7 +407,25 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyBrandingTemplate +The ApplyBrandingTemplate parameter specifies an action for the DLP rule that applies a custom branding template for messages encrypted by Microsoft Purview Message Encryption. You identify the custom branding template by name. If the name contains spaces, enclose the name in quotation marks ("). + +Use the EnforcePortalAccess parameter to control whether external users are required to use the encrypted message portal to view encrypted messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -292,7 +447,23 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AttachmentIsNotLabeled +{{ Fill AttachmentIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -311,7 +482,7 @@ The BlockAccess parameter specifies an action for the DLP rule that blocks acces Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -323,15 +494,15 @@ Accept wildcard characters: False ### -BlockAccessScope The BlockAccessScope parameter specifies the scope of the block access action. Valid values are: -- All: Block access to everyone except the owner and the last modifier. -- PerUser: Block access to external users. -- PerAnonymousUser: Block access to people through the "Anyone with the link" option in SharePoint and OneDrive. +- All: Blocks access to everyone except the owner and the last modifier. +- PerUser: Blocks access to external users. +- PerAnonymousUser: Blocks access to people through the "Anyone with the link" option in SharePoint and OneDrive. ```yaml -Type: BlockAccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.BlockAccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -347,7 +518,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -362,11 +533,13 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -384,7 +557,7 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -394,17 +567,17 @@ Accept wildcard characters: False ``` ### -ContentContainsSensitiveInformation -The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. +The ContentContainsSensitiveInformation parameter specifies a condition for the rule that's based on a sensitive information type match in content. The rule is applied to content that contains the specified sensitive information type. In addition to sensitive information types, the parameter can also be applied to files that contain sensitivity labels. -This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `labels = @(@{name ="Confidential"; type ="Sensitivity";})` +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for a sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -414,13 +587,61 @@ Accept wildcard characters: False ``` ### -ContentExtensionMatchesWords -The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. +The ContentExtensionMatchesWords parameter specifies a condition for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentFileTypeMatches +{{ Fill ContentFileTypeMatches Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIsNotLabeled +{{ Fill ContentIsNotLabeled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentIsShared +{{ Fill ContentIsShared Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -438,7 +659,7 @@ This parameter accepts values in the format: `"Property1:Value1,Value2","Propert Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -457,7 +678,59 @@ The Disabled parameter specifies whether the DLP rule is disabled. Valid values Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentContainsWords +The DocumentContainsWords parameter specifies a condition for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. + +To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedBy +{{ Fill DocumentCreatedBy Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentCreatedByMemberOf +{{ Fill DocumentCreatedByMemberOf Description }} + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -467,7 +740,7 @@ Accept wildcard characters: False ``` ### -DocumentIsPasswordProtected -The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: - $true: Look for password protected files. - $false: Don't look for password protected files. @@ -476,7 +749,7 @@ The DocumentIsPasswordProtected parameter specifies a condition for the DLP rule Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -495,7 +768,27 @@ The DocumentIsUnsupported parameter specifies a condition for the DLP rule that Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DocumentMatchesPatterns +The DocumentMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -505,15 +798,15 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesPatterns -The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. +The DocumentNameMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -523,7 +816,7 @@ Accept wildcard characters: False ``` ### -DocumentNameMatchesWords -The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the file name of message attachments. You can specify multiple words or phrases separated by commas. +The DocumentNameMatchesWords parameter specifies a condition for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. - Single word: `"no_reply"` - Multiple words: `no_reply,urgent,...` @@ -535,7 +828,7 @@ The maximum individual word or phrase length is 128 characters. The maximum numb Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -560,11 +853,28 @@ Unqualified values are typically treated as bytes, but small values may be round You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: ByteQuantifiedSize +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainCountOver +The DomainCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipient domains is greater than the specified value. + +You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named Default value: None @@ -581,7 +891,23 @@ Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndpointDlpBrowserRestrictions +{{ Fill EndpointDlpBrowserRestrictions Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -591,7 +917,9 @@ Accept wildcard characters: False ``` ### -EndpointDlpRestrictions -The EndpointDlpRestrictions parameter specifies the restricted endpoints. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +The EndpointDlpRestrictions parameter specifies the restricted endpoints for Endpoint DLP. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. The value of `` is one of the supported values. @@ -607,15 +935,64 @@ Example values: - `@{"Setting"="Print"; "Value"="Audit";}` - `@{"Setting"="UnallowedApps"; "Value"="notepad"; "value2"="Microsoft Notepad"}` -When you use the values Block or Warn in this parameter, you also need to use the NotifyUser parameter. +When you use the values Block or Warn in this parameter, also need to use the NotifyUser parameter. You can view and configure the available restrictions with the Get-PolicyConfig and Set-PolicyConfig cmdlets. +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcePortalAccess +The EnforcePortalAccess parameter specifies whether external recipients are required to view encrypted mail using the encrypted message portal when the ApplyBrandingTemplate action is also specified. Valid values are: + +- $true: External recipients are required to use the encrypted message portal to view encrypted messages. +- $false: External recipients aren't required to use the encrypted message portal. Outlook can decrypt messages inline. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EvaluateRulePerComponent +The EvaluateRulePerComponent parameter specifies whether a match for conditions and exceptions in the rule is contained within the same message component. Valid values are: + +- $true: A DLP rule match for conditions and exceptions must be in the same message component (for example, in the message body or in a single attachment). +- $false: A DLP rule match for conditions and exceptions can be anywhere in the message. + +For example, say a DLP rule is configured to block messages that contain three or more Social Security numbers (SSNs). When the value of this parameter is $true, a message is blocked only if there are three or more SSNs in the message body, or there are three or more SSNs in a specific attachment. The DLP rule doesn't match and the message isn't blocked if there are two SSNs in the message body, one SSN in an attachment, and two SSNs in another attachment in the same email message. + +This parameter works with the following conditions or exceptions only: + +- Content contains +- Attachment contains +- Attachment is not labeled +- File extension is + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -627,15 +1004,15 @@ Accept wildcard characters: False ### -ExceptIfAccessScope The ExceptIfAccessScopeAccessScope parameter specifies an exception for the DLP rule that's based on the access scope of the content. The rule isn't applied to content that matches the specified access scope. Valid values are: -- InOrganization: The rule isn't applied to content that's accessible inside the organization. -- NotInOrganization: The rule isn't applied to content that's accessible outside the organization. +- InOrganization: The rule isn't applied to content that's accessible or delivered to a recipient inside the organization. +- NotInOrganization: The rule isn't applied to content that's accessible or delivered to a recipient outside the organization. - None: The exception isn't used. ```yaml -Type: AccessScope +Type: Microsoft.Office.CompliancePolicy.Tasks.AccessScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -651,7 +1028,7 @@ The ExceptIfAnyOfRecipientAddressContainsWords parameter specifies an exception - Multiple words: `no_reply,urgent,...` - Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` -The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 600. You can use this exception in DLP policies that are scoped only to Exchange. @@ -659,7 +1036,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -671,7 +1048,7 @@ Accept wildcard characters: False ### -ExceptIfAnyOfRecipientAddressMatchesPatterns The ExceptIfAnyOfRecipientAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this exception in DLP policies that are scoped only to Exchange. @@ -679,7 +1056,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -699,7 +1076,7 @@ Supported character sets are `big5, din_66003, euc-jp, euc-kr, gb18030, gb2312, Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -709,17 +1086,17 @@ Accept wildcard characters: False ``` ### -ExceptIfContentContainsSensitiveInformation -The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information type, the parameter can also be applied to files that contain sensitivity labels. +The ExceptIfContentContainsSensitiveInformation parameter specifies an exception for the rule that's based on a sensitive information type match in content. The rule isn't applied to content that contains the specified sensitive information type. In addition to sensitive information types, the parameter can also be applied to files that contain sensitivity labels. -This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for sensitivity label: `labels = @(@{name ="Confidential"; type ="Sensitivity";})` +This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. Example for a sensitivity label: `@(@{operator = "And"; groups = @(@{operator="Or";name="Default";labels=@(@{name="Confidential";type="Sensitivity"})})})`. -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). ```yaml Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -729,13 +1106,13 @@ Accept wildcard characters: False ``` ### -ExceptIfContentExtensionMatchesWords -The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file name extensions. You can specify multiple words separated by commas. +The ExceptIfContentExtensionMatchesWords parameter specifies an exception for the DLP rule that looks for words in file extensions. You can specify multiple words separated by commas. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -744,16 +1121,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfContentPropertyContainsWords -The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. - -This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. +### -ExceptIfContentFileTypeMatches +{{ Fill ExceptIfContentFileTypeMatches Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -762,17 +1137,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentIsPasswordProtected -The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: - -- $true: Look for password protected files. -- $false: Don't look for password protected files. +### -ExceptIfContentIsShared +{{ Fill ExceptIfContentIsShared Description }} ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -781,17 +1153,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentIsUnsupported -The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: +### -ExceptIfContentPropertyContainsWords +The ExceptIfContentPropertyContainsWords parameter specifies an exception for the DLP rule that's based on a property match in content. The rule is not applied to content that contains the specified property. -- $true: Look for unsupported files that can't be scanned. -- $false: Don't look for unsupported files that can't be scanned. +This parameter accepts values in the format: `"Property1:Value1,Value2","Property2:Value3,Value4",..."PropertyN:ValueN,ValueN"`. ```yaml -Type: Boolean +Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -800,16 +1171,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentNameMatchesPatterns -The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. +### -ExceptIfDocumentContainsWords +The ExceptIfDocumentContainsWords parameter specifies an exception for the DLP rule that looks for words in message attachments. Only supported attachment types are checked. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +To specify multiple words or phrases, this parameter uses the syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +You can use this exception in DLP policies that are scoped only to Exchange. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -818,20 +1191,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentNameMatchesWords -The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the file name of message attachments. You can specify multiple words or phrases separated by commas. - -- Single word: `"no_reply"` -- Multiple words: `no_reply,urgent,...` -- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` - -The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. +### -ExceptIfDocumentCreatedBy +{{ Fill ExceptIfDocumentCreatedBy Description }} ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -840,26 +1207,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfDocumentSizeOver -The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. - -When you enter a value, qualify the value with one of the following units: - -- B (bytes) -- KB (kilobytes) -- MB (megabytes) -- GB (gigabytes) -- TB (terabytes) - -Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. - -You can use this exception in DLP policies that are scoped only to Exchange. +### -ExceptIfDocumentCreatedByMemberOf +{{ Fill ExceptIfDocumentCreatedByMemberOf Description }} ```yaml -Type: ByteQuantifiedSize +Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -868,16 +1223,142 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfFrom -The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. - -You can use this exception in DLP policies that are scoped only to Exchange. +### -ExceptIfDocumentIsPasswordProtected +The ExceptIfDocumentIsPasswordProtected parameter specifies an exception for the DLP rule that looks for password protected files (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z, .rar, .tar, etc.), and .pdf files. Valid values are: + +- $true: Look for password protected files. +- $false: Don't look for password protected files. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentIsUnsupported +The ExceptIfDocumentIsUnsupported parameter specifies an exception for the DLP rule that looks for files that can't be scanned. Valid values are: + +- $true: Look for unsupported files that can't be scanned. +- $false: Don't look for unsupported files that can't be scanned. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentMatchesPatterns +The ExceptIfDocumentMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. + +You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesPatterns +The ExceptIfDocumentNameMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentNameMatchesWords +The ExceptIfDocumentNameMatchesWords parameter specifies an exception for the DLP rule that looks for words or phrases in the name of message attachments. You can specify multiple words or phrases separated by commas. + +- Single word: `"no_reply"` +- Multiple words: `no_reply,urgent,...` +- Multiple words and phrases: `"phrase 1",word1,"phrase with , or spaces",word2,...` + +The maximum individual word or phrase length is 128 characters. The maximum number of words or phrases is 50. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfDocumentSizeOver +The ExceptIfDocumentSizeOver parameter specifies an exception for the DLP rule that looks for messages where any attachment is greater than the specified size. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +The ExceptIfFrom parameter specifies an exception for the DLP rule that looks for messages from specific senders. You identify the senders by email address. You can specify multiple values separated by commas. + +You can use this exception in DLP policies that are scoped only to Exchange. ```yaml Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -901,7 +1382,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -913,7 +1394,7 @@ Accept wildcard characters: False ### -ExceptIfFromAddressMatchesPatterns The ExceptIfFromAddressMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this exception in DLP policies that are scoped only to Exchange. @@ -921,7 +1402,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -931,13 +1412,15 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf -This parameter is reserved for internal Microsoft use. +The FromMemberOf parameter specifies an exception for the DLP rule that looks for messages sent by group members. You identify the group by its email address. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -955,10 +1438,10 @@ The ExceptIfFromScope parameter specifies an exception for the rule that looks f You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: FromScope +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -979,7 +1462,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -999,7 +1482,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1017,7 +1500,35 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfMessageSizeOver +The ExceptIfMessageSizeOver parameter specifies an exception for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. + +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, although small values may be rounded up to the nearest kilobyte. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Exchange.Data.ByteQuantifiedSize +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1033,18 +1544,18 @@ The ExceptIfMessageTypeMatches parameter specifies an exception for the rule tha - AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). - AutomaticReply: Out of office (OOF) messages configured by the user. - Calendaring: Meeting requests and responses. -- Encrypted: Encrypted messages. -- PermissionControlled: Messages that have specific permissions configured. +- Encrypted: S/MIME encrypted messages. +- PermissionControlled: Messages protected with Rights Management, Office 365 Message Encryption (OME), and sensitivity labels (with encryption). - ReadReceipt: Read receipts. - Signed: Digitally signed messages. You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: MessageTypes +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1063,7 +1574,107 @@ The ExceptIfProcessingLimitExceeded parameter specifies an exception for the DLP Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeContainsWords +The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientADAttributeMatchesPatterns +The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1073,13 +1684,113 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeContainsWords +The ExceptIfSenderADAttributeContainsWords parameter specifies an exception for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderADAttributeMatchesPatterns +The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this exception in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1097,7 +1808,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1119,7 +1830,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1137,7 +1848,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1155,7 +1866,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1179,7 +1890,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1191,7 +1902,7 @@ Accept wildcard characters: False ### -ExceptIfSubjectMatchesPatterns The ExceptIfSubjectMatchesPatterns parameter specifies an exception for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this exception in DLP policies that are scoped only to Exchange. @@ -1199,7 +1910,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1219,7 +1930,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1237,7 +1948,7 @@ You can use this exception in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1247,7 +1958,7 @@ Accept wildcard characters: False ``` ### -ExceptIfUnscannableDocumentExtensionIs -The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. +The ExceptIfUnscannableDocumentExtensionIs parameter specifies an exception for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of the original file type, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -1255,7 +1966,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1274,10 +1985,10 @@ The ExceptIfWithImportance parameter specifies an exception for the rule that lo You can use this exception in DLP policies that are scoped only to Exchange. ```yaml -Type: WithImportance +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1290,10 +2001,10 @@ Accept wildcard characters: False This parameter is reserved for internal Microsoft use. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1311,7 +2022,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1335,7 +2046,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1347,7 +2058,7 @@ Accept wildcard characters: False ### -FromAddressMatchesPatterns The FromAddressMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the sender's email address by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this condition in DLP policies that are scoped only to Exchange. @@ -1355,7 +2066,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1365,13 +2076,15 @@ Accept wildcard characters: False ``` ### -FromMemberOf -This parameter is reserved for internal Microsoft use. +The FromMemberOf parameter specifies a condition for the DLP rule that looks for messages sent by group members. You identify the group by its email address. + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. ```yaml Type: SmtpAddress[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1383,16 +2096,16 @@ Accept wildcard characters: False ### -FromScope The FromScope parameter specifies a condition for the rule that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: FromScope +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.FromScope Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1409,13 +2122,13 @@ The GenerateAlert parameter specifies an action for the DLP rule that notifies t You can specify multiple values separated by commas. -The email message that's generated by this action contains a link to detailed information in the Microsoft 365 compliance center (the details aren't in the email message itself). +The email message that's generated by this action contains a link to detailed information in the Microsoft Purview compliance portal (the details aren't in the email message itself). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1436,7 +2149,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1457,7 +2170,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1477,7 +2190,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1495,7 +2208,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1519,7 +2232,7 @@ The IncidentReportContent parameter specifies the content to include in the repo - Service - Title -You can specify multiple values separated by commas. You can only use the value All by itself. If you use the value Default, the report includes the following content: +You can specify multiple values separated by commas. You can only use the value "All" by itself. If you use the value "Default", the report includes the following content: - DocumentAuthor - MatchedItem @@ -1527,13 +2240,13 @@ You can specify multiple values separated by commas. You can only use the value - Service - Title -Therefore, if you use any of these redundant values with the value Default, they will be ignored. +Therefore, any additional values that you use with the value "Default" are ignored. ```yaml Type: ReportContentOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1542,25 +2255,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MessageTypeMatches -The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: - -- ApprovalRequest: Moderation request messages sent to moderators. -- AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). -- AutomaticReply: Out of office (OOF) messages configured by the user. -- Calendaring: Meeting requests and responses. -- Encrypted: Encrypted messages. -- PermissionControlled: Messages that have specific permissions configured. -- ReadReceipt: Read receipts. -- Signed: Digitally signed messages. - -You can use this condition in DLP policies that are scoped only to Exchange. +### -MessageIsNotLabeled +{{ Fill MessageIsNotLabeled Description }} ```yaml -Type: MessageTypes +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1569,16 +2271,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Moderate -The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = @("emailaddress1","emailaddress2",..."emailaddressN")}`. +### -MessageSizeOver +The MessageSizeOver parameter specifies a condition for the DLP rule that looks for messages larger than the specified size. The size include the message and all attachments. -You can use this action in DLP policies that are scoped only to Exchange. +When you enter a value, qualify the value with one of the following units: + +- B (bytes) +- KB (kilobytes) +- MB (megabytes) +- GB (gigabytes) +- TB (terabytes) + +Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. + +You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: PswsHashtable +Type: Microsoft.Exchange.Data.ByteQuantifiedSize Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1587,12 +2299,120 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotifyAllowOverride -The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: - -- FalsePositive: Allows overrides in the case of false positives. -- WithoutJustification: Allows overrides without justification. -- WithJustification: Allows overrides with justification. +### -MessageTypeMatches +The MessageTypeMatches parameter specifies a condition for the rule that looks for messages of the specified type. Valid values are: + +- ApprovalRequest: Moderation request messages sent to moderators. +- AutomaticForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). +- AutomaticReply: Out of office (OOF) messages configured by the user. +- Calendaring: Meeting requests and responses. +- Encrypted: S/MIME encrypted messages. +- PermissionControlled: Messages protected with Rights Management, Office 365 Message Encryption (OME), and sensitivity labels (with encryption). +- ReadReceipt: Read receipts. +- Signed: Digitally signed messages. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.MessageTypes +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MipRestrictAccess +{{ Fill MipRestrictAccess Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Moderate +The Moderate parameter specifies an action for the DLP rule that sends the email message to a moderator. This parameter uses the syntax: `@{ModerateMessageByManager = <$true | $false>; ModerateMessageByUser = "emailaddress1,emailaddress2,...emailaddressN"}`. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModifySubject +The ModifySubject parameter uses regular expressions to find text patterns in the subject of the email message, and then modifies the subject with the text that you specify. This parameter uses the syntax: `@{Patterns="RegEx1","RegEx2",..."RegEx10}"; SubjectText="Replacement Text"; ReplaceStrategy="Value"}`. + +The `ReplaceStrategy=` property uses one of the following values: + +- Replace: Replaces all regular expression matches (the `Patterns=` value) in the subject with the `SubjectText=` value. +- Append: Removes all regular expression matches (the `Patterns=` value) in the subject and inserts the `SubjectText=` value at the end of the subject. +- Prepend: Removes all regular expression matches (the `Patterns=` value) and inserts the `SubjectText=` value at the beginning of the subject. + +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NonBifurcatingAccessScope +The NonBifurcatingAccessScope parameter specifies a condition for the DLP rule that looks for recipients in the specified access scope. The rule is applied to all copies of the message. Valid values are: + +- HasInternal: At least one recipient is inside the organization. +- HasExternal: At least one recipient is outside the organization. +- None: The condition isn't used. + +You can use this condition in DLP policies that are scoped only to Exchange + +```yaml +Type: Microsoft.Office.CompliancePolicy.Tasks.NonBifurcatingAccessScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyAllowOverride +The NotifyAllowOverride parameter specifies the notification override options when the conditions of the rule are met. Valid values are: + +- FalsePositive: Allows overrides in the case of false positives. +- WithAcknowledgement: Allows overrides with explicit user acknowledgement. (Exchange only) +- WithoutJustification: Allows overrides without justification. +- WithJustification: Allows overrides with justification. You can specify multiple values separated by commas. The values WithoutJustification and WithJustification are mutually exclusive. @@ -1600,7 +2420,23 @@ You can specify multiple values separated by commas. The values WithoutJustifica Type: OverrideOption[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailCustomSenderDisplayName +{{ Fill NotifyEmailCustomSenderDisplayName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1610,13 +2446,13 @@ Accept wildcard characters: False ``` ### -NotifyEmailCustomSubject -{{ Fill NotifyEmailCustomSubject Description }} +The NotifyEmailCustomSubject parameter specifies the custom text in the subject line of email notification message that's sent to recipients when the conditions of the rule are met. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1631,14 +2467,99 @@ The NotifyEmailCustomText parameter specifies the custom text in the email notif This parameter has a 5000 character limit, and supports plain text, HTML tags and the following tokens (variables): - %%AppliedActions%%: The actions applied to the content. -- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive for Business site. +- %%ContentURL%%: The URL of the document on the SharePoint site or OneDrive site. - %%MatchedConditions%%: The conditions that were matched by the content. Use this token to inform people of possible issues with the content. +- %%BlockedMessageInfo%%: The details of the message that was blocked. Use this token to inform people of the details of the message that was blocked. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailExchangeIncludeAttachment +{{ Fill NotifyEmailExchangeIncludeAttachment Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEmailOnedriveRemediationActions +{{ Fill NotifyEmailOnedriveRemediationActions Description }} + +```yaml +Type: NotifyEmailRemediationActions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyEndpointUser +**Note**: This parameter requires membership in the Compliance Administrator or Compliance Data Administrator roles in Microsoft Entra ID. + +{{ Fill NotifyEndpointUser Description }} + +For more information about Endpoint DLP, see [Learn about Endpoint data loss prevention](https://learn.microsoft.com/purview/endpoint-dlp-learn-about). + +```yaml +Type: PswsHashtable +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyOverrideRequirements +{{ Fill NotifyOverrideRequirements Description }} + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyOverrideRequirements +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipCustomDialog +{{ Fill NotifyPolicyTipCustomDialog Description }} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1654,7 +2575,7 @@ The NotifyPolicyTipCustomText parameter specifies the custom text in the Policy Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1664,13 +2585,52 @@ Accept wildcard characters: False ``` ### -NotifyPolicyTipCustomTextTranslations -This parameter is reserved for internal Microsoft use. +The NotifyPolicyTipCustomTextTranslations parameter specifies the localized policy tip text that's shown when the conditions of the rule are met, based on the client settings. This parameter uses the syntax `CultureCode:Text`. + +Valid culture codes are supported values from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. For example: `"en:PolicyTipInEnglish","zh:警告：这个文件含有非法内容","th:คำแนะนำนโยบายในไทย"`. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipDisplayOption +The NotifyPolicyTipDialogOption parameter specifies a display option for the policy tip. Valid values are: + +- Tip: Displays policy tip at the top of the mail. This is the default value. +- Dialog: Displays policy tip at the top of the mail and as a popup dialog. (exchange only) + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyTipDisplayOption +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyPolicyTipUrl +The NotifyPolicyTipUrl parameter specifies the URL in the popup dialog for Exchange workloads. This URL value has priority over the global: `Set-PolicyConfig -ComplianceUrl`. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1693,7 +2653,28 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotifyUserType +The NotifyUserType parameter specifies the type of notification that's used for the rule. Valid values are: + +- NotSet +- Email +- PolicyTip +- Email,PolicyTip + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.NotifyUserType +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1709,7 +2690,7 @@ Accept wildcard characters: False Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1719,7 +2700,7 @@ Accept wildcard characters: False ``` ### -PrependSubject -The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you want to add. If the text contains spaces, enclose the value in quotation marks ("). +The PrependSubject parameter specifies an action for the rule that adds text to add to the beginning of the Subject field of messages. The value for this parameter is the text that you specify. If the text contains spaces, enclose the value in quotation marks ("). Consider ending the value for this parameter with a colon (:) and a space, or at least a space, to separate it from the original subject. @@ -1729,7 +2710,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1747,13 +2728,13 @@ Valid values and the default value for this parameter depend on the number of ex - Valid priority values for a new 9th rule that you add to the policy are from 0 through 8. - The default value for a new 9th rule that you add to the policy is 8. -If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it is increased by 1. +If you modify the priority value of a rule, the position of the rule in the list changes to match the priority value you specify. In other words, if you set the priority value of a rule to the same value as an existing rule, the priority value of the existing rule and all other lower priority rules after it are increased by 1. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1772,7 +2753,78 @@ The ProcessingLimitExceeded parameter specifies a condition for the DLP rule tha Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Quarantine +This parameter specifies an action or part of an action for the rule. + +The Quarantine parameter specifies an action that quarantines messages. Valid values are: + +- $true: The message is delivered to the hosted quarantine. +- $false: The message is not quarantined. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientADAttributeContainsWords +The RecipientADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message recipients. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1781,14 +2833,81 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RecipientADAttributeMatchesPatterns +The RecipientADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message recipients by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientCountOver +The RecipientCountOver parameter specifies a condition for the DLP rule that looks for messages where the number of recipients is greater than the specified value. Groups are counted as one recipient. + +You can use this condition in DLP policies that are scoped only to Exchange. In PowerShell, you can use this parameter only inside an Advanced Rule. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition for the DLP rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1806,7 +2925,7 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1818,7 +2937,7 @@ Accept wildcard characters: False ### -RemoveHeader The RemoveHeader parameter specifies an action for the DLP rule that removes a header field from the message header. This parameter uses the syntax `HeaderName` or `"HeaderName:HeaderValue"`.You can specify multiple header names or header name and value pairs separated by commas: `HeaderName1,"HeaderName2:HeaderValue2",HeaderName3,..."HeaderNameN:HeaderValueN"`. -The maximum header name length is 64 characters, and header names can't contains spaces or colons ( : ). The maximum header value length is 128 characters. +The maximum header name length is 64 characters, and header names can't contain spaces or colons ( : ). The maximum header value length is 128 characters. You can use this action in DLP policies that are scoped only to Exchange. @@ -1826,7 +2945,28 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveRMSTemplate +The RemoveRMSTemplate parameter specifies an action for the DLP rule that removes Microsoft Purview Message Encryption from messages and their attachments. Valid values are: + +- $true: The message and attachments are decrypted. +- $False: The messages and attachments are not decrypted. + +You can use this action in DLP policies that are scoped only to Exchange. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1847,7 +2987,39 @@ The ReportSeverityLevel parameter specifies the severity level of the incident r Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictAccess +{{ Fill RestrictAccess Description }} + +```yaml +Type: System.Collections.Hashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestrictBrowserAccess +{{ Fill RestrictBrowserAccess Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1859,15 +3031,143 @@ Accept wildcard characters: False ### -RuleErrorAction The RuleErrorAction parameter specifies what to do if an error is encountered during the evaluation of the rule. Valid values are: -- Ignore -- RetryThenBlock -- Blank (the value $null): This is the default value. +- Ignore: Ignore the failure of the rule and thereby any actions in that rule and move to the next rule. +- RetryThenBlock: Do a maximum of 5 retries of the rule with an increasing time gap of 10 min (i.e, 1st retry happens after 10 min, 2nd retry after 20 min, etc.). After the failure of the fifth retry, the message is dropped and we send a non-delivery report (also known as an NDR or bounce messages). +- Blank (the value $null): Defer the delivery of the message and keep retrying the rule. This is the default value. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicyRuleErrorAction +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeContainsWords +The SenderADAttributeContainsWords parameter specifies a condition for the DLP rule that looks for words in Active Directory attributes of message senders. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="Word"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="Word1";AttributeName2="Word2";...AttributeNameN="WordN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderADAttributeMatchesPatterns +The SenderADAttributeMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in Active Directory attributes of message senders by using regular expressions. You can use any of the following Active Directory attributes: + +- City +- Company +- Country or Region +- CustomAttribute1 to CustomAttribute15 +- Department +- DisplayName +- Email Addresses +- Fax +- FirstName +- HomePhoneNumber +- Initials +- LastName +- Manager +- Mobile Phone +- Notes +- Office +- OtherFax +- OtherHomePhone +- Other Telephone +- Pager +- Phone +- Post Office Box +- State or Province +- Street Address +- Title +- UserLogonName +- Postal Code + +This parameter uses the syntax: `@{AttributeName="RegularExpression"}`. To specify multiple attributes, use the following syntax: `@{AttributeName1="RegularExpression1";AttributeName2="RegularExpression2";...AttributeNameN="RegularExpressionN"}`. Don't use words with leading or trailing spaces. + +When you specify multiple attributes, the OR operator is used. + +You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: PolicyRuleErrorAction +Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderAddressLocation +The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: + +- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value. +- Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). +- HeaderOrEnvelope: Examine senders in the message header and the message envelope. + +Note that message envelope searching is available only for the following conditions and exceptions: + +- From and ExceptIfFrom +- FromAddressContainsWords and ExceptIfFromAddressContainsWords +- FromAddressMatchesPatterns and ExceptIfFromAddressMatchesPatterns +- FromMemberOf and ExceptIfFromMemberOf +- SenderDomainIs and ExceptIfSenderDomainIs + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyEvaluation.PolicySenderAddressLocation +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1885,7 +3185,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1907,7 +3207,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1925,7 +3225,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1943,7 +3243,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1963,7 +3263,29 @@ You can use this action in DLP policies that are scoped only to Exchange. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedByIRMUserRisk +The SharedByIRMUserRisk parameter specifies the risk category of the user performing the violating action. Valid values are: + +- FCB9FA93-6269-4ACF-A756-832E79B36A2A (Elevated Risk Level) +- 797C4446-5C73-484F-8E58-0CCA08D6DF6C (Moderate Risk Level) +- 75A4318B-94A2-4323-BA42-2CA6DB29AAFE (Minor Risk Level) + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: All +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1982,7 +3304,7 @@ The StopPolicyProcessing parameter specifies an action that stops processing mor Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2006,7 +3328,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2018,7 +3340,7 @@ Accept wildcard characters: False ### -SubjectMatchesPatterns The SubjectMatchesPatterns parameter specifies a condition for the DLP rule that looks for text patterns in the Subject field of messages by using regular expressions. You can specify multiple text patterns by using the following syntax: `"regular expression1"|"regular expression2"|..."regular expressionN"`. -The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 10. +The maximum individual regular expression length is 128 characters. The maximum number of regular expressions is 300. You can use this condition in DLP policies that are scoped only to Exchange. @@ -2026,7 +3348,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2046,7 +3368,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2064,7 +3386,7 @@ You can use this condition in DLP policies that are scoped only to Exchange. Type: Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2080,7 +3402,23 @@ Accept wildcard characters: False Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerPowerAutomateFlow +{{ Fill TriggerPowerAutomateFlow Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -2090,7 +3428,7 @@ Accept wildcard characters: False ``` ### -UnscannableDocumentExtensionIs -The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. +The UnscannableDocumentExtensionIs parameter specifies a condition for the rule that looks for the specified true file extension when the files are unscannable. Irrespective of what the original file type is, this predicate matches based on the extension that is present in the name of the file. You can specify multiple values separated by commas. @@ -2098,7 +3436,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2108,13 +3446,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2133,10 +3471,10 @@ The WithImportance parameter specifies a condition for the rule that looks for m You can use this condition in DLP policies that are scoped only to Exchange. ```yaml -Type: WithImportance +Type: Microsoft.Office.CompliancePolicy.Tasks.WithImportance Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -2150,12 +3488,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md index d730a502bf..be8d02a43c 100644 --- a/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md +++ b/exchange/exchange-ps/exchange/Set-DlpEdmSchema.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/Set-DlpEdmSchema -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpedmschema +applicable: Security & Compliance title: Set-DlpEdmSchema schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DlpEdmSchema ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-DlpEdmSchema cmdlet to modify exact data match (EDM) data loss prevention (DLP) schemas in the Microsoft 365 compliance center. +Use the Set-DlpEdmSchema cmdlet to modify exact data match (EDM) data loss prevention (DLP) schemas in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,32 +28,31 @@ Set-DlpEdmSchema [-FileData] ``` ## DESCRIPTION -For an explanation and example of the EDM schema, see [Define the schema for your database of sensitive information](https://docs.microsoft.com/microsoft-365/compliance/create-custom-sensitive-information-types-with-exact-data-match-based-classification#define-the-schema-for-your-database-of-sensitive-information). +For an explanation and example of the EDM schema, see [Learn about exact data match based sensitive information types](https://learn.microsoft.com/purview/sit-learn-about-exact-data-match-based-sits). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell -$edmSchemaXml = Get-Content "C:\My Documents\edm.xml" -Encoding Byte -ReadCount 0 -Set-DlpEdmSchema -FileData $edmSchemaXml -Confirm:$true +Set-DlpEdmSchema -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\edm.xml')) -Confirm:$true ``` -This example modifies a DLP EDM schema. The first command reads the schema in the XML file to a variable, and the second command uses that information to modify the DLP EDM schema. +This example modifies a DLP EDM schema using the edm.xml file in the C:\\My Documents folder. ## PARAMETERS ### -FileData The FileData parameter specifies the DLP EDM schema that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -72,7 +71,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -82,13 +81,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -102,12 +101,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md index 8c158badb3..aa9f4a5616 100644 --- a/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md +++ b/exchange/exchange-ps/exchange/Set-DlpKeywordDictionary.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlpkeyworddictionary -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpkeyworddictionary +applicable: Security & Compliance title: Set-DlpKeywordDictionary schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-DlpKeywordDictionary ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-DlpKeywordDictionary cmdlet to modify data loss prevention (DLP) keyword dictionaries in the Microsoft 365 compliance center. +Use the Set-DlpKeywordDictionary cmdlet to modify data loss prevention (DLP) keyword dictionaries in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-DlpKeywordDictionary [-Identity] [-Confirm] [-Description ] + [-DoNotPersistKeywords] [-FileData ] [-Name ] [-WhatIf] @@ -31,14 +32,16 @@ Set-DlpKeywordDictionary [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell $Keywords = "Aarskog's syndrome, Abandonment, Abasia, Abderhalden-Kaufmann-Lignac, Abdominalgia, Abduction contracture, Abetalipo proteinemia, Abiotrophy, Ablatio, ablation, Ablepharia, Abocclusion, Abolition, Aborter, Abortion, Abortus, Aboulomania, Abrami's disease, Abramo" -$EncodedKeywords = [system.Text.Encoding]::Unicode.GetBytes($keywords) + +$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($keywords) + Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords ``` @@ -47,10 +50,15 @@ This example replaces the existing terms in the DLP keyword dictionary named Dis ### Example 2 ```powershell $Dictionary = Get-DlpKeywordDictionary -Name "Diseases" + $Terms = $Dictionary.KeywordDictionary.split(',').trim() + $Terms += "Achylia","Acidemia","Acidocytopenia","Acidocytosis","Acidopenia","Acidosis","Aciduria","Acladiosis","Aclasis" + $Keywords = $Terms -Join ", " -$EncodedKeywords = [system.Text.Encoding]::Unicode.GetBytes($Keywords) + +$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords) + Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords ``` @@ -59,11 +67,17 @@ This example adds the specified terms to the DLP keyword dictionary named Diseas ### Example 3 ```powershell $Dictionary = Get-DlpKeywordDictionary -Name "Diseases" + $Terms = $Dictionary.KeywordDictionary.split(',').trim() + $TermsToRemove = @('abandonment', 'ablatio') + $UpdatedTerms = $Terms | Where-Object {$_ -NotIn $TermsToRemove} + $Keywords = $UpdatedTerms -Join ", " -$EncodedKeywords = [system.Text.Encoding]::Unicode.GetBytes($Keywords) + +$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords) + Set-DlpKeywordDictionary -Identity "Diseases" -FileData $EncodedKeywords ``` @@ -72,11 +86,17 @@ This example removes the specified terms from the DLP keyword dictionary named D ### Example 4 ```powershell $Dictionary = Get-DlpKeywordDictionary -Name "Inappropriate Language" + $Terms = $Dictionary.KeywordDictionary.split(',').trim() + Set-Content $Terms -Path "C:\My Documents\InappropriateTerms.txt" + $UpdatedTerms = Get-Content -Path "C:\My Documents\InappropriateTerms.txt" + $Keywords = $UpdatedTerms -Join ", " -$EncodedKeywords = [system.Text.Encoding]::Unicode.GetBytes($Keywords) + +$EncodedKeywords = [System.Text.Encoding]::Unicode.GetBytes($Keywords) + Set-DlpKeywordDictionary -Identity "Inappropriate Language" -FileData $EncodedKeywords ``` @@ -93,7 +113,7 @@ The Identity parameter specifies the name of the DLP keyword dictionary that you Type: SensitiveInformationTypeIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -112,7 +132,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -128,7 +148,23 @@ The Description parameter specifies descriptive text for the DLP keyword diction Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DoNotPersistKeywords +{{ Fill DoNotPersistKeywords Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -138,14 +174,15 @@ Accept wildcard characters: False ``` ### -FileData -The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic. The maximum file size is up to 1 MB of terms after compression. The organization limit for all dictionaries is also 1 MB after compression. +The FileData parameter specifies the terms that are used in the DLP keyword dictionary. This parameter requires a comma-separated list of values that's binary encoded in UTF-16. For more information, see the examples in this topic. +The maximum file size is up to 1 MB of terms after compression. The organization limit for all dictionaries is also 1 MB after compression. ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -161,7 +198,7 @@ The Name parameter specifies a unique name for the DLP keyword dictionary. If th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -171,13 +208,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -191,12 +228,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DlpPolicy.md b/exchange/exchange-ps/exchange/Set-DlpPolicy.md index 61ce86ca65..74002da4a2 100644 --- a/exchange/exchange-ps/exchange/Set-DlpPolicy.md +++ b/exchange/exchange-ps/exchange/Set-DlpPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlppolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlppolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-DlpPolicy schema: 2.0.0 @@ -12,11 +12,13 @@ ms.reviewer: # Set-DlpPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +**Note**: This cmdlet has been retired from the cloud-based service. For more information, see [this blog post](https://techcommunity.microsoft.com/t5/exchange-team-blog/exchange-online-etrs-to-stop-supporting-dlp-policies/ba-p/3886713). Use the Set-DlpCompliancePolicy and Set-DlpComplianceRule cmdlets instead. -Use the Set-DlpPolicy cmdlet to modify data loss prevention (DLP) policies in your organization. +This cmdlet is functional only in on-premises Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Use the Set-DlpPolicy cmdlet to modify data loss prevention (DLP) policies that are based on transport rules (mail flow rules) in your organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +35,7 @@ Set-DlpPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -47,7 +49,11 @@ This example disables the DLP policy named Employee Numbers. ## PARAMETERS ### -Identity -The Identity parameter specifies the DLP policy you want to modify. You can use any value that uniquely identifies the DLP policy. For example, you can specify the name, GUID or distinguished name (DN) of the DLP policy. +The Identity parameter specifies the DLP policy that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: DlpPolicyIdParameter @@ -98,8 +104,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -190,12 +194,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md index f50c7a1d58..e6a09ab1b6 100644 --- a/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md +++ b/exchange/exchange-ps/exchange/Set-DlpSensitiveInformationType.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-dlpsensitiveinformationtype +applicable: Security & Compliance title: Set-DlpSensitiveInformationType schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-DlpSensitiveInformationType cmdlet to modify sensitive information type rules that use document fingerprints. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,9 +24,13 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-DlpSensitiveInformationType [-Identity] [-Confirm] [-Description ] + [-FileData ] [-Fingerprints ] + [-IsExact ] [-Locale ] [-Name ] + [-Threshold ] + [-ThresholdConfig ] [-WhatIf] [] ``` @@ -34,7 +38,7 @@ Set-DlpSensitiveInformationType [-Identity] ## DESCRIPTION Sensitive information type rule packages are used by DLP to detect sensitive content. The default sensitive information type rule package is named Microsoft Rule Package. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-DlpSensitiveInformationTypeRulePackage -FileData ([Byte[]]$(Get-Content -Path "C:\My Documents\External Sensitive Info Type Rule Collection.xml" -Encoding Byte -ReadCount 0)) +Set-DlpSensitiveInformationTypeRulePackage -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\External Sensitive Info Type Rule Collection.xml')) ``` This example imports the sensitive information type rule package C:\\My Documents\\External Sensitive Info Type Rule Collection.xml. @@ -46,13 +46,13 @@ This example imports the sensitive information type rule package C:\\My Document ### -FileData The FileData parameter specifies the sensitive information type rule package that you want to import. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `([Byte[]](Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -67,11 +67,13 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -81,13 +83,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,12 +103,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md index bf30d52203..4b26f36939 100644 --- a/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md +++ b/exchange/exchange-ps/exchange/Set-DynamicDistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-dynamicdistributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/set-dynamicdistributiongroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-DynamicDistributionGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-DynamicDistributionGroup cmdlet to modify existing dynamic distribution groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -74,6 +74,7 @@ Set-DynamicDistributionGroup [-Identity] [-ExtensionCustomAttribute3 ] [-ExtensionCustomAttribute4 ] [-ExtensionCustomAttribute5 ] + [-ForceMembershipRefresh] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] @@ -102,6 +103,7 @@ Set-DynamicDistributionGroup [-Identity] [-SendOofMessageToOriginatorEnabled ] [-SimpleDisplayName ] [-UMDtmfMap ] + [-UpdateMemberCount] [-WhatIf] [-WindowsEmailAddress ] [] @@ -116,11 +118,11 @@ The Conditional parameters that are used with the IncludedRecipients parameter a - The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPath filter. +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. -You can't use this cmdlet to replace a precanned filter with a custom OPath filter, or vice-versa. You can only modify the existing filter. +You can't use this cmdlet to replace a precanned filter with a custom OPATH filter, or vice-versa. You can only modify the existing filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -131,21 +133,20 @@ Set-DynamicDistributionGroup -Identity Developers -IncludedRecipients MailboxUse This example applies the following changes to the existing dynamic distribution group named Developers: -Change the ConditionalCompany query filter to Contoso. - -Change the IncludedRecipients query filter to MailboxUsers. - -Add the value Internal to the ConditionalCustomAttribute1 attribute. +- Change the ConditionalCompany query filter to Contoso. +- Change the IncludedRecipients query filter to MailboxUsers. +- Add the value Internal to the ConditionalCustomAttribute1 attribute. ### Example 2 ```powershell $extAtrValue="Contoso" + Set-DynamicDistributionGroup -Identity Developers -RecipientFilter "ExtensionCustomAttribute1 -eq '$extAtrValue'" ``` This example applies the following changes to the existing dynamic distribution group named Developers: -Sets the RecipientFilter custom OPath filter using a variable based value of a specific recipient property. +- Sets the RecipientFilter custom OPATH filter using a variable based value of a specific recipient property. ## PARAMETERS @@ -274,15 +275,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -1091,16 +1097,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -1151,12 +1157,11 @@ Accept wildcard characters: False ### -ExpansionServer This parameter is available only in on-premises Exchange. -The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange 2016 Mailbox server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. Therefore, you should consider implementing a high availability solution for an expansion server. +The ExpansionServer parameter specifies the Exchange server that's used to expand the distribution group. The default value is blank ($null), which means expansion happens on the closest available Exchange server. If you specify an expansion server, and that server is unavailable, any messages that are sent to the distribution group can't be delivered. You can specify the following types of servers as expansion servers: -- An Exchange 2016 Mailbox server. -- An Exchange 2013 Mailbox server. +- An Exchange 2013 or later Mailbox server. - An Exchange 2010 Hub Transport server. When you specify an expansion server, use the ExchangeLegacyDN. You can find this value by running the command: `Get-ExchangeServer | Format-List ExchangeLegacyDN`. An example value for this parameter is "/o=Contoso/ou=Exchange Administrative Group(FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Mailbox01". @@ -1284,8 +1289,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ForceMembershipRefresh +This parameter is available only in the cloud-based service. + +{{ Fill ForceMembershipRefresh Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -1357,9 +1380,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -1615,7 +1638,7 @@ The Notes parameters specifies additional information about the object. If the v Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1643,7 +1666,7 @@ Accept wildcard characters: False ### -PrimarySmtpAddress The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the group are no longer automatically updated by email address policies. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. @@ -1686,16 +1709,16 @@ Accept wildcard characters: False ``` ### -RecipientFilter -The RecipientFilter parameter specifies a custom OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -1965,6 +1988,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UpdateMemberCount +This parameter is available only in the cloud-based service. + +{{ Fill UpdateMemberCount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -1993,7 +2034,7 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2007,12 +2048,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md b/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md deleted file mode 100644 index 805e598953..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPDistributionGroup.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-eopdistributiongroup -applicable: Exchange Online Protection -title: Set-EOPDistributionGroup -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-EOPDistributionGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPDistributionGroup cmdlet to modify distribution groups or mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-DistributionGroup cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-EOPDistributionGroup [-Identity ] - [-Alias ] - [-DisplayName ] - [-ExternalDirectoryObjectId ] - [-ManagedBy ] - [-PrimarySmtpAddress ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-EOPDistributionGroup -Identity "Security Team" -PrimarySmtpAddress NewSecTeamId@Contoso.com -``` - -This example changes the current SMTP address of the Security Team EOP distribution group to "NewSecTeamId@Contoso.com". - -## PARAMETERS - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the alias of the distribution group. - -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the name of the distribution group in the Exchange admin center (EAC). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies one or more group owners. A group must have at least one owner. You can use any value that uniquely identifies the owner. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. - -The users specified with the ManagedBy parameter aren't automatically members of the distribution group. If you want any of the owners to be added as members of the distribution group, you need to add them by using the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimarySmtpAddress -The PrimarySmtpAddress parameter specifies the primary return SMTP email address for the distribution group. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EOPGroup.md b/exchange/exchange-ps/exchange/Set-EOPGroup.md deleted file mode 100644 index 09b32801d1..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPGroup.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-eopgroup -applicable: Exchange Online Protection -title: Set-EOPGroup -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-EOPGroup - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPGroup cmdlet to modify general group object attributes in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-Group cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-EOPGroup [-ExternalDirectoryObjectId ] - [-Identity ] - [-ManagedBy ] - [-Notes ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-Group -Identity "Legal Department" -Notes "Group members updated June 1, 2018" -``` - -This example sets the Notes property to indicate the last time that the group was updated. - -## PARAMETERS - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to modify. You can use any value that uniquely identifies the group. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: GroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -The ManagedBy parameter specifies a user who owns the group. You can use any value that uniquely identifies the user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -You can specify multiple owners by using the following syntax: `@("Owner1","Owner2",..."OwnerN")`. The values that you specify will overwrite the current list of owners. - -The users you specify with this parameter aren't automatically added to the group. To add members to the group, use the Update-EOPDistributionGroupMember cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EOPMailUser.md b/exchange/exchange-ps/exchange/Set-EOPMailUser.md deleted file mode 100644 index 3578b067d2..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPMailUser.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-eopmailuser -applicable: Exchange Online Protection -title: Set-EOPMailUser -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-EOPMailUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPMailUser cmdlet to modify mail users, also known as mail-enabled users, in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-MailUser cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-EOPMailUser [-Identity ] - [-Alias ] - [-DisplayName ] - [-EmailAddresses ] - [-ExternalDirectoryObjectId ] - [-MicrosoftOnlineServicesID ] - [-Password ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-EOPMailUser -Identity "Edward Meadows" -DisplayName "Ed Meadows" -``` - -This example changes the display name for the mail user Edward Meadows to "Ed Meadows." - -## PARAMETERS - -### -Identity -The Identity parameter specifies the mail user that you want to modify. You can use any value that uniquely identifies the mail user. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Domain\\Username -- Email address -- GUID -- LegacyExchangeDN -- SamAccountName -- User ID or user principal name (UPN) - -```yaml -Type: MailUserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias -The Alias parameter specifies the alias of the mail user. - -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the display name of the mail user in the Exchange admin center (EAC). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddresses -The EmailAddresses parameter specifies the primary email address and other proxy addresses for the mail user. This parameter uses the syntax `SMTP:,`. - -The values that you specify for this parameter overwrite any existing values. - -```yaml -Type: ProxyAddressCollection -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MicrosoftOnlineServicesID -The MicrosoftOnlineServicesID parameter specifies the user account for the mail user. - -```yaml -Type: SmtpAddress -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md new file mode 100644 index 0000000000..2f487200f3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-EOPProtectionPolicyRule.md @@ -0,0 +1,321 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-eopprotectionpolicyrule +applicable: Exchange Online, Exchange Online Protection +title: Set-EOPProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-EOPProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-EOPProtectionPolicyRule cmdlet to modify rules that are associated with Exchange Online Protection (EOP) protections in preset security policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-EOPProtectionPolicyRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-Name ] + [-Priority ] + [-RecipientDomainIs ] + [-SentTo ] + [-SentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://learn.microsoft.com/defender-office-365/preset-security-policies#preset-security-policies-in-exchange-online-powershell). + +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Profiles in preset security policies](https://learn.microsoft.com/defender-office-365/preset-security-policies#profiles-in-preset-security-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" -ExceptIfSentToMemberOf "Test Group1","Test Group2" +``` + +This example provides exceptions to EOP protections in the Standard preset security policy for members of the specified groups. + +### Example 2 +```powershell +Set-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy" -SentTo $null -ExceptIfSentTo $null -SentToMemberOf $null -ExceptIfSentToMemberOf $null -RecipientDomainIs $null -ExceptIfRecipientDomainIs $null +``` + +This example removes all conditions and exceptions from the Standard preset security policy. No restrictions are placed on who the Defender for Office 365 protections apply to. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example: + +- Name +- Distinguished name (DN) +- GUID + +By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no exception is made for messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies a unique name for the rule. The maximum length is 64 characters. + +By default, the rules are named Standard Preset Security Policy or Strict Preset Security Policy. We highly recommend that you use the default rule names for clarity and consistency. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Priority +The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't have the same priority value. + +The default value for the rule that's associated with the Strict preset security policy is 0, and the default value for the rule that's associated with the Standard preset security policy is 1. + +You must use the default value for the rule. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientDomainIs +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentToMemberOf +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +If you remove the group after you create the rule, no action is taken on messages that are sent to members of the group. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EOPUser.md b/exchange/exchange-ps/exchange/Set-EOPUser.md deleted file mode 100644 index a91345984b..0000000000 --- a/exchange/exchange-ps/exchange/Set-EOPUser.md +++ /dev/null @@ -1,424 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-eopuser -applicable: Exchange Online Protection -title: Set-EOPUser -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-EOPUser - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Set-EOPUser cmdlet to modify general user object attributes in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Set-User cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-EOPUser [-Identity ] - [-City ] - [-Company ] - [-CountryOrRegion ] - [-Department ] - [-DisplayName ] - [-ExternalDirectoryObjectId ] - [-Fax ] - [-FirstName ] - [-HomePhone ] - [-Initials ] - [-LastName ] - [-MobilePhone ] - [-Notes ] - [-Office ] - [-Phone ] - [-PostalCode ] - [-StateOrProvince ] - [-StreetAddress ] - [-Title ] - [-WebPage ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-EOPUser -Identity "Kitty Petersen" -Company Contoso -DisplayName "Kitty Petersen" -Title "Vice President" -``` - -This example sets the company, display name, and title properties for the user Kitty Petersen. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the user object that you want to modify. You can use any value that uniquely identifies the user. For example: - -- Name -- Distinguished name (DN) -- Canonical DN -- GUID - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -The City parameter specifies the user's city. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Company -The Company parameter specifies the user's company. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountryOrRegion -The CountryOrRegion parameter specifies the user's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name). - -A reference for two-letter country codes is available at [Country Codes List](https://www.nationsonline.org/oneworld/country_code_list.htm). - -The friendly name is returned in the CountryOrRegion property value by the Get-User cmdlet, but you can use either the friendly name or the two-letter country code in filter operations. - -```yaml -Type: CountryInfo -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Department -The Department parameter specifies the user's department. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -The DisplayName parameter specifies the user's display name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Fax -The Fax parameter specifies the user's fax number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePhone -The HomePhone parameter specifies the user's home telephone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Initials -The Initials parameter specifies the user's middle initials. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastName -The FirstName parameter specifies the user's first name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MobilePhone -The MobilePhone parameter specifies the user's primary mobile phone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Office -The Office parameter specifies the user's physical office name or number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Phone -The Phone parameter specifies the user's telephone number. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -The PostalCode parameter specifies the user's zip code or postal code. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateOrProvince -The StateOrProvince parameter specifies the user's state or province. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetAddress -The StreetAddress parameter specifies the user's physical address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -The Title parameter specifies the user's title. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebPage -The WebPage parameter specifies the user's Web page. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md index 314d98e03e..3383449510 100644 --- a/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-EcpVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ecpvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/set-ecpvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-EcpVirtualDirectory schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Set-EcpVirtualDirectory cmdlet to modify Exchange Control Panel (ECP) vi The ECP web management interface was introduced in Exchange Server 2010. In Exchange Server 2013 and Exchange Server 2016, the EAC virtual directories and the corresponding management cmdlets still use ECP in the name. You can use these cmdlets to manage ECP virtual directories on Exchange 2010, Exchange 2013, and Exchange 2016 servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,6 +38,7 @@ Set-EcpVirtualDirectory [-Identity] [-FormsAuthentication ] [-GzipLevel ] [-InternalUrl ] + [-OAuthAuthentication ] [-OwaOptionsEnabled ] [-WhatIf] [-WindowsAuthentication ] @@ -45,7 +46,7 @@ Set-EcpVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -108,7 +109,7 @@ Accept wildcard characters: False ``` ### -AdminEnabled -The AdminEnabled parameter specifies that the EAC isn't able to be accessed through the Internet. For more information, see [Turn off access to the Exchange admin center](https://docs.microsoft.com/Exchange/architecture/client-access/disable-exchange-admin-center-access). This parameter accepts $true or $false. +The AdminEnabled parameter specifies that the EAC isn't able to be accessed through the Internet. For more information, see [Turn off access to the Exchange admin center](https://learn.microsoft.com/Exchange/architecture/client-access/disable-exchange-admin-center-access). This parameter accepts $true or $false. ```yaml Type: Boolean @@ -348,6 +349,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OAuthAuthentication +{{ Fill OAuthAuthentication Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OwaOptionsEnabled The OwaOptionsEnabled parameter specifies that Outlook on the web Options is enabled for end users. If this parameter is set to $false, users aren't able to access Outlook on the web Options. You may want to disable access if your organization uses third-party provider tools. This parameter accepts $true or $false. @@ -404,12 +421,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md b/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md index a12c094379..e63e09bc66 100644 --- a/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md +++ b/exchange/exchange-ps/exchange/Set-EdgeSyncServiceConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-edgesyncserviceconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-edgesyncserviceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-EdgeSyncServiceConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-EdgeSyncServiceConfig cmdlet to modify the configuration of edge synchronization service settings that control the general synchronization behavior shared by all EdgeSync services. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ Set-EdgeSyncServiceConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -405,12 +405,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md index d815a8696f..3d157d6042 100644 --- a/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Set-EmailAddressPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-emailaddresspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-EmailAddressPolicy schema: 2.0.0 @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Set-EmailAddressPolicy cmdlet to modify email address policies. In Exchange Online, email address policies are only available for Microsoft 365 Groups. +Use the Set-EmailAddressPolicy cmdlet to modify email address policies. In Exchange Online, email address policies are available only for Microsoft 365 Groups. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -64,11 +64,11 @@ The Conditional parameters that are used with the IncludedRecipients parameter a - The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPath filter. +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. -You can't use this cmdlet to replace a precanned filter with a custom OPath filter, or vice-versa. You can only modify the existing filter. +You can't use this cmdlet to replace a precanned filter with a custom OPATH filter, or vice-versa. You can only modify the existing filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -91,7 +91,7 @@ In on-premises Exchange, this example clears the disabled email address template Set-EmailAddressPolicy -Identity "Office 365 Groups" -EnabledEmailAddressTemplates "SMTP:@contoso.com","smtp:@contoso.onmicrosoft.com","smtp:@contoso.microsoftonline.com" ``` -In Exchange Online, this example modifies the existing email adress policy named "Office 365 Groups" and sets the enabled email address templates to use "@contoso.com" as the primary SMTP address and "@contoso.onmicrosoft.com" and "@contoso.microsoftonline.com" as proxy addresses. +In Exchange Online, this example modifies the existing email address policy named "Office 365 Groups" and sets the enabled email address templates to use "@contoso.com" as the primary SMTP address and "@contoso.onmicrosoft.com" and "@contoso.microsoftonline.com" as proxy addresses. ## PARAMETERS @@ -573,8 +573,8 @@ The DisabledEmailAddressTemplates parameter specifies the proxy email addresses Valid syntax for this parameter is `Type:AddressFormat`: -- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. -- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. +- Type: A valid email address type as described in the "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, smtp or X400. Note that you can't use SMTP to specify a disabled primary SMTP email address. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. You can specify multiple disabled email address templates separated by commas: `"[Type1:]EmailAddress1","[Type2:]EmailAddress2",..."[TypeN:]EmailAddressN"`. @@ -616,8 +616,8 @@ The EnabledEmailAddressTemplates parameter specifies the rules in the email addr Valid syntax for this parameter is `Type:AddressFormat`: -- Type: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. -- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. +- Type: A valid email address type as described in "Address types" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example, SMTP for the primary email address, and smtp for proxy addresses. +- AddressFormat: For SMTP email addresses, a domain or subdomain that's configured as accepted domain (authoritative or internal relay), and valid variables and ASCII text characters as described in the "Address formats" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. This parameter requires at least one template with the Type value SMTP (to define the primary SMTP email address). After that, if you don't include a Type prefix for a template, the value smtp (an SMTP proxy address) is assumed. @@ -641,9 +641,9 @@ Accept wildcard characters: False ``` ### -EnabledPrimarySMTPAddressTemplate -The EnabledPrimarySMTPAddressTemplate parameter specifies the specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. +The EnabledPrimarySMTPAddressTemplate parameter specifies the rule in the email address policy that's used to generate the primary SMTP email addresses for recipients. You can use this parameter instead of the EnabledEmailAddressTemplates if the policy only applies the primary email address and no additional proxy addresses. -Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. +Valid syntax for this parameter is a domain or subdomain that's configured as an authoritative accepted domain, and valid variables and ASCII text characters as described in the "Address format" section in [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). For example: alias@contoso.com requires the value `%m@contoso.com`, and firstname.lastname@contoso.com requires the value `%g.%s@contoso.com`. You can't use this parameter with the EnabledEmailAddressTemplates parameter. @@ -663,7 +663,7 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -769,15 +769,15 @@ Accept wildcard characters: False ### -RecipientFilter This parameter is available only in on-premises Exchange. -The RecipientFilter parameter specifies a custom OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The RecipientFilter parameter specifies a custom OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). - Wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -813,12 +813,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md b/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md new file mode 100644 index 0000000000..795f69bb1f --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-EmailTenantSettings.md @@ -0,0 +1,158 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-emailtenantsettings +applicable: Exchange Online +title: Set-EmailTenantSettings +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-EmailTenantSettings + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-EmailTenantSettings cmdlet to enable or disable priority account protection in your Microsoft Defender for Office 365 organization. For more information about priority accounts, see [Manage and monitor priority accounts](https://learn.microsoft.com/microsoft-365/admin/setup/priority-accounts). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-EmailTenantSettings [[-Identity] ] + [-Confirm] + [-DomainController ] + [-EnablePriorityAccountProtection ] + [-IgnoreDehydratedFlag] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-EmailTenantSettings -EnablePriorityAccountProtection $true +``` + +This example enables priority account protection in the organization. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the settings object that you want to modify. The only settings object in the organization is named Default. + +```yaml +Type: EmailTenantSettingsIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnablePriorityAccountProtection +The EnablePriorityAccountProtection parameter enables or disable priority account protection in the organization. Valid values are: + +- $true: Priority account protection is enabled. +- $false: Priority account protection is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDehydratedFlag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-EventLogLevel.md b/exchange/exchange-ps/exchange/Set-EventLogLevel.md index 0ef7d9c80e..4b819c2bb3 100644 --- a/exchange/exchange-ps/exchange/Set-EventLogLevel.md +++ b/exchange/exchange-ps/exchange/Set-EventLogLevel.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-eventloglevel +online version: https://learn.microsoft.com/powershell/module/exchange/set-eventloglevel applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-EventLogLevel schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-EventLogLevel cmdlet to set the event log level registry value for the specified category. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Set-EventLogLevel [-Identity] -Level ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -39,7 +39,7 @@ Set-EventLogLevel -Identity "Exchange01\MSExchangeTransport\SmtpReceive" -Level This example sets the event log level to High for the MSExchangeTransport\\SmtpReceive event logging category on the Exchange server Exchange01. -**Note**: Run the Get-EventLogLevel cmdlet to retrieve a list of the event categories on your server. For more information, see [Get-EventLogLevel](https://docs.microsoft.com/powershell/module/exchange/get-eventloglevel). +**Note**: Run the Get-EventLogLevel cmdlet to retrieve a list of the event categories on your server. For more information, see [Get-EventLogLevel](https://learn.microsoft.com/powershell/module/exchange/get-eventloglevel). ## PARAMETERS @@ -121,12 +121,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md index 2d4e7876c4..77225894de 100644 --- a/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-EventsFromEmailConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-eventsfromemailconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/set-eventsfromemailconfiguration applicable: Exchange Online title: Set-EventsFromEmailConfiguration schema: 2.0.0 @@ -12,11 +12,11 @@ ms.reviewer: # Set-EventsFromEmailConfiguration ## SYNOPSIS -This cmdlet is only available in the cloud-based service. +This cmdlet is available only in the cloud-based service. Use the Set-EventsFromEmailConfiguration cmdlet to modify the events from email settings on a mailbox. on Outlook clients and Outlook on the web. These settings define whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to the user's calendar. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ Set-EventsFromEmailConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -128,6 +128,8 @@ The FlightReservationProcessingLevel parameter specifies whether flight reservat - Email: Discover flight reservations from messages, but don't automatically add them to the user's calendar. - Calendar: Discover flight reservations from messages and automatically add them to the user's calendar. This is the default value. +Note that these values are case sensitive. + ```yaml Type: String Parameter Sets: Identity @@ -270,12 +272,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md b/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md index e36b7ec64c..69e2cfccc7 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeAssistanceConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-exchangeassistanceconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangeassistanceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ExchangeAssistanceConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ExchangeAssistanceConfig cmdlet to modify the Microsoft Exchange Help configurations for your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,7 +46,7 @@ Set-ExchangeAssistanceConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -408,12 +408,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ExchangeFeature.md b/exchange/exchange-ps/exchange/Set-ExchangeFeature.md new file mode 100644 index 0000000000..f023153538 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ExchangeFeature.md @@ -0,0 +1,176 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangefeature +applicable: Exchange Server 2019 +title: Set-ExchangeFeature +schema: 2.0.0 +author: lusassl-msft +ms.author: lusassl +ms.reviewer: srvar +--- + +# Set-ExchangeFeature + +## SYNOPSIS +This cmdlet is available only in on-premises Exchange. + +Use the Set-ExchangeFeature cmdlet to approve or block features flighted via Feature Flighting on Exchange Server. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ExchangeFeature [-Identity] + [-Approve] + [-Block] + [-Confirm] + [-FeatureID ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The Set-ExchangeFeature cmdlet lets you approve or block features flighted via Feature Flighting, a service introduced in the Exchange Server 2019 CU15 (2025H1) update. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ExchangeFeature -Identity ex01.contoso.com -FeatureID @("F1.1.1") -Approve +``` + +This example approves the feature F1.1.1 on the computer named ex01.contoso.com. + +### Example 2 +```powershell +Set-ExchangeFeature -Identity ex01.contoso.com -FeatureID @("F1.1.1", "F1.2.1", "F2.1.1") -Approve +``` + +This example approves the features F1.1.1, F1.2.1, and F2.1.1 on the computer named ex01.contoso.com. + +### Example 3 +```powershell +Set-ExchangeFeature -Identity ex01.contoso.com -FeatureID @("F1.1.1", "F1.2.1", "F2.1.1") -Block +``` + +This example blocks the features F1.1.1, F1.2.1, and F2.1.1 on the computer named ex01.contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Exchange server that you want to modify. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Approve +The Approve switch approves the feature specified by the FeatureID parameter. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Block +The Block switch blocks the feature specified by the FeatureID parameter. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FeatureID +The FeatureID parameter specifies the feature you want to control. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019 + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ExchangeServer.md b/exchange/exchange-ps/exchange/Set-ExchangeServer.md index 6c95c9fbe6..b010016da0 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeServer.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-exchangeserver +online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangeserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ExchangeServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ExchangeServer cmdlet to set Exchange attributes in Active Directory for a specified server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,12 +24,17 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-ExchangeServer [-Identity] [-Confirm] [-CustomerFeedbackEnabled ] + [-DataCollectionEnabled ] [-DomainController ] [-ErrorReportingEnabled ] [-InternetWebProxy ] [-InternetWebProxyBypassList ] + [-MitigationsApplied ] + [-MitigationsBlocked ] + [-MitigationsEnabled ] [-MonitoringGroup ] [-ProductKey ] + [-RingLevel ] [-StaticConfigDomainController ] [-StaticDomainControllers ] [-StaticExcludedDomainControllers ] @@ -41,7 +46,7 @@ Set-ExchangeServer [-Identity] ## DESCRIPTION The Set-ExchangeServer cmdlet sets generic Exchange attributes in Active Directory for a specified computer. You can only use this task on one server at a time. If you want to bulk manage your servers running Microsoft Exchange, add this task to a script. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,6 +129,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DataCollectionEnabled +The DataCollectionEnabled parameter specifies whether the EM Service will collect and send diagnostic data to Microsoft using OCS. Valid values are: + +- $true: The EM Service collects and sends diagnostic data to Microsoft using OCS. +- $false: Data collection is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -196,6 +220,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MitigationsApplied +Do not use this parameter. The EM service uses this parameter to store and track mitigation status. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MitigationsBlocked +The MitigationsBlocked parameter specifies a list of mitigations that are blocked. The Mitigation IDs present in this list are not applied by EM service in its hourly run. + +To enter multiple values and overwrite any existing Mitigation entries, use the following syntax: `@("Entry1","Entry2",..."EntryN")`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MitigationsEnabled +The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitigation service (EM service) automatically applies mitigations on the Exchange server. Valid values are: + +- $true: The EM Service automatically applies mitigations on the Exchange server. +- $false: Mitigations are not automatically applied on the Exchange server. + +For more information, see [Exchange Emergency Mitigation (EM) service](https://learn.microsoft.com/exchange/exchange-emergency-mitigation-service). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MonitoringGroup The MonitoringGroup parameter specifies how to add your Exchange servers to monitoring groups. You can add your servers to an existing group or create a monitoring group based on location or deployment, or to partition monitoring responsibility among your servers. @@ -228,6 +307,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RingLevel +The RingLevel parameter specifies the server ring level that's used by the Feature Flighting feature. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StaticConfigDomainController The StaticConfigDomainController parameter specifies whether to configure a domain controller to be used by the server via Directory Service Access (DSAccess). @@ -313,12 +408,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md index d72aea17f7..436392e2c0 100644 --- a/exchange/exchange-ps/exchange/Set-ExchangeSettings.md +++ b/exchange/exchange-ps/exchange/Set-ExchangeSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-exchangesettings +online version: https://learn.microsoft.com/powershell/module/exchange/set-exchangesettings applicable: Exchange Server 2016, Exchange Server 2019 title: Set-ExchangeSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ExchangeSettings cmdlet to configure Exchange setting objects that you created with the New-ExchangeSettings cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -183,7 +183,7 @@ Set-ExchangeSettings [-Identity] -Reason ### EnableSettingsGroup ``` Set-ExchangeSettings [-Identity] -Reason - [-EnableGroup + [-EnableGroup ] [-DisableGroup ] [-Confirm] [-DomainController ] @@ -193,7 +193,7 @@ Set-ExchangeSettings [-Identity] -Reason ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -328,7 +328,7 @@ Accept wildcard characters: False ### -ExpirationDate The ExpirationDate parameter specifies the end date/time of the Exchange settings that are defined by the specified Exchange settings group. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". You can only use the ExpirationDate parameter with the CreateSettingsGroup or UpdateSettings group parameters. @@ -490,6 +490,8 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -508,7 +510,7 @@ The Disable switch specifies that the Exchange settings group is disabled. You d You can only use this switch with the CreateSettingsGroup switch. -To use this switch to enable an Exchange settings group, use the syntax -Disable:$false. +To use this switch to enable an Exchange settings group, use this exact syntax `-Disable:$false`. ```yaml Type: SwitchParameter @@ -576,7 +578,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -748,16 +752,16 @@ Accept wildcard characters: False ``` ### -ScopeFilter -The ScopeFilter parameter uses OPath filter syntax to specify the scope of an Exchange settings group based. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"ServerRole -like 'Mailbox*'"`). +The ScopeFilter parameter uses OPATH filter syntax to specify the scope of an Exchange settings group based. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"ServerRole -like 'Mailbox*'"`). -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter with the Scope parameter and the value Forest or other scope-related parameters. @@ -797,12 +801,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md new file mode 100644 index 0000000000..2b5d969329 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ExoPhishSimOverrideRule.md @@ -0,0 +1,240 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-exophishsimoverriderule +applicable: Exchange Online +title: Set-ExoPhishSimOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ExoPhishSimOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ExoPhishSimOverrideRule cmdlet to modify third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ExoPhishSimOverrideRule [-Identity] + [-AddDomains ] + [-AddSenderIpRanges ] + [-Comment ] + [-Confirm] + [-DomainController ] + [-RemoveDomains ] + [-RemoveSenderIpRanges ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoPhishSimOverrideRule | Set-ExoPhishSimOverrideRule -AddDomains blueyonderairlines.com -RemoveSenderIpRanges 192.168.1.55 +``` + +This example modifies the (presumably only) phishing simulation override rule with the specified settings. + +This example modifies the phishing simulation override rule with the specified settings. + +### Example 2 +```powershell +Set-ExoPhishSimOverrideRule -Identity "_Exe:PhishSimOverr:6fed4b63-3563-495d-a481-b24a311f8329" -AddDomains blueyonderairlines.com -RemoveSenderIpRanges 192.168.1.55 +``` + +This example modifies the specified phishing simulation override rule with the specified settings. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the phishing simulation override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-ExoPhishSimOverrideRule cmdlet to find the values. The name of the rule uses the following syntax: `_Exe:PhishSimOverr:` \[sic\] where \ is a unique GUID value (for example, 6fed4b63-3563-495d-a481-b24a311f8329). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AddDomains +The AddDomains parameter specifies an existing entry to add to the list of email domains that are used by the third-party phishing simulation. + +You can specify multiple values separated by commas. A maximum of 20 entries are allowed in the list. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AddSenderIpRanges +The AddSenderIpRanges parameter specifies an existing entry to add to the list of source IP addresses that are used by the third-party phishing simulation. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +A maximum of 10 entries are allowed in the list. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveDomains +The RemoveDomains parameter specifies an existing entry to remove from the list of email domains that are used by the third-party phishing simulation. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveSenderIpRanges +The RemoveSenderIpRanges parameter specifies an existing entry to remove from the list of source IP addresses that are used by the third-party phishing simulation. Valid values are: + +- Single IP address: For example, 192.168.1.1. +- IP address range: For example, 192.168.0.1-192.168.0.254. +- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. + +You can specify multiple values separated by commas. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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](http://go.microsoft.com/fwlink/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md new file mode 100644 index 0000000000..b20f1787e3 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ExoSecOpsOverrideRule.md @@ -0,0 +1,154 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/get-exosecopsoverriderule +applicable: Exchange Online +title: set-ExoSecOpsOverrideRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ExoSecOpsOverrideRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ExoSecOpsOverrideRule cmdlet to modify SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +**Tip**: This cmdlet doesn't modify email addresses in the SecOps override rule. To modify the email addresses in the SecOps override rule, use the Set-SecOpsOverridePolicy cmdlet. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ExoSecOpsOverrideRule [-Identity] + [-Comment ] + [-Confirm] + [-DomainController ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Get-ExoSecOpsOverrideRule| Set-ExoSecOpsOverrideRule -Comment "Contact IT Management before modifying or removing this rule." +``` + +This example adds a comment to the (presumably only) SecOps mailbox override rule with the specified settings. + +### Example 2 +```powershell +Set-ExoSecOpsOverrideRule -Identity "_Exe:SecOpsOverrid:312c23cf-0377-4162-b93d-6548a9977efb" -Comment "Contact IT Management before modifying or removing this rule." +``` + +This example adds a comment to the specified SecOps mailbox override rule. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the SecOps override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: + +- Name +- Id +- Distinguished name (DN) +- GUID + +Use the Get-ExoSecOpsMailboxRule cmdlet to find these values. The name of the rule uses the following syntax: `_Exe:SecOpsOverrid:` \[sic\] where \ is a unique GUID value (for example, 312c23cf-0377-4162-b93d-6548a9977efb). + +```yaml +Type: ComplianceRuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md b/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md index 22cb295c49..83221e105b 100644 --- a/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md +++ b/exchange/exchange-ps/exchange/Set-ExternalInOutlook.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-externalinoutlook +online version: https://learn.microsoft.com/powershell/module/exchange/set-externalinoutlook applicable: Exchange Online, Exchange Online Protection title: Set-ExternalInOutlook schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-ExternalInOutlook cmdlet to modify the configuration of external sender identification that's available in Outlook, Outlook for Mac, Outlook on the web, and Outlook for iOS and Android. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +30,7 @@ Set-ExternalInOutlook [[-Identity] ] ## DESCRIPTION If your organization already uses mail flow rules (also known as transport rules) to add text to the subject line of messages from external senders, you should disable those rules before you enable this feature to avoid duplication. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,7 +58,11 @@ This example adds and removes the specified email addresses from the exception l ## PARAMETERS ### -Identity -The Identity parameter specifies the GUID of the external sender identification object that you want to modify. Although this parameter is available, you don't need to use it. +The Identity parameter specifies the GUID of the external sender identification object that you want to modify. + +This parameter is optional and typically isn't needed, because the organization's GUID resolves automatically when you use this cmdlet. + +If you specify an invalid Identity value, the cmdlet still runs and changes the settings for the entire organization. Always verify the Identity value before you run this cmdlet. ```yaml Type: OrganizationIdParameter @@ -127,12 +129,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS + +[Set-OrganizationConfig](https://learn.microsoft.com/powershell/module/exchange/set-organizationconfig) diff --git a/exchange/exchange-ps/exchange/Set-FeatureConfiguration.md b/exchange/exchange-ps/exchange/Set-FeatureConfiguration.md new file mode 100644 index 0000000000..775dd3b86a --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-FeatureConfiguration.md @@ -0,0 +1,195 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-featureconfiguration +applicable: Security & Compliance +title: Set-FeatureConfiguration +schema: 2.0.0 +--- + +# Set-FeatureConfiguration + +## SYNOPSIS +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). + +> [!NOTE] +> This cmdlet is currently available in Public Preview, isn't available in all organizations, and is subject to change. + +Use the Set-FeatureConfiguration cmdlet to modify Microsoft Purview feature configurations within your organization, including: + +- Collection policies. +- Advanced label based protection. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-FeatureConfiguration [-Identity] [-Locations ] + [-Comment ] + [-Confirm] + [-Mode ] + [-ScenarioConfig ] + [-WhatIf] + [] +``` + +## DESCRIPTION +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). + +## EXAMPLES + +### Example 1 +```powershell +Set-FeatureConfiguration "DSPM for AI - Capture interactions for Copilot experiences" -ScenarioConfig '{"Activities":["UploadText","DownloadText"],"EnforcementPlanes":["CopilotExperiences"],"SensitiveTypeIds":["All"],"IsIngestionEnabled":false}' +``` + +This example updates a collection policy named "DSPM for AI - Capture interactions for Copilot experiences" to disable content capture. + +### Example 2 +```powershell +Set-FeatureConfiguration "Microsoft Copilot collection policy for Contoso Sales" -Locations '[{"Workload":"Applications","Location":"52655","AddInclusions":[{"Type":"Group","Identity":"USSales@contoso.com"}]}]' +``` + +This example updates a collection policy named "Microsoft Copilot collection policy for Contoso Sales" to include the USSales@contoso.com group. + +### Example 3 +```powershell +Set-FeatureConfiguration "Microsoft Copilot collection policy for Contoso Sales" -Locations '[{"Workload":"Applications","Location":"52655","AddExclusions":[{"Type":"IndividualResource","Identity":"adele@contoso.com"}]}]' +``` + +This example updates a collection policy named "Microsoft Copilot collection policy for Contoso Sales" to exclude the adele@contoso.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the feature configuration that you want to modify. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: PolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comment +The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Locations +The locations parameter specifies where the feature configuration applies. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The Mode parameter specifies feature configuration mode. Valid values are: + +- Enable: The feature configuration is enabled. +- Disable: The feature configuration is disabled. + +```yaml +Type: PolicyMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ScenarioConfig +The ScenarioConfig parameter specifies additional information about the feature configuration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Security & Compliance + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md b/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md index c94f0293af..92e99bb1fe 100644 --- a/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md +++ b/exchange/exchange-ps/exchange/Set-FederatedOrganizationIdentifier.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-federatedorganizationidentifier +online version: https://learn.microsoft.com/powershell/module/exchange/set-federatedorganizationidentifier applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-FederatedOrganizationIdentifier schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-FederatedOrganizationIdentifier cmdlet to configure the federated organization identifier for the Exchange organization. -For more details, see [Federation](https://docs.microsoft.com/exchange/federation-exchange-2013-help). +For more details, see [Federation](https://learn.microsoft.com/exchange/federation-exchange-2013-help). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ You must configure a federated organization identifier to create an account name You can temporarily disable federation by disabling the organization identifier. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -223,12 +223,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-FederationTrust.md b/exchange/exchange-ps/exchange/Set-FederationTrust.md index cd84748a17..5a6e6a3d8a 100644 --- a/exchange/exchange-ps/exchange/Set-FederationTrust.md +++ b/exchange/exchange-ps/exchange/Set-FederationTrust.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-federationtrust +online version: https://learn.microsoft.com/powershell/module/exchange/set-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-FederationTrust schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-FederationTrust cmdlet to modify an existing federation trust. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -58,7 +58,7 @@ Set-FederationTrust [-Identity] ## DESCRIPTION You can use the Set-FederationTrust cmdlet to manage the certificates used for the federation trust. You can also use the Set-FederationTrust cmdlet to refresh the metadata document from the Microsoft Federation Gateway and download its certificate. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,7 +90,7 @@ Before you configure a federation trust to use the next certificate as the curre ### -Identity The Identity parameter specifies the name of the federation trust being modified. -**Note**: For Exchange Online organizations, use the value "Azure AD Authentication". +**Note**: For Exchange Online organizations, use the value "Microsoft Entra authentication". ```yaml Type: FederationTrustIdParameter @@ -209,7 +209,7 @@ Accept wildcard characters: False ``` ### -RefreshMetadata -The RefreshMetadata switch specifies that the metadata document and certificate is retrieved again from the Microsoft Federation Gateway. +The RefreshMetadata switch specifies that the metadata document and certificate is retrieved again from the Microsoft Federation Gateway. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -261,12 +261,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md index 93c70da5ae..2c6319179c 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyAuthority.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertyauthority -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertyauthority +applicable: Security & Compliance title: Set-FilePlanPropertyAuthority schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Set-FilePlanPropertyAuthority ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-FilePlanPropertyAuthority cmdlet to modify file plan property authorities. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,7 @@ Set-FilePlanPropertyAuthority [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -49,7 +49,7 @@ The Identity parameter specifies the custom file plan property authority that yo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -68,7 +68,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -84,7 +84,7 @@ The DisplayName parameter specifies the display name of the file plan property a Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -94,13 +94,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -114,12 +114,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md index bbe22170cf..c997f07927 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertycategory -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycategory +applicable: Security & Compliance title: Set-FilePlanPropertyCategory schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Set-FilePlanPropertyCategory ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-FilePlanPropertyCategory cmdlet to modify file plan property categories. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -23,7 +23,7 @@ Set-FilePlanPropertyCategory [-Identity] [-Confirm] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -47,7 +47,7 @@ The Identity parameter specifies the custom file plan property category that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -66,7 +66,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -82,7 +82,7 @@ The DisplayName parameter specifies the display name of the file plan property c Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -92,13 +92,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -112,12 +112,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md index 2b694bbccc..78ebda0733 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyCitation.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertycitation +applicable: Security & Compliance title: Set-FilePlanPropertyCitation schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Set-FilePlanPropertyCitation ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-FilePlanPropertyCitation cmdlet to modify file plan property citations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Set-FilePlanPropertyCitation [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -52,7 +52,7 @@ The Identity parameter specifies the custom file plan property citation that you Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -68,7 +68,7 @@ The CitationJurisdiction parameter specifies the jurisdiction for the file plan Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -84,7 +84,7 @@ The CitationJurisdiction parameter specifies the URL for the file plan property Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -103,7 +103,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -119,7 +119,7 @@ The DisplayName parameter specifies the display name of the file plan property c Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -129,13 +129,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -149,12 +149,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md index bfba7cf4fb..40d312c5a8 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyDepartment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertydepartment -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertydepartment +applicable: Security & Compliance title: Set-FilePlanPropertyDepartment schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Set-FilePlanPropertyDepartment ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-FilePlanPropertyDepartment cmdlet to modify file plan property departments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,11 +26,11 @@ Set-FilePlanPropertyDepartment [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). Use the Set-FilePlanPropertyDepartment cmdlet to -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## EXAMPLES @@ -54,7 +54,7 @@ The Identity parameter specifies the custom file plan property department that y Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -73,7 +73,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -89,7 +89,7 @@ The DisplayName parameter specifies the display name of the file plan property d Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -99,13 +99,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -119,12 +119,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md index fa6bba9ce1..0be4986969 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertyReferenceId.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertyreferenceid -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertyreferenceid +applicable: Security & Compliance title: Set-FilePlanPropertyReferenceId schema: 2.0.0 --- @@ -9,15 +9,11 @@ schema: 2.0.0 # Set-FilePlanPropertyReferenceId ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-FilePlanPropertyReferenceId cmdlet to modify file plan property reference IDs. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - - -Use the Set -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +26,7 @@ Set-FilePlanPropertyReferenceId [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -54,7 +50,7 @@ The Identity parameter specifies the custom file plan property reference ID that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -73,7 +69,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -89,7 +85,7 @@ The DisplayName parameter specifies the display name of the file plan property r Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -99,13 +95,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -119,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md b/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md index 60298b6ecf..384fa72ff4 100644 --- a/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md +++ b/exchange/exchange-ps/exchange/Set-FilePlanPropertySubCategory.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-fileplanpropertysubcategory -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-fileplanpropertysubcategory +applicable: Security & Compliance title: Set-FilePlanPropertySubCategory schema: 2.0.0 --- @@ -9,11 +9,11 @@ schema: 2.0.0 # Set-FilePlanPropertySubCategory ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-FilePlanPropertySubCategory cmdlet to modify file plan property subcategories. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,7 +26,7 @@ Set-FilePlanPropertySubCategory [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance Center](https://go.microsoft.com/fwlink/p/?LinkId=511920). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in Security & Compliance](https://go.microsoft.com/fwlink/p/?LinkId=511920). ## EXAMPLES @@ -50,7 +50,7 @@ The Identity parameter specifies the custom file plan property subcategory that Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -69,7 +69,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -85,7 +85,7 @@ The DisplayName parameter specifies the display name of the file plan property s Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -95,13 +95,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -115,12 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-FocusedInbox.md b/exchange/exchange-ps/exchange/Set-FocusedInbox.md index 229173e172..daebaa21e2 100644 --- a/exchange/exchange-ps/exchange/Set-FocusedInbox.md +++ b/exchange/exchange-ps/exchange/Set-FocusedInbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.Management-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-focusedinbox +online version: https://learn.microsoft.com/powershell/module/exchange/set-focusedinbox applicable: Exchange Online, Exchange Online Protection title: Set-FocusedInbox schema: 2.0.0 @@ -16,22 +16,21 @@ This cmdlet is available only in the cloud-based service. Use the Set-FocusedInbox cmdlet to enable or disable Focused Inbox for mailboxes in your organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-FocusedInbox -Identity [-FocusedInboxOn ] + [-UseCustomRouting] [] ``` ## DESCRIPTION Focused Inbox is a replacement for Clutter that separates the Inbox into the Focused and Other tabs in Outlook on the web and newer versions of Outlook. Important emails are on the Focused tab while the rest are on the Other tab. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,17 +89,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ForeignConnector.md b/exchange/exchange-ps/exchange/Set-ForeignConnector.md index ba6414cf97..8ce9583a9c 100644 --- a/exchange/exchange-ps/exchange/Set-ForeignConnector.md +++ b/exchange/exchange-ps/exchange/Set-ForeignConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-foreignconnector +online version: https://learn.microsoft.com/powershell/module/exchange/set-foreignconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ForeignConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ForeignConnector cmdlet to modify an existing Foreign connector in the Transport service of a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +42,7 @@ Set-ForeignConnector [-Identity] ## DESCRIPTION A Foreign connector uses a Drop directory in the Transport service of a Mailbox server to send messages to a local messaging server that doesn't use SMTP as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Third-party fax gateway servers are examples of foreign gateway servers. The address spaces assigned to a Foreign connector can be SMTP or non-SMTP. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -235,7 +235,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -367,12 +369,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-FrontendTransportService.md b/exchange/exchange-ps/exchange/Set-FrontendTransportService.md index 35d0fac797..1332c4a436 100644 --- a/exchange/exchange-ps/exchange/Set-FrontendTransportService.md +++ b/exchange/exchange-ps/exchange/Set-FrontendTransportService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-frontendtransportservice +online version: https://learn.microsoft.com/powershell/module/exchange/set-frontendtransportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-FrontendTransportService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Get-FrontEndTransportService cmdlet to modify the configuration of the Front End Transport service on Exchange 2013 or later servers that have the Client Access server role installed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -71,7 +71,7 @@ Set-FrontendTransportService [-Identity] ## DESCRIPTION The Front End Transport service runs on all Mailbox servers and acts as a stateless proxy for all inbound and outbound external SMTP traffic for the Exchange organization. The Front End Transport service only communicates with the Transport service on a Mailbox server, and doesn't queue any messages locally. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -1005,12 +1005,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md b/exchange/exchange-ps/exchange/Set-GlobalAddressList.md index f3b140c04a..b4bbb3747e 100644 --- a/exchange/exchange-ps/exchange/Set-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/Set-GlobalAddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-globaladdresslist +online version: https://learn.microsoft.com/powershell/module/exchange/set-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-GlobalAddressList schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-GlobalAddressList cmdlet to modify an existing global address list (GAL). -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -60,11 +60,11 @@ The Conditional parameters that are used with the IncludedRecipients parameter a - The OR operator is always used for multiple values of the same property, as in "Department equals Sales OR Marketing". - The AND operator is always used for multiple properties, as in "Department equals Sales AND Company equals Contoso". -To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPath filter. +To create flexible filters that use any available recipient property and that aren't subject to these limitations, you can use the RecipientFilter parameter to create a custom OPATH filter. -You can't use this cmdlet to replace a precanned filter with a custom OPath filter, or vice-versa. You can only modify the existing filter. +You can't use this cmdlet to replace a precanned filter with a custom OPATH filter, or vice-versa. You can only modify the existing filter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -533,7 +533,7 @@ Accept wildcard characters: False ### -ForceUpgrade This parameter is available only in on-premises Exchange. -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -615,16 +615,16 @@ Accept wildcard characters: False ``` ### -RecipientFilter -The RecipientFilter parameter specifies an OPath filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The RecipientFilter parameter specifies an OPATH filter that's based on the value of any available recipient property. You can use any available Windows PowerShell operator, and wildcards and partial matches are supported. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For filterable properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to filter on. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). - In cloud-based environments, you can't use a wildcard as the first character. For example, `'Sales*'` is allowed, but `'*Sales'` isn't allowed. - In on-premises Exchange, wildcards are valid only as the first or last character. For example, `'Sales*'` or `'*Sales'` are allowed, but `'Sa*les'` isn't allowed. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). ```yaml Type: String @@ -660,12 +660,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-Group.md b/exchange/exchange-ps/exchange/Set-Group.md index 3f4ad401cb..25c66b6124 100644 --- a/exchange/exchange-ps/exchange/Set-Group.md +++ b/exchange/exchange-ps/exchange/Set-Group.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-group +online version: https://learn.microsoft.com/powershell/module/exchange/set-group applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-Group schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-Group cmdlet to modify group object settings. If the group is a mail-enabled security group or a distribution group, you can use the Set-DistributionGroup cmdlet to modify other Microsoft Exchange settings that aren't available by using the Set-Group cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-Group [-Identity] [-BypassSecurityGroupManagerCheck] [-Confirm] + [-Description ] [-DisplayName ] [-DomainController ] [-IgnoreDefaultScope] @@ -43,7 +44,7 @@ Set-Group [-Identity] ## DESCRIPTION You can't use the Set-Group cmdlet to modify dynamic distribution groups. To modify dynamic distribution groups, use the Set-DynamicDistributionGroup cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -89,13 +90,13 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -128,6 +129,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Description +This parameter is available only in the cloud-based service. + +{{ Fill Description Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName The DisplayName parameter specifies the display name of the group. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -169,9 +188,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -231,7 +250,9 @@ To enter multiple owners and overwrite all existing entries, use the following s To add or remove owners without affecting other existing entries, use the following syntax: `@{Add="Owner1","Owner2",...; Remove="Owner3","Owner4"...}`. -An owner that you specify with this parameter isn't automatically a member of the group. You need to manually add the owner as a member. +Owners that you specify with this parameter are not added as group members. You need to manually add the owners as a members. + +**Note**: Group management in Outlook doesn't work when the owner is a mail-enabled security group. To manage the group in Outlook, the owner must be a mailbox or a mail user. ```yaml Type: GeneralRecipientIdParameter[] @@ -392,12 +413,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md index ae2549f736..d1f0720b66 100644 --- a/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md +++ b/exchange/exchange-ps/exchange/Set-HoldCompliancePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-holdcompliancepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-holdcompliancepolicy +applicable: Security & Compliance title: Set-HoldCompliancePolicy schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Set-HoldCompliancePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-HoldCompliancePolicy cmdlet to modify existing preservation policies in the Microsoft 365 compliance center. +Use the Set-HoldCompliancePolicy cmdlet to modify existing preservation policies in the Microsoft Purview compliance portal. **Note**: The Set-HoldCompliancePolicy cmdlet has been replaced by the Set-RetentionCompliancePolicy cmdlet. If you have scripts that use Set-HoldCompliancePolicy, update them to use Set-RetentionCompliancePolicy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -49,7 +49,9 @@ Set-HoldCompliancePolicy [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}`. ## EXAMPLES @@ -61,7 +63,7 @@ Set-HoldCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchangeLocat This example makes the following changes to the existing preservation policy named "Regulation 123 Compliance": - Adds the mailbox for the user named Kitty Petersen. -- Adds the SharePoint Online site `https://contoso.sharepoint.com/sites/teams/finance`. +- Adds the SharePoint site `https://contoso.sharepoint.com/sites/teams/finance`. - Removes public folders. - Updates the comment. @@ -78,7 +80,7 @@ The Identity parameter specifies the preservation policy that you want to modify Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -88,7 +90,7 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -98,7 +100,7 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -126,7 +128,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -142,7 +144,7 @@ The AddPublicFolderLocation parameter specifies that you want to add all public Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -152,17 +154,17 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. +SharePoint sites can't be added to the policy until they have been indexed. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -178,7 +180,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -197,7 +199,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -216,7 +218,7 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -226,13 +228,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -260,7 +264,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -276,7 +280,7 @@ The RemovePublicFolderLocation parameter specifies that you want to remove all p Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -286,7 +290,7 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -294,7 +298,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -304,13 +308,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -324,12 +328,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md index 2adbac6cbd..e86f4d51b9 100644 --- a/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-HoldComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-holdcompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-holdcompliancerule +applicable: Security & Compliance title: Set-HoldComplianceRule schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Set-HoldComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-HoldComplianceRule cmdlet to modify existing preservation rules in the Microsoft 365 compliance center. +Use the Set-HoldComplianceRule cmdlet to modify existing preservation rules in the Microsoft Purview compliance portal. **Note**: The Set-HoldComplianceRule cmdlet has been replaced by the Set-RetentionComplianceRule cmdlet. If you have scripts that use Set-HoldComplianceRule, update them to use Set-RetentionComplianceRule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Set-HoldComplianceRule [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,7 +61,7 @@ The Identity parameter specifies the preservation rule that you want to modify. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -77,7 +77,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -96,7 +96,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -108,13 +108,13 @@ Accept wildcard characters: False ### -ContentDateFrom The ContentDateFrom parameter specifies the start date of the date range for content to include. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -126,13 +126,13 @@ Accept wildcard characters: False ### -ContentDateTo The ContentDateTo parameter specifies the end date of the date range for content to include. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -144,13 +144,13 @@ Accept wildcard characters: False ### -ContentMatchQuery The ContentMatchQuery parameter specifies a content search filter. -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -166,7 +166,7 @@ The Disabled parameter specifies whether the preservation rule is enabled or dis Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -185,7 +185,7 @@ The HoldContent parameter specifies the hold duration for the preservation rule. Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -195,19 +195,19 @@ Accept wildcard characters: False ``` ### -HoldDurationDisplayHint -The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Microsoft 365 compliance center. Valid values are Days, Months or Years. +The HoldDurationDisplayHint parameter specifies the units that are used to display the preservation duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days - Months - Years -For example, if this parameter is set to the value Years, and the HoldContent parameter is set to the value 365, the Microsoft 365 compliance center will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the HoldContent parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. ```yaml Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -217,13 +217,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -237,12 +237,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md index dfeac48f08..83888c656c 100644 --- a/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedConnectionFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-hostedconnectionfilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedconnectionfilterpolicy applicable: Exchange Online, Exchange Online Protection title: Set-HostedConnectionFilterPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-HostedConnectionFilterPolicy cmdlet to modify the settings of connection filter policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +34,7 @@ Set-HostedConnectionFilterPolicy [-Identity] [-AllowedSenders ] [-BlockedSenderDomains ] [-BlockedSenders ] + [-BulkQuarantineTag ] [-BulkSpamAction ] [-BulkThreshold ] [-Confirm] @@ -44,12 +43,15 @@ Set-HostedContentFilterPolicy [-Identity] [-EndUserSpamNotificationLanguage ] [-EndUserSpamNotificationLimit ] [-HighConfidencePhishAction ] + [-HighConfidencePhishQuarantineTag ] [-HighConfidenceSpamAction ] + [-HighConfidenceSpamQuarantineTag ] [-IncreaseScoreWithBizOrInfoUrls ] [-IncreaseScoreWithImageLinks ] [-IncreaseScoreWithNumericIps ] [-IncreaseScoreWithRedirectToOtherPort ] [-InlineSafetyTipsEnabled ] + [-IntraOrgFilterState ] [-LanguageBlockList ] [-MakeDefault] [-MarkAsSpamBulkMail ] @@ -65,12 +67,14 @@ Set-HostedContentFilterPolicy [-Identity] [-MarkAsSpamSpfRecordHardFail ] [-MarkAsSpamWebBugsInHtml ] [-ModifySubjectValue ] + [-PhishQuarantineTag ] [-PhishSpamAction ] - [-PhishZapEnabled + [-PhishZapEnabled ] [-QuarantineRetentionPeriod ] [-RedirectToRecipients ] [-RegionBlockList ] [-SpamAction ] + [-SpamQuarantineTag ] [-SpamZapEnabled ] [-TestModeAction ] [-TestModeBccToRecipients ] @@ -79,9 +83,9 @@ Set-HostedContentFilterPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -For more information about the limits for allowed and blocked senders, see [Exchange Online Protection Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). +For more information about the limits for allowed and blocked senders, see [Exchange Online Protection Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-protection-service-description/exchange-online-protection-limits). ## EXAMPLES @@ -165,7 +169,7 @@ Accept wildcard characters: False ### -AllowedSenderDomains The AllowedSenderDomains parameter specifies trusted domains that aren't processed by the spam filter. Messages from senders in these domains are stamped with `SFV:SKA` in the `X-Forefront-Antispam-Report header` and receive a spam confidence level (SCL) of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP domains. -**Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). +**Caution**: Think very carefully before you add domains here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -187,7 +191,7 @@ Accept wildcard characters: False ### -AllowedSenders The AllowedSenders parameter specifies a list of trusted senders that skip spam filtering. Messages from these senders are stamped with SFV:SKA in the X-Forefront-Antispam-Report header and receive an SCL of -1, so the messages are delivered to the recipient's inbox. Valid values are one or more SMTP email addresses. -**Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-safe-sender-lists-in-office-365). +**Caution**: Think very carefully before you add senders here. For more information, see [Create safe sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -207,9 +211,9 @@ Accept wildcard characters: False ``` ### -BlockedSenderDomains -The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with `SFV:SKB` value in the `X-Forefront-Antispam-Report` header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP domains. +The BlockedSenderDomains parameter specifies domains that are always marked as spam sources. Messages from senders in these domains are stamped with `SFV:SKB` value in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP domains. -**Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). +**Note**: Manually blocking domains isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -229,9 +233,9 @@ Accept wildcard characters: False ``` ### -BlockedSenders -The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with `SFV:SKB` in the `X-Forefront-Antispam-Report` header and receive an SCL of 9 (high confidence spam). Valid values are one or more SMTP email addresses. +The BlockedSenders parameter specifies senders that are always marked as spam sources. Messages from these senders are stamped with `SFV:SKB` in the `X-Forefront-Antispam-Report` header and receive an SCL of 6 (spam). Valid values are one or more SMTP email addresses. -**Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/create-block-sender-lists-in-office-365?). +**Note**: Manually blocking senders isn't dangerous, but it can increase your administrative workload. For more information, see [Create block sender lists in EOP](https://learn.microsoft.com/defender-office-365/create-block-sender-lists-in-office-365). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -250,15 +254,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BulkQuarantineTag +The BulkQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as bulk email (the BulkSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as bulk as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BulkSpamAction The BulkSpamAction parameter specifies the action to take on messages that are marked as bulk email (also known as gray mail) based on the bulk complaint level (BCL) of the message, and the BCL threshold you configure in the BulkThreshold parameter. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). +- MoveToJmf: This is the default value. Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). - NoAction -- Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as bulk email are available to the intended recipients and admins. Or, you can use the BulkQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. ```yaml @@ -275,9 +305,9 @@ Accept wildcard characters: False ``` ### -BulkThreshold -The BulkThreshold parameter specifies the BCL on messages that triggers the action specified by the BulkSpamAction parameter (greater than the specified BCL value, not greater than or equal to). A valid value is an integer from 1 to 9. The default value is 7, which means a BCL of 8 or 9 on messages will trigger the action that's specified by the BulkSpamAction parameter. +The BulkThreshold parameter specifies the BCL on messages that triggers the action specified by the BulkSpamAction parameter (greater than or equal to the specified BCL value). A valid value is an integer from 1 to 9. The default value is 7, which means a BCL of 7, 8, or 9 on messages will trigger the action that's specified by the BulkSpamAction parameter. -A higher BCL indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see [Bulk complaint level (BCL) in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/bulk-complaint-level-values). +A higher BCL indicates the message is more likely to generate complaints (and is therefore more likely to be spam). For more information, see [Bulk complaint level (BCL) in EOP](https://learn.microsoft.com/defender-office-365/anti-spam-bulk-complaint-level-bcl-about). ```yaml Type: Int32 @@ -312,12 +342,7 @@ Accept wildcard characters: False ``` ### -DownloadLink -The DownloadLink parameter shows or hides a link in end-user spam quarantine notifications to download the Junk Email Reporting Tool for Outlook. Valid values are: - -- $true: end-user spam quarantine notifications contain a link to download the Junk Email Reporting Tool for Outlook. -- $false: end-user spam quarantine notifications don't contain the link. This is the default value. - -This parameter is only meaningful only when the EnableEndUserSpamNotifications parameter value is $true. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean @@ -333,10 +358,7 @@ Accept wildcard characters: False ``` ### -EnableEndUserSpamNotifications -The EnableEndUserSpamNotification parameter enables for disables sending end-user spam quarantine notifications. Valid values are: - -- $true: End-users periodically receive notifications when a messages that was supposed to be delivered to them was quarantined as spam. When you use this value, you can also use the EndUserSpamNotificationCustomSubject, EndUserSpamNotificationFrequency, and EndUserSpamNotificationLanguage parameters. -- $false: end-user spam quarantine notifications are disabled. This is the default value. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Boolean @@ -390,7 +412,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromAddress -This parameter has been deprecated and is no longer used. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: SmtpAddress @@ -406,7 +428,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomFromName -This parameter has been deprecated and is no longer used. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String @@ -422,9 +444,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationCustomSubject -The EndUserSpamNotificationCustomSubject parameter specifies a custom subject for end-user spam notification messages. If the value includes spaces, enclose the value in quotation marks ("). - -This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: String @@ -440,10 +460,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationFrequency -The EndUserSpamNotificationFrequency parameter specifies the repeat interval in days that end-user spam quarantine notifications are sent. A valid value is an integer between 1 and 15. The default value is 3. - -This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. - +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: Int32 Parameter Sets: (All) @@ -458,13 +475,7 @@ Accept wildcard characters: False ``` ### -EndUserSpamNotificationLanguage -The EndUserSpamNotificationLanguage parameter specifies the language of end-user spam quarantine notifications. Valid values are: - -Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. - -The default value is Default, which means English. - -This parameter is meaningful only when the EnableEndUserSpamNotifications parameter value is $true. +This parameter has been deprecated and is no longer used. End-user quarantine notifications are controlled by quarantine policies as specified by the \*QuarantineTag parameters. ```yaml Type: EsnLanguage @@ -498,9 +509,8 @@ Accept wildcard characters: False ### -HighConfidencePhishAction The HighConfidencePhishAction parameter specifies the action to take on messages that are marked as high confidence phishing (not phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. -- Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is only available to admins. +- Quarantine: Move the message to quarantine. By default, messages that are quarantined as high confidence phishing are available only to admins. Or, you can use the HighConfidencePhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. ```yaml Type: PhishFilteringAction @@ -515,14 +525,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HighConfidencePhishQuarantineTag +The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence phishing (the HighConfidencePhishAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named AdminOnlyAccessPolicy. This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence phishing as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HighConfidenceSpamAction The HighConfidenceSpamAction parameter specifies the action to take on messages that are marked as high confidence spam (not spam, bulk email, phishing, or high confidence phishing). Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). -- Quarantine: Move the message to the quarantine. The quarantined message is only available to admins. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as high confidence spam are available to the intended recipients and admins. Or, you can use the HighConfidenceSpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. ```yaml @@ -538,13 +574,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncreaseScoreWithBizOrInfoUrls -**Note**: This setting is part of Advanced Spam Filtering (ASF) and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. +### -HighConfidenceSpamQuarantineTag +The HighConfidenceSpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as high confidence spam (the HighConfidenceSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as high confidence spam as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -IncreaseScoreWithBizOrInfoUrls The IncreaseScoreWithBizOrInfoUrls parameter increases the spam score of messages that contain links to .biz or .info domains. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain links to .biz or .info domains are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. +- On: The setting is enabled. Messages that contain links to .biz or .info domains are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: URL to .biz or .info websites` is added to the message. Not all messages that match this setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -561,12 +621,10 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithImageLinks -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithImageLinks parameter increases the spam score of messages that contain image links to remote websites. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. -- On: The setting is enabled. Messages that contain image links to remote websites are given the SCL 5 or 6 (spam), and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. +- On: The setting is enabled. Messages that contain image links to remote websites are given a higher spam score and therefore have a higher chance of getting marked as spam with SCL 5 or 6, and the X-header `X-CustomSpam: Image links to remote sites` is added to the message. Not all messages that match this setting will be marked as spam. - Test: The action specified by the TestModeAction parameter is taken on the message. ```yaml @@ -583,8 +641,6 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithNumericIps -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithNumericIps parameter increases the spam score of messages that contain links to IP addresses. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -605,8 +661,6 @@ Accept wildcard characters: False ``` ### -IncreaseScoreWithRedirectToOtherPort -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The IncreaseScoreWithRedirectToOtherPort parameter increases the spam score of messages that contain links that redirect to TCP ports other than 80 (HTTP), 8080 (alternate HTTP), or 443 (HTTPS). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -645,12 +699,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IntraOrgFilterState +The IntraOrgFilterState parameter specifies whether to enable anti-spam filtering for messages sent between internal users (users in the same organization). The action that's configured in the policy for the specified spam filter verdicts is taken on messages sent between internal users. Valid values are: + +- Default: This is the default value. Currently, HighConfidencePhish. +- HighConfidencePhish +- Phish: Includes phishing and high confidence phishing. +- HighConfidenceSpam: Includes high confidence spam, phishing, and high confidence phishing. +- Spam: Includes spam, high confidence spam, phishing, and high confidence phishing. +- Disabled + +```yaml +Type: IntraOrgFilterState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LanguageBlockList -The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported ISO 639-1 two-letter language code: +The LanguageBlockList parameter specifies the email content languages that are marked as spam when the EnableLanguageBlockList parameter value is $true. A valid value is a supported uppercase ISO 639-1 two-letter language code: -af, ar, az, be, bg, bn, br, bs, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, fy, ga, gl, gu, ha, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kl, kn, ko, ku, ky, la, lb, lt, lv, mi, mk, ml, mn, mr, ms, mt, nb, nl, nn, pa, pl, ps, pt, rm, ro, ru, se, sk, sl, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, uz, vi, wen, yi, zh-cn, zh-tw, and zu. +AF, AR, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, EL, EN, EO, ES, ET, EU, FA, FI, FO, FR, FY, GA, GL, GU, HA, HE, HI, HR, HU, HY, ID, IS, IT, JA, KA, KK, KL, KN, KO, KU, KY, LA, LB, LT, LV, MI, MK, ML, MN, MR, MS, MT, NB, NL, NN, PA, PL, PS, PT, RM, RO, RU, SE, SK, SL, SQ, SR, SV, SW, TA, TE, TH, TL, TR, UK, UR, UZ, VI, WEN, YI, ZH-CN, ZH-TW, and ZU. -A reference for two-letter language codes is available at [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php). Note that not all possible language codes are available as input for this parameter. +A reference for two-letter language codes is available at [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php). Not all possible language codes are available as input for this parameter. To enter multiple values and overwrite any existing entries, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -672,7 +749,7 @@ Accept wildcard characters: False ``` ### -MakeDefault -The MakeDefault switch makes the specified spam filter policy the default spam filter policy. You don't have to specify a value with this switch. +The MakeDefault switch makes the specified spam filter policy the default spam filter policy. You don't need to specify a value with this switch. The default spam filter policy is applied to everyone (no corresponding spam filter rule), can't be renamed, and has the unmodifiable priority value Lowest (the default policy is always applied last). @@ -710,8 +787,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmbedTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmbedTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -732,8 +807,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamEmptyMessages -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamEmptyMessages parameter marks a message as spam when the message contains no subject, no content in the message body, and no attachments. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -754,8 +827,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFormTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFormTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -776,8 +847,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFramesInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFramesInHtml parameter marks a message as spam when the message contains HTML \ or \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -798,8 +867,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamFromAddressAuthFail -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamFromAddressAuthFail parameter marks a message as spam when Sender ID filtering encounters a hard fail. This setting combines an Sender Policy Framework (SPF) check with a Sender ID check to help protect against message headers that contain forged senders. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -819,8 +886,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamJavaScriptInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamJavaScriptInHtml parameter marks a message as spam when the message contains JavaScript or VBScript. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -841,8 +906,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamNdrBackscatter -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamNdrBackscatter parameter marks a message as spam when the message is a non-delivery report (also known as an NDR or bounce messages) sent to a forged sender (known as *backscatter*). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -862,8 +925,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamObjectTagsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamObjectTagsInHtml parameter marks a message as spam when the message contains HTML \ tags. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -884,8 +945,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSensitiveWordList -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSensitiveWordList parameter marks a message as spam when the message contains words from the sensitive words list. Microsoft maintains a dynamic but non-editable list of words that are associated with potentially offensive messages. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -906,8 +965,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamSpfRecordHardFail -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamSpfRecordHardFail parameter marks a message as spam when SPF record checking encounters a hard fail. Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -927,8 +984,6 @@ Accept wildcard characters: False ``` ### -MarkAsSpamWebBugsInHtml -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you leave this setting turned off. - The MarkAsSpamWebBugsInHtml parameter marks a message as spam when the message contains web bugs (also known as web beacons). Valid values are: - Off: The setting is disabled. This is the default value, and we recommend that you don't change it. @@ -971,14 +1026,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PhishQuarantineTag +The PhishQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as phishing (the PhishSpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as phishing as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PhishSpamAction The PhishSpamAction parameter specifies the action to take on messages that are marked as phishing (not high confidence phishing). Phishing messages use fraudulent links or spoofed domains to get personal information. Valid values are: - AddXHeader: Add the AddXHeaderValue parameter value to the message header and deliver the message. - Delete: Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). -- Quarantine: Move the message to the quarantine. This is the default value. The quarantined message is available to the intended recipients (as of April, 2020) and admins. +- MoveToJmf: Deliver the message to the Junk Email folder in the recipient's mailbox. +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as phishing are available to admins and (as of April 2020) the intended recipients. Or, you can use the PhishQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. ```yaml @@ -1096,8 +1177,8 @@ The SpamAction parameter specifies the action to take on messages that are marke - AddXHeader: Add the AddXHeaderValue parameter value to the message header, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). - Delete : Delete the message during filtering. Use caution when selecting this value, because you can't recover the deleted message. - ModifySubject: Add the ModifySubject parameter value to the beginning of the subject line, deliver the message, and move the message to the Junk Email folder (same caveats as MoveToJmf). -- MoveToJmf: This is the default value. Deliver the message to the recipient's mailbox, and move the message to the Junk Email folder. In Exchange Online, The message is moved only if the junk email rule is enabled on the mailbox (it's enabled by default). For more information, see [Configure junk email settings on Exchange Online mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-junk-email-settings-on-exo-mailboxes). In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the k Email folder in hybrid environments](https://docs.microsoft.com/microsoft-365/security/office-365-security/ensure-that-spam-is-routed-to-each-user-s-junk-email-folder). -- Quarantine: Move the message to the quarantine. The quarantined message is available to the intended recipients and admins. +- MoveToJmf: This is the default value. Deliver the message to the Junk Email folder in the recipient's mailbox. In standalone Exchange Online Protection environments, you need to configure mail flow rules in your on-premises Exchange organization. For instructions, see [Configure standalone EOP to deliver spam to the Junk Email folder in hybrid environments](https://learn.microsoft.com/exchange/standalone-eop/configure-eop-spam-protection-hybrid). +- Quarantine: Deliver the message to quarantine. By default, messages that are quarantined as spam are available to the intended recipients and admins. Or, you can use the SpamQuarantineTag parameter to specify what end-users are allowed to do on quarantined messages. - Redirect: Redirect the message to the recipients specified by the RedirectToRecipients parameter. ```yaml @@ -1113,6 +1194,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SpamQuarantineTag +The SpamQuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as spam (the SpamAction parameter value is Quarantine). You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named DefaultFullAccessPolicy (no notifications) or NotificationEnabledPolicy (if available in your organization). This quarantine policy enforces the historical capabilities for messages that were quarantined as spam as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SpamZapEnabled The SpamZapEnabled parameter enables or disables zero-hour auto purge (ZAP) to detect spam in already delivered messages in Exchange Online mailboxes. Valid values are: @@ -1135,8 +1242,6 @@ Accept wildcard characters: False ``` ### -TestModeAction -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeAction parameter specifies the additional action to take on messages when one or more IncreaseScoreWith\* or MarkAsSpam\* ASF parameters are set to the value Test. Valid values are: - None: This is the default value, and we recommend that you don't change it. @@ -1157,8 +1262,6 @@ Accept wildcard characters: False ``` ### -TestModeBccToRecipients -**Note**: This setting is part of ASF and will be deprecated. The functionality of this setting will be incorporated into other parts of the filtering stack. We recommend that you don't use this setting. - The TestModeBccToRecipients parameter specifies the blind carbon copy (Bcc) recipients to add to spam messages when the TestModeAction ASF parameter is set to the value BccMessage. Valid input for this parameter is an email address. Separate multiple email addresses with commas. @@ -1199,16 +1302,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS -[Safe sender and blocked sender lists in Exchange Online](https://docs.microsoft.com/microsoft-365/security/office-365-security/safe-sender-and-blocked-sender-lists-faq) +[Safe sender and blocked sender lists in Exchange Online](https://learn.microsoft.com/defender-office-365/create-safe-sender-lists-in-office-365) diff --git a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md b/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md index 9bf8835e56..991cf73ca1 100644 --- a/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md +++ b/exchange/exchange-ps/exchange/Set-HostedContentFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-hostedcontentfilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedcontentfilterrule applicable: Exchange Online, Exchange Online Protection title: Set-HostedContentFilterRule schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-HostedContentFilterRule cmdlet to modify spam filter rules (content filter rules) in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +38,10 @@ Set-HostedContentFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Use the Microsoft Defender portal to create anti-spam policies](https://learn.microsoft.com/defender-office-365/anti-spam-policies-configure#use-the-microsoft-defender-portal-to-create-anti-spam-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,7 +110,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -150,7 +151,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception for the rule that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -239,7 +240,7 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition for the rule that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -280,7 +281,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition for the rule that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -327,12 +328,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md index e8bcf39095..5a570aaa15 100644 --- a/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-HostedOutboundSpamFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-hostedoutboundspamfilterpolicy applicable: Exchange Online, Exchange Online Protection title: Set-HostedOutboundSpamFilterPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-HostedOutboundSpamFilterPolicy cmdlet to modify outbound spam filter policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +38,7 @@ Set-HostedOutboundSpamFilterPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -327,12 +325,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md b/exchange/exchange-ps/exchange/Set-HybridConfiguration.md index 48210e0fc6..5811e49d7f 100644 --- a/exchange/exchange-ps/exchange/Set-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-HybridConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-hybridconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/set-hybridconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-HybridConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-HybridConfiguration cmdlet to modify the hybrid deployment between your on-premises Exchange organization and Exchange Online in a Microsoft 365 for enterprises organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -44,7 +44,7 @@ Set-HybridConfiguration ## DESCRIPTION The Set-HybridConfiguration cmdlet modifies the hybrid configuration features, such as enabling secure mail, designating a specific Mailbox server for hybrid functionality, or enabling or disabling free/busy information sharing and message tracking between the on-premises Exchange and Exchange Online organizations. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -72,7 +72,7 @@ This example specifies that the hybrid deployment uses a defined TLS certificate ## PARAMETERS ### -ClientAccessServers -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The ClientAccessServers parameter specifies the Exchange 2010 SP2 or later servers with the Client Access server role installed that will be configured to support the hybrid deployment features. At least one Client Access server must be defined and be externally accessible from the Internet on ports 80 and 443. The servers will be configured to enable the following: @@ -362,12 +362,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-HybridMailflow.md b/exchange/exchange-ps/exchange/Set-HybridMailflow.md deleted file mode 100644 index c0be44a620..0000000000 --- a/exchange/exchange-ps/exchange/Set-HybridMailflow.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-hybridmailflow -applicable: Exchange Online -title: Set-HybridMailflow -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-HybridMailflow - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-HybridMailflow cmdlet to configure the message transport settings for the Microsoft Exchange Online Protection (EOP) service in a hybrid deployment. - -The Set-HybridMailflow cmdlet is only used to support hybrid deployments configured with the Hybrid Configuration wizard offered in Microsoft Exchange Server 2010 Service Pack 2 (SP2). - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-HybridMailflow [-CentralizedTransportEnabled ] - [-CertificateSubject ] - [-Confirm] - [-InboundIPs ] - [-OnPremisesFQDN ] - [-OutboundDomains ] - [-SecureMailEnabled ] - [-WhatIf] - [] -``` - -## DESCRIPTION -The Set-HybridMailflow cmdlet supports the configuration of message transport settings for hybrid deployments created with the Hybrid Configuration wizard offered in Exchange 2010 SP2. This cmdlet isn't typically used by administrators; therefore, we strongly recommend that it only be used as part of the hybrid configuration process using the Hybrid Configuration wizard. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-HybridMailflow -``` - -This example configures the message transport settings in the EOP service for a hybrid deployment. - -## PARAMETERS - -### -CentralizedTransportEnabled -The CentralizedTransportEnabled parameter specifies that the Exchange Online organization routes all outbound mail messages to external recipients to the on-premises Exchange organization. The on-premises Exchange organization then routes the messages to the external recipients. The valid input for the CentralizedTransportEnabled parameter is $true or $false. The default value is $true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -CertificateSubject -The CertificateSubject parameter specifies the principal name of the certificate used for secure mail flow between the on-premises Exchange and Exchange Online organizations. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InboundIPs -The InboundIPs parameter specifies the IP addresses of the on-premises mail transport servers configured as part of the hybrid deployment. These must point to either Exchange 2010 SP2 Hub Transport or Edge Transport servers. - -```yaml -Type: IPRange[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OnPremisesFQDN -The OnPremisesFQDN parameter specifies the fully qualified domain name (FQDN) of the outbound smart host in the on-premises Exchange organization to use for centralized transport. This is either an on-premises Exchange 2010 SP2 Hub Transport or Edge Transport server. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -OutboundDomains -The OutboundDomains parameter specifies SMTP domains configured for the hybrid deployment. - -```yaml -Type: SmtpDomainWithSubdomains[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -SecureMailEnabled -The SecureMailEnabled parameter specifies that all messages sent between the on-premises Exchange and the Exchange Online organizations must use the Transport Layer Security (TLS) protocol and the assigned digital certificate. The valid input for the SecureMailEnabled parameter is $true or $false. The default value is $true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md b/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md index 0d2efd4c52..0c7a6349a0 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPAllowListConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ipallowlistconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-IPAllowListConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPAllowListConfig cmdlet to modify the IP Allow list configuration that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -152,12 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md index 8e1f5de821..4ede592a05 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Set-IPAllowListProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ipallowlistprovider +online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-IPAllowListProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPAllowListProvider cmdlet to modify IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -252,12 +252,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md b/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md index 10d94e6980..214711a0f1 100644 --- a/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPAllowListProvidersConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ipallowlistprovidersconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-ipallowlistprovidersconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-IPAllowListProvidersConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPAllowListProvidersConfig cmdlet to modify the settings that affect all IP Allow list providers that are configured on an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -152,12 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md b/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md index b0051824d4..af8ccda55d 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPBlockListConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ipblocklistconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-IPBlockListConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPBlockListConfig cmdlet to modify the IP Block list configuration that's used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -186,12 +186,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md index ae08074fee..f7394da090 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Set-IPBlockListProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ipblocklistprovider +online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-IPBlockListProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPBlockListProvider cmdlet to modify IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -271,12 +271,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md b/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md index 8b217dbd7e..50419ac6d6 100644 --- a/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md +++ b/exchange/exchange-ps/exchange/Set-IPBlockListProvidersConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ipblocklistprovidersconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-ipblocklistprovidersconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-IPBlockListProvidersConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Set-IPBlockListProvidersConfig cmdlet to modify the settings that affect all IP Block list providers that are configured on an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -183,12 +183,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md index 2a1a3e9204..76f288110e 100644 --- a/exchange/exchange-ps/exchange/Set-IRMConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-IRMConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-irmconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/set-irmconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-IRMConfiguration schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Set-IRMConfiguration cmdlet to configure Information Rights Management ( Configuring and using IRM features in an on-premises Exchange organization requires Active Directory Rights Management Services (AD RMS). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,12 +32,14 @@ Set-IRMConfiguration [-Identity ] [-DomainController ] [-EDiscoverySuperUserEnabled ] [-EnablePdfEncryption ] + [-EnablePortalTrackingLogs ] [-ExternalLicensingEnabled ] [-Force] [-InternalLicensingEnabled ] [-JournalReportDecryptionEnabled ] [-LicensingLocation ] [-RefreshServerCertificates] + [-RejectIfRecipientHasNoRights ] [-RMSOnlineKeySharingLocation ] [-SearchEnabled ] [-SimplifiedClientAccessDoNotForwardDisabled ] @@ -51,7 +53,7 @@ Set-IRMConfiguration [-Identity ] ## DESCRIPTION IRM requires the use of an on-premises AD RMS server or the ILS service. IRM features can be selectively enabled or disabled. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,7 +124,7 @@ This parameter is available only in the cloud-based service. The AzureRMSLicensingEnabled parameter specifies whether the Exchange Online organization can to connect directly to Azure Rights Management. Valid values are: -- $true: The Exchange Online organization can connect directly to Azure Rights Management. This enables Office 365 Message Encryption. +- $true: The Exchange Online organization can connect directly to Azure Rights Management. This enables Microsoft Purview Message Encryption. - $false: The Exchange Online organization can't connect directly to Azure Rights Management. ```yaml @@ -143,7 +145,7 @@ This parameter is available only in on-premises Exchange. The ClientAccessServerEnabled parameter specifies whether Exchange Client Access servers are allowed to authenticate clients that do not have direct access to AD RMS (for example, Outlook on the web, Exchange ActiveSync or remote Outlook Anywhere clients). Valid values are: -- $true: Client Access servers are allowed to authenticate clients. This is the default value. Note that enabling IRM in Outlook on the web requires additional configuration on AD RMS servers. For more information, see [Information Rights Management in Outlook Web App](https://docs.microsoft.com/exchange/information-rights-management-in-outlook-web-app-exchange-2013-help). +- $true: Client Access servers are allowed to authenticate clients. This is the default value. Note that enabling IRM in Outlook on the web requires additional configuration on AD RMS servers. For more information, see [Information Rights Management in Outlook Web App](https://learn.microsoft.com/exchange/information-rights-management-in-outlook-web-app-exchange-2013-help). - $false: Client Access servers aren't allowed to authenticate clients. ```yaml @@ -181,7 +183,7 @@ Accept wildcard characters: False ### -DecryptAttachmentForEncryptOnly This parameter is available only in the cloud-based service. -The DecryptAttachmentForEncryptOnly parameter specifies whether mail recipients have unrestricted rights on the attachment or not for Encrypt-only mails sent using new Office 365 Message Encryption capabilities. Valid values are: +The DecryptAttachmentForEncryptOnly parameter specifies whether mail recipients have unrestricted rights on the attachment or not for Encrypt-only mails sent using Microsoft Purview Message Encryption. Valid values are: - $true: The recipients will have unrestricted rights on attachments sent using Encrypt-Only policy. - $false: The recipients will not have unrestricted rights on attachments sent using Encrypt-Only policy. @@ -225,7 +227,7 @@ The EDiscoverySuperUserEnabled parameter specifies whether members of the Discov - $true: Members of the Discovery Management role group can access IRM-protected messages in discovery mailboxes. - $false: Members of the Discovery Management role group can't access IRM-protected messages in discovery mailboxes. -For more information about In-Place eDiscovery and IRM-protected messages, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). +For more information about In-Place eDiscovery and IRM-protected messages, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: Boolean @@ -243,7 +245,7 @@ Accept wildcard characters: False ### -EnablePdfEncryption This parameter is available only in the cloud-based service. -The EnablePdfEncryption parameter specifies whether to enable the encryption of PDF attachments using Office 365 Message Encryption (OME). Valid values are: +The EnablePdfEncryption parameter specifies whether to enable the encryption of PDF attachments using Microsoft Purview Message Encryption. Valid values are: - $true: Messages that contain PDF attachments can be encrypted. - $false: Messages that contain PDF attachments can't be encrypted. @@ -261,6 +263,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnablePortalTrackingLogs +This parameter is available only in the cloud-based service. + +**Note**: This parameter is available only in organizations with Microsoft Purview Advanced Message Encryption. For more information, see [Advanced Message Encryption](https://learn.microsoft.com/purview/ome-advanced-message-encryption). + +The EnablePortalTrackingLogs parameter specifies whether to turn on auditing for the Office 365 Message Encryption (OME) portal. Valid values are: + +- $true: Turn on auditing for activities in the OME portal. Activities are visible in the audit logs. +- $false: Turn off auditing for activities in the OME portal. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExternalLicensingEnabled This parameter is available only in on-premises Exchange. @@ -285,7 +310,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress the confirmation prompt that appears when you modify the InternalLicensingEnabled parameter. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you modify the InternalLicensingEnabled parameter. ```yaml Type: SwitchParameter @@ -324,7 +351,7 @@ Accept wildcard characters: False ### -JournalReportDecryptionEnabled The JournalReportDecryptionEnabled parameter specifies whether to enable journal report decryption. Valid values are: -- $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This is the default value. Note that journal report decryption requires additional configuration on AD RMS servers. For more information, see [Journal report decryption](https://docs.microsoft.com/exchange/journal-report-decryption-exchange-2013-help). +- $true: Journal report encryption is enabled. A decrypted copy of the IRM-protected message is attached to the journal report. This is the default value. Note that journal report decryption requires additional configuration on AD RMS servers. For more information, see [Journal report decryption](https://learn.microsoft.com/exchange/journal-report-decryption-exchange-2013-help). - $false: Journal report decryption is disabled. ```yaml @@ -345,6 +372,8 @@ The LicensingLocation parameter specifies the RMS licensing URLs. You can specif Typically, in on-premises Exchange, you only need to use this parameter in cross-forest deployments of AD RMS licensing servers. +**IMPORTANT**: If you specify multiple URLs, always specify the Azure RMS URL first. Otherwise, encryption services won't function properly. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -363,7 +392,7 @@ This parameter is available only in on-premises Exchange. The RefreshServerCertificates switch clears all Rights Account Certificates (RACs), Computer Licensor Certificates (CLCs), and cached AD RMS templates from all Exchange servers in the organization. You don't need to specify a value with this switch. -Clearing RACs, CLCs, and cached templates might be required during troubleshooting or after changing keys on the AD RMS cluster in your organization. For more information about RACs and CLCs, see [Understanding AD RMS Certificates](https://docs.microsoft.com/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc753886(v=ws.11)). +Clearing RACs, CLCs, and cached templates might be required during troubleshooting or after changing keys on the AD RMS cluster in your organization. For more information about RACs and CLCs, see [Understanding AD RMS Certificates](https://learn.microsoft.com/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc753886(v=ws.11)). ```yaml Type: SwitchParameter @@ -378,6 +407,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RejectIfRecipientHasNoRights +This parameter is available only in the cloud-based service. + +{{ Fill RejectIfRecipientHasNoRights Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RMSOnlineKeySharingLocation This parameter is available only in the cloud-based service. @@ -519,12 +566,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ImapSettings.md b/exchange/exchange-ps/exchange/Set-ImapSettings.md index b706cb2fba..d6a70cad13 100644 --- a/exchange/exchange-ps/exchange/Set-ImapSettings.md +++ b/exchange/exchange-ps/exchange/Set-ImapSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-imapsettings +online version: https://learn.microsoft.com/powershell/module/exchange/set-imapsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ImapSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ImapSettings cmdlet to modify the settings of the Microsoft Exchange IMAP4 service on Exchange servers. This service exists on Exchange servers that have the Client Access server role installed, and is used by IMAP4 clients to connect to Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -58,7 +58,7 @@ Set-ImapSettings [-AuthenticatedConnectionTimeout ] ## DESCRIPTION You can run the Set-ImapSettings cmdlet for a single Exchange server that's running the Microsoft Exchange IMAP4 service, or for all Exchange servers that are running the Microsoft Exchange IMAP4 service. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -349,8 +349,8 @@ Accept wildcard characters: False ### -LogFileRollOverSettings The LogFileRollOverSettings parameter specifies how frequently IMAP4 protocol logging creates a new log file. Valid values are: -- 1 or Hourly. -- 2 or Daily. This is the default value +- 1 or Hourly. This is the default value in Exchange 2019 and Exchange 2016. +- 2 or Daily. This is the default value in Exchange 2013 and Exchange 2010. - 3 or Weekly. - 4 or Monthly. @@ -726,12 +726,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-InboundConnector.md b/exchange/exchange-ps/exchange/Set-InboundConnector.md index 2239e65895..285ba184d1 100644 --- a/exchange/exchange-ps/exchange/Set-InboundConnector.md +++ b/exchange/exchange-ps/exchange/Set-InboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-inboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/set-inboundconnector applicable: Exchange Online, Exchange Online Protection title: Set-InboundConnector schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-InboundConnector cmdlet to change an existing Inbound connector in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,6 +43,7 @@ Set-InboundConnector [-Identity] [-SenderIPAddresses ] [-TlsSenderCertificateName ] [-TreatMessagesAsInternal ] + [-TrustedOrganizations ] [-WhatIf] [] ``` @@ -52,7 +51,7 @@ Set-InboundConnector [-Identity] ## DESCRIPTION Inbound connectors accept email messages from remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,7 +85,9 @@ Accept wildcard characters: False ``` ### -AssociatedAcceptedDomains -The AssociatedAcceptedDomains parameter specifies the accepted domains that the connector applies to, thereby limiting its scope. For example, you can apply the connector to a specific accepted domain in your organization, such as contoso.com. +The AssociatedAcceptedDomains parameter restricts the source domains that use the connector to the specified accepted domains. A valid value is an SMTP domain that's configured as an accepted domain in your Microsoft 365 organization. + +You can specify multiple values separated by commas. ```yaml Type: MultiValuedProperty @@ -102,7 +103,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -160,13 +161,13 @@ Accept wildcard characters: False ``` ### -ConnectorSource -The ConnectorSource parameter specifies how the connector was created. Valid input for this parameter includes the following values: +The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values: -- Default: The connector is manually created. -- HybridWizard: The connector is created automatically by the Hybrid Configuration Wizard. +- Default: The connector is manually created. This is the default value. +- HybridWizard: The connector is automatically created by the Hybrid Configuration Wizard. - Migrated: The connector was originally created in Microsoft Forefront Online Protection for Exchange. -The default value for connectors you create is Default. It isn't recommended that you change this value. +We recommended that you don't change this value. ```yaml Type: TenantConnectorSource @@ -185,7 +186,7 @@ Accept wildcard characters: False The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid input for this parameter includes the following values: - Partner: The connector services domains that are external to your organization. -- OnPremises: The connector services domains that are used by your on-premises organization. Use this value for accepted domains in your cloud-based organization that are also specified by the SenderDomains parameter. +- OnPremises: The connector services domains that are used by your on-premises organization. OnPremises connectors grant special rights to an email that matches the connector and additional requirements. For example: allowing relay through the tenant to internet destinations, promoting emails from on-premises or other environments as internal (in a hybrid configuration), or enabling other more complex mail flows. ```yaml Type: TenantConnectorType @@ -292,7 +293,10 @@ Accept wildcard characters: False ``` ### -Enabled -The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true. +The Enabled parameter enables or disables the connector. Valid values are: + +- $true: The connector is enabled. This is the default value. +- $false: The connector is disabled. ```yaml Type: Boolean @@ -324,7 +328,12 @@ Accept wildcard characters: False ``` ### -RequireTls -The RequireTLS parameter specifies that all messages received by this connector require TLS transmission. Valid values for this parameter are $true or $false. The default value is $false. When the RequireTLS parameter is set to $true, all messages received by this connector require TLS transmission. +The RequireTLS parameter specifies whether to require TLS transmission for all messages that are received by a Partner type connector. Valid values are: + +- $true: Reject messages if they aren't sent over TLS. This is the default value +- $false: Allow messages if they aren't sent over TLS. + +**Note**: This parameter applies only to Partner type connectors. ```yaml Type: Boolean @@ -340,7 +349,12 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToCertificate -The RestrictDomainsToCertificate parameter specifies that Microsoft 365 should identify incoming messages that are eligible for this connector by verifying that the remote server authenticates using a TLS certificate that has the TlsSenderCertificateName in the Subject. Valid values are $true or $false. +The RestrictDomainsToCertificate parameter specifies whether the Subject value of the TLS certificate is checked before messages can use the Partner type connector. Valid values are: + +- $true: Mail is allowed to use the connector only if the Subject value of the TLS certificate that the source email server uses to authenticate matches the TlsSenderCertificateName parameter value. +- $false: The Subject value of the TLS certificate that the source email server uses to authenticate doesn't control whether mail from that source uses the connector. This is the default value. + +**Note**: This parameter applies only to Partner type connectors. ```yaml Type: Boolean @@ -356,9 +370,12 @@ Accept wildcard characters: False ``` ### -RestrictDomainsToIPAddresses -The RestrictDomainsToIPAddresses parameter, when set to $true, automatically rejects mail from the domains specified by the SenderDomains parameter if the mail originates from an IP address that isn't specified by the SenderIPAddresses parameter. +The RestrictDomainsToIPAddresses parameter specifies whether to reject mail that comes from unknown source IP addresses for Partner type connectors. Valid values are: + +- $true: Automatically reject mail from domains that are specified by the SenderDomains parameter if the source IP address isn't also specified by the SenderIPAddress parameter. +- $false: Don't automatically reject mail from domains that are specified by the SenderDomains parameter based on the source IP address. This is the default value. -Valid input for this parameter is $true or $false. The default value is $false. +**Note**: This parameter applies only to Partner type connectors. ```yaml Type: Boolean @@ -390,7 +407,7 @@ Accept wildcard characters: False ``` ### -SenderDomains -The SenderDomains parameter specifies the remote domains from which this connector accepts messages, thereby limiting its scope. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. +The SenderDomains parameter specifies the source domains that a Partner type connector accepts messages for (limits the scope of a Partner type connector). A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, `*.contoso.com`). However, you can't embed the wildcard character (for example, `domain.*.contoso.com` isn't valid). You can specify multiple domains separated by commas. @@ -408,12 +425,15 @@ Accept wildcard characters: False ``` ### -SenderIPAddresses -The SenderIPAddresses parameter specifies the remote IPV4 IP addresses from which this connector accepts messages. IPv6 addresses are not supported. Valid values are: +The SenderIPAddresses parameter specifies the source IPV4 IP addresses that the Partner type connector accepts messages from when the value of the RestrictDomainsToIPAddresses parameter is $true. Valid values are: - Single IP address: For example, 192.168.1.1. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. Valid subnet mask values are /24 through /32. +@@ -435,6 +441,8 @@ You can specify multiple IP addresses separated by commas. -You can specify multiple values separated by commas. +IPv6 addresses are not supported. + +**Note**: This parameter applies to Partner type connectors only if the value of the RestrictDomainsToIPAddresses parameter is $true. ```yaml Type: MultiValuedProperty @@ -429,9 +449,7 @@ Accept wildcard characters: False ``` ### -TlsSenderCertificateName -The TlsSenderCertificateName parameter specifies the certificate used by the sender's domain when the RequireTls parameter is set to $true. Valid input for the TlsSenderCertificateName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. - -You can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com. +The TlsSenderCertificateName parameter specifies the TLS certificate that's used when the value of the RequireTls parameter is $true. A valid value is an SMTP domain. Wildcards are supported to indicate a domain and all subdomains (for example, \*.contoso.com), but you can't embed the wildcard character (for example, domain.\*.contoso.com is not valid). ```yaml Type: TlsCertificate @@ -472,6 +490,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TrustedOrganizations +The TrustedOrganizations parameter specifies other Microsoft 365 organizations that are trusted mail sources (for example, after acquisitions and mergers). This parameter works only for mail flow between two Microsoft 365 organizations, so no other parameters are used. + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -493,12 +531,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-InboxRule.md b/exchange/exchange-ps/exchange/Set-InboxRule.md index e328d1fb58..fbbb29f2cb 100644 --- a/exchange/exchange-ps/exchange/Set-InboxRule.md +++ b/exchange/exchange-ps/exchange/Set-InboxRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-inboxrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-inboxrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-InboxRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-InboxRule cmdlet to modify existing Inbox rules in mailboxes. Inbox rules process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,6 @@ Set-InboxRule [-Identity] [-ExceptIfFlaggedForAction ] [-ExceptIfFrom ] [-ExceptIfFromAddressContainsWords ] - [-ExceptIfFromSubscription ] [-ExceptIfHasAttachment ] [-ExceptIfHasClassification ] [-ExceptIfHeaderContainsWords ] @@ -61,7 +60,6 @@ Set-InboxRule [-Identity] [-ForwardTo ] [-From ] [-FromAddressContainsWords ] - [-FromSubscription ] [-HasAttachment ] [-HasClassification ] [-HeaderContainsWords ] @@ -84,6 +82,7 @@ Set-InboxRule [-Identity] [-SendTextMessageNotificationTo ] [-SentOnlyToMe ] [-SentTo ] + [-SoftDeleteMessage ] [-StopProcessingRules ] [-SubjectContainsWords ] [-SubjectOrBodyContainsWords ] @@ -100,13 +99,13 @@ The Set-InboxRule cmdlet allows you to modify the rule conditions, exceptions, a When you create, modify, remove, enable, or disable an Inbox rule in Exchange PowerShell, any client-side rules created by Microsoft Outlook are removed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-InboxRule ProjectContoso -MarkImportance "High" +Set-InboxRule -Mailbox chris@contoso.com -Name ProjectContoso -MarkImportance "High" ``` This example modifies the action of the existing Inbox rule ProjectContoso. The MarkImportance parameter is used to mark the message with high importance. @@ -135,7 +134,7 @@ Accept wildcard characters: False ``` ### -AlwaysDeleteOutlookRulesBlob -The AlwaysDeleteOutlookRulesBlob switch hides a warning message when end users or administrators use Outlook on the web or PowerShell to modify Inbox rules. You don't need to specify a value with this switch. +The AlwaysDeleteOutlookRulesBlob switch hides a warning message when you use Outlook on the web (formerly known as Outlook Web App) or Exchange PowerShell to modify Inbox rules. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -216,10 +215,12 @@ Accept wildcard characters: False ### -BodyContainsWords The BodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding exception parameter to this condition is ExceptIfBodyContainsWords. ```yaml @@ -368,10 +369,12 @@ Accept wildcard characters: False ### -ExceptIfBodyContainsWords The ExceptIfBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding condition parameter to this exception is BodyContainsWords. ```yaml @@ -418,7 +421,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom -The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: For example: +The ExceptIfFrom parameter specifies an exception for the Inbox rule that looks for the specified sender in messages. You can use any value that uniquely identifies the sender. For example: - Name - Alias @@ -447,10 +450,12 @@ Accept wildcard characters: False ### -ExceptIfFromAddressContainsWords The ExceptIfFromAddressContainsWords parameter specifies an exception for the Inbox rule that looks for messages where the specified words are in the sender's email address. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding condition parameter to this exception is FromAddressContainsWords. ```yaml @@ -466,26 +471,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExceptIfFromSubscription -This parameter is available only in the cloud-based service. - -The ExceptIfFromSubscription parameter specifies an exception for the Inbox rule that looks for messages received from subscriptions (for example, POP or IMAP subscriptions). You can identify the subscription by using the Get-Subscription cmdlet. - -The corresponding condition parameter to this exception is FromSubscription. - -```yaml -Type: AggregationSubscriptionIdentity[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ExceptIfHasAttachment The ExceptIfHasAttachment parameter specifies an exception for the Inbox rule that looks for messages with attachments. Valid values are: @@ -528,10 +513,12 @@ Accept wildcard characters: False ### -ExceptIfHeaderContainsWords The HeaderContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding condition parameter to this exception is HeaderContainsWords. ```yaml @@ -664,7 +651,7 @@ Accept wildcard characters: False ### -ExceptIfReceivedAfterDate The ExceptIfReceivedAfterDate parameter specifies an exception for the Inbox rule that looks for messages received after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding condition parameter to this exception is ReceivedAfterDate. @@ -684,7 +671,7 @@ Accept wildcard characters: False ### -ExceptIfReceivedBeforeDate The ExceptIfReceivedBeforeDate parameter specifies an exception for the Inbox rule that looks for messages received before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding condition parameter to this exception is ReceivedBeforeDate. @@ -708,6 +695,8 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding condition parameter to this exception is RecipientAddressContainsWords. ```yaml @@ -774,10 +763,12 @@ Accept wildcard characters: False ### -ExceptIfSubjectContainsWords The ExceptIfSubjectContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding condition parameter to this exception is SubjectContainsWords. ```yaml @@ -796,11 +787,13 @@ Accept wildcard characters: False ### -ExceptIfSubjectOrBodyContainsWords The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -The corresponding condition parameter to this exception is ExceptIfSubjectOrBodyContainsWords. +The maximum length of this parameter is 255 characters. + +The corresponding condition parameter to this exception is SubjectOrBodyContainsWords. ```yaml Type: MultiValuedProperty @@ -949,7 +942,7 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. A confirmation prompt warns you if the mailbox contains rules that were created by Outlook, because any client-side rules will be removed by the actions of this cmdlet. @@ -1046,10 +1039,12 @@ Accept wildcard characters: False ### -FromAddressContainsWords The FromAddressContainsWords parameter specifies a condition for the Inbox rule that looks for messages where the specified words are in the sender's email address. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding exception parameter to this condition is ExceptIfFromAddressContainsWords. ```yaml @@ -1065,26 +1060,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FromSubscription -This parameter is available only in the cloud-based service. - -The FromSubscription parameter specifies a condition for the Inbox rule that looks for messages received from subscriptions (for example, POP or IMAP subscriptions). You can identify the subscription by using the Get-Subscription cmdlet. - -The corresponding exception parameter to this condition is ExceptIfFromSubscription. - -```yaml -Type: AggregationSubscriptionIdentity[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -HasAttachment The HasAttachment parameter specifies a condition for the Inbox rule that looks for messages with attachments. Valid values are: @@ -1127,10 +1102,12 @@ Accept wildcard characters: False ### -HeaderContainsWords The HeaderContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the header fields of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding exception parameter to this condition is ExceptIfHeaderContainsWords. ```yaml @@ -1358,7 +1335,7 @@ Accept wildcard characters: False ``` ### -Name -The Name parameter specifies a name for the Inbox rule. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +The Name parameter specifies a name for the Inbox rule. The maximum length is 512 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String @@ -1411,7 +1388,7 @@ Accept wildcard characters: False ### -ReceivedAfterDate The ReceivedAfterDate parameter specifies a condition for the Inbox rule that looks for messages received after the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding exception parameter to this condition is ExceptIfReceivedAfterDate. @@ -1431,7 +1408,7 @@ Accept wildcard characters: False ### -ReceivedBeforeDate The ReceivedBeforeDate parameter specifies a condition for the Inbox rule that looks for messages received before the specified date. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". The corresponding exception parameter to this condition is ExceptIfReceivedBeforeDate. @@ -1455,6 +1432,8 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding exception parameter to this condition is ExceptIfRecipientAddressContainsWords. ```yaml @@ -1496,6 +1475,8 @@ Accept wildcard characters: False ``` ### -SendTextMessageNotificationTo +This parameter is available only in on-premises Exchange. + The SendTextMessageNotificationTo parameter specifies an action for the Inbox rule that send a text message notification to the specified telephone number. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -1506,7 +1487,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1563,6 +1544,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SoftDeleteMessage +This parameter is available only in the cloud-based service. + +{{ Fill SoftDeleteMessage Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StopProcessingRules The StopProcessingRules parameter specifies an action for the Inbox rule that stops processing additional rules if the conditions of this Inbox rule are met. Valid values are:If set to $true, the StopProcessingRules parameter instructs Exchange to stop processing additional rules if the conditions of this Inbox rule are met. @@ -1585,10 +1584,12 @@ Accept wildcard characters: False ### -SubjectContainsWords The SubjectContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding exception parameter to this condition is ExceptIfSubjectContainsWords. ```yaml @@ -1607,10 +1608,12 @@ Accept wildcard characters: False ### -SubjectOrBodyContainsWords The SubjectOrBodyContainsWords parameter specifies a condition for the Inbox rule that looks for the specified words or phrases in the Subject field or body of messages. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +To specify multiple words or phrases that overwrite any existing entries, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +The maximum length of this parameter is 255 characters. + The corresponding exception parameter to this condition is ExceptIfSubjectOrBodyContainsWords. ```yaml @@ -1752,12 +1755,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md b/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md index 2a9d4b71fd..2fbe4dd044 100644 --- a/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md +++ b/exchange/exchange-ps/exchange/Set-InformationBarrierPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-informationbarrierpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-informationbarrierpolicy +applicable: Security & Compliance title: Set-InformationBarrierPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-InformationBarrierPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-InformationBarrierPolicy cmdlet to modify information barrier policies in the Microsoft 365 compliance center. +Use the Set-InformationBarrierPolicy cmdlet to modify information barrier policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,6 +26,8 @@ Set-InformationBarrierPolicy -Identity [-SegmentsAllowed ] [-Comment ] [-Confirm] + [-ModerationAllowed ] + [-Force] [-State ] [-WhatIf] [] @@ -37,6 +39,8 @@ Set-InformationBarrierPolicy -Identity [-SegmentAllowedFilter ] [-Comment ] [-Confirm] + [-Force] + [-ModerationAllowed ] [-State ] [-WhatIf] [] @@ -48,6 +52,8 @@ Set-InformationBarrierPolicy -Identity [-SegmentsBlocked ] [-Comment ] [-Confirm] + [-Force] + [-ModerationAllowed ] [-State ] [-WhatIf] [] @@ -56,12 +62,12 @@ Set-InformationBarrierPolicy -Identity ## DESCRIPTION Information barrier policies are not in effect until you set them to active status, and then apply the policies: -- (If needed): [Define a policy to block communications between segments](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#scenario-1-block-communications-between-segments). -- After all of your policies are defined: [Apply information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#part-3-apply-information-barrier-policies). +- (If needed): [Block communications between segments](https://learn.microsoft.com/purview/information-barriers-policies#scenario-1-block-communications-between-segments). +- After all of your policies are defined: [Apply information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies#step-4-apply-ib-policies). -For more information, see [Information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies). +For more information, see [Information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies). -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -85,7 +91,7 @@ The Identity parameter specifies the information barrier policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -101,7 +107,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -117,7 +123,41 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModerationAllowed +{{ Fill ModerationAllowed Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -137,7 +177,7 @@ You can't use this parameter with the SegmentsBlocked parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsAllowed Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -153,7 +193,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: OrganizationSegmentAllowedFilter Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -173,7 +213,7 @@ You can't use this parameter with the SegmentsAllowed parameter. Type: MultiValuedProperty Parameter Sets: OrganizationSegmentsBlocked Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -193,7 +233,7 @@ Type: EopInformationBarrierPolicyState Parameter Sets: (All) Aliases: Accepted values: Inactive, Active -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -203,13 +243,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -223,16 +263,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md b/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md index 460452eeba..5216746dff 100644 --- a/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md +++ b/exchange/exchange-ps/exchange/Set-IntraOrganizationConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-intraorganizationconnector +online version: https://learn.microsoft.com/powershell/module/exchange/set-intraorganizationconnector applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-IntraOrganizationConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-IntraOrganizationConnector cmdlet to modify an existing Intra-Organization connector between two on-premises Exchange forests in an organization, between an on-premises Exchange organization and an Exchange Online organization or between two Exchange Online organizations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Set-IntraOrganizationConnector [-Identity] ## DESCRIPTION The Set-JournalRule cmdlet modifies an existing journal rule used in your organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -152,6 +152,8 @@ Accept wildcard characters: False ### -Recipient The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or received from a recipient are journaled. +To journal messages from all recipients, use the value $null for this parameter. + ```yaml Type: SmtpAddress Parameter Sets: (All) @@ -206,12 +208,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-Label.md b/exchange/exchange-ps/exchange/Set-Label.md index e8821a2777..8424874e92 100644 --- a/exchange/exchange-ps/exchange/Set-Label.md +++ b/exchange/exchange-ps/exchange/Set-Label.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/policy-and-compliance/set-label -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/policy-and-compliance/set-label +applicable: Security & Compliance title: Set-Label schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-Label ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-Label cmdlet to modify sensitivity labels in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,23 +24,24 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-Label [-Identity] [-AdvancedSettings ] [-ApplyContentMarkingFooterAlignment ] - [-ApplyContentMarkingFooterEnabled ] + [-ApplyContentMarkingFooterEnabled ] [-ApplyContentMarkingFooterFontColor ] [-ApplyContentMarkingFooterFontName ] - [-ApplyContentMarkingFooterFontSize ] - [-ApplyContentMarkingFooterMargin ] + [-ApplyContentMarkingFooterFontSize ] + [-ApplyContentMarkingFooterMargin ] [-ApplyContentMarkingFooterText ] [-ApplyContentMarkingHeaderAlignment ] - [-ApplyContentMarkingHeaderEnabled ] + [-ApplyContentMarkingHeaderEnabled ] [-ApplyContentMarkingHeaderFontColor ] [-ApplyContentMarkingHeaderFontName ] - [-ApplyContentMarkingHeaderFontSize ] - [-ApplyContentMarkingHeaderMargin ] + [-ApplyContentMarkingHeaderFontSize ] + [-ApplyContentMarkingHeaderMargin ] [-ApplyContentMarkingHeaderText ] - [-ApplyWaterMarkingEnabled ] + [-ApplyDynamicWatermarkingEnabled ] + [-ApplyWaterMarkingEnabled ] [-ApplyWaterMarkingFontColor ] [-ApplyWaterMarkingFontName ] - [-ApplyWaterMarkingFontSize ] + [-ApplyWaterMarkingFontSize ] [-ApplyWaterMarkingLayout ] [-ApplyWaterMarkingText ] [-ColumnAssetCondition ] @@ -48,16 +49,18 @@ Set-Label [-Identity] [-Conditions ] [-Confirm] [-ContentType ] + [-DefaultContentLabel ] [-DisplayName ] + [-DynamicWatermarkDisplay ] [-EncryptionContentExpiredOnDateInDaysOrNever ] - [-EncryptionDoNotForward ] + [-EncryptionDoNotForward ] [-EncryptionDoubleKeyEncryptionUrl ] - [-EncryptionEnabled ] - [-EncryptionEncryptOnly ] - [-EncryptionOfflineAccessDays ] - [-EncryptionPromptUser ] + [-EncryptionEnabled ] + [-EncryptionEncryptOnly ] + [-EncryptionOfflineAccessDays ] + [-EncryptionPromptUser ] [-EncryptionProtectionType ] - [-EncryptionRightsDefinitions ] + [-EncryptionRightsDefinitions ] [-EncryptionRightsUrl ] [-LabelActions ] [-LocaleSettings ] @@ -65,7 +68,8 @@ Set-Label [-Identity] [-NextLabel ] [-ParentId ] [-PreviousLabel ] - [-Priority ] + [-Priority ] + [-SchematizedDataCondition ] [-Setting ] [-Settings ] [-SiteAndGroupProtectionAllowAccessToGuestUsers ] @@ -74,16 +78,33 @@ Set-Label [-Identity] [-SiteAndGroupProtectionAllowLimitedAccess ] [-SiteAndGroupProtectionBlockAccess ] [-SiteAndGroupProtectionEnabled ] + [-SiteAndGroupProtectionLevel ] [-SiteAndGroupProtectionPrivacy ] [-SiteExternalSharingControlType ] - [-SqlAssetCondition ] + [-TeamsAllowedPresenters ] + [-TeamsAllowMeetingChat ] + [-TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch ] + [-TeamsBypassLobbyForDialInUsers ] + [-TeamsChannelProtectionEnabled ] + [-TeamsChannelSharedWithExternalTenants ] + [-TeamsChannelSharedWithPrivateTeamsOnly ] + [-TeamsChannelSharedWithSameLabelOnly ] + [-TeamsCopyRestrictionEnforced ] + [-TeamsEndToEndEncryptionEnabled ] + [-TeamsLobbyBypassScope ] + [-TeamsLobbyRestrictionEnforced ] + [-TeamsPresentersRestrictionEnforced ] + [-TeamsProtectionEnabled ] + [-TeamsRecordAutomatically ] + [-TeamsVideoWatermark ] + [-TeamsWhoCanRecord ] [-Tooltip ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -114,7 +135,7 @@ The Identity parameter specifies the sensitivity label that you want to modify. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -124,13 +145,39 @@ Accept wildcard characters: False ``` ### -AdvancedSettings -The AdvancedSettings parameter enables client-specific features and capabilities for a sensitivity label. The settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For more information how to configure these advanced settings, see [Custom configurations for the Azure Information Protection unified labeling client](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). +The AdvancedSettings parameter enables specific features and capabilities for a sensitivity label. + +Specify this parameter with the identity (name or GUID) of the sensitivity label, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. + +Some of the settings that you configure with this parameter are supported only by the Microsoft Purview Information Protection client and not by Office apps and services that support built-in labeling. For a list of these, see [Advanced settings for Microsoft Purview Information Protection client](https://learn.microsoft.com/powershell/exchange/client-advanced-settings). + +Supported settings for built-in labeling: + +- **BlockContentAnalysisServices**: Specifies a privacy setting to allow or prevent content in Word, Excel, PowerPoint, and Outlook from being sent to Microsoft for content analysis. Available values are True, and False (the default). This setting impacts services such as data loss prevention policy tips, automatic and recommended labeling, and Microsoft Copilot for Microsoft 365. Example: `Set-Label -Identity Confidential -AdvancedSettings @{BlockContentAnalysisServices="True"}`. For more information, see [Prevent some connected experiences that analyze content](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#prevent-some-connected-experiences-that-analyze-content). + +- **Color**: Specifies a label color as a hex triplet code for the red, green, and blue (RGB) components of the color. Example: `Set-Label -Identity 8faca7b8-8d20-48a3-8ea2-0f96310a848e -AdvancedSettings @{color="#40e0d0"}`. For more information, see [Configuring custom colors by using PowerShell](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configuring-custom-colors-by-using-powershell). + +- **DefaultSharingScope**: Specifies the default sharing link type for a site when the label scope includes **Groups & sites**, and the default sharing link type for a document when the label scope includes **Files & emails**. Available values are SpecificPeople, Organization, and Anyone. Example: `Set-Label -Identity General -AdvancedSettings @{DefaultSharingScope="SpecificPeople"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultShareLinkPermission**: Specifies the permissions for the sharing link for a site when the label scope includes **Groups & sites**, and the permissions for the sharing link for a document when the label scope includes **Files & emails**. Available values are View and Edit. Example: `Set-Label -Identity General -AdvancedSettings @{DefaultShareLinkPermission="Edit"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultShareLinkToExistingAccess**: Specifies whether to override *DefaultSharingScope* and *DefaultShareLinkPermission* to instead set the default sharing link type to people with existing access with their existing permissions. Example: `Set-Label -Identity General -AdvancedSettings @{DefaultShareLinkToExistingAccess="True"}`. For more information, see [Use sensitivity labels to configure the default sharing link type for sites and documents in SharePoint and OneDrive](https://learn.microsoft.com/purview/sensitivity-labels-default-sharing-link). + +- **DefaultSubLabelId**: Specifies a default sublabel to be applied automatically when a user selects a parent label in Office apps. Example: `Set-Label -Identity Confidential -AdvancedSettings @{DefaultSubLabelId="8faca7b8-8d20-48a3-8ea2-0f96310a848e"}`. For more information, see [Specify a default sublabel for a parent label](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#specify-a-default-sublabel-for-a-parent-label). + +- **MembersCanShare**: For a container label, specifies how members can share for a SharePoint site. Available values are MemberShareAll, MemberShareFileAndFolder, and MemberShareNone. Example: `Set-Label -Identity General -AdvancedSettings @{MembersCanShare="MemberShareFileAndFolder"}`. For more information, see [Configure site sharing permissions by using PowerShell advanced settings](https://learn.microsoft.com/purview/sensitivity-labels-teams-groups-sites#configure-site-sharing-permissions-by-using-powershell-advanced-settings). + +- **SMimeEncrypt**: Specifies S/MIME encryption for Outlook. Available values are True, and False (the default). Example: `Set-Label -Identity "Confidential" -AdvancedSettings @{SMimeEncrypt="True"}`. For more information, see [Configure a label to apply S/MIME protection in Outlook](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). + +- **SMimeSign**: Specifies S/MIME digital signature for Outlook. Available values are True, and False (the default). Example: `Set-Label -Identity "Confidential" -AdvancedSettings @{SMimeSign="True"}`. For more information, see [Configure a label to apply S/MIME protection in Outlook](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-a-label-to-apply-smime-protection-in-outlook). + +For more information to help you configure advanced settings for a label, see [PowerShell tips for specifying the advanced settings](https://learn.microsoft.com/purview/create-sensitivity-labels#powershell-tips-for-specifying-the-advanced-settings). ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -152,7 +199,7 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -168,10 +215,10 @@ The ApplyContentMarkingFooterEnabled parameter enables or disables the Apply Con - $false: The Apply Content Marking Footer action is disabled. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -189,7 +236,7 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -203,11 +250,13 @@ The ApplyContentMarkingFooterFontName parameter specifies the font of the footer This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. +This parameter is supported only by the Azure Information Protection unified labeling client and not by Office apps and services that support built-in labeling. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -222,10 +271,10 @@ The ApplyContentMarkingFooterFontSize parameter specifies the font size (in poin This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -239,11 +288,13 @@ The ApplyContentMarkingFooterMargin parameter specifies the size (in points) of This parameter is meaningful only when the ApplyContentMarkingFooterEnabled parameter value is either $true or $false. +**Note**: In Microsoft Word and PowerPoint, the specified value is used as a bottom (vertical) margin and left margin or right margin for left-aligned or right-aligned content marks. A minimum value of 15 points is required. Word also adds a constant offset of 5 points to the left margin for left-aligned content marks, or to the right margin for right-aligned content marks. + ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -261,7 +312,7 @@ This parameter is meaningful only when the ApplyContentMarkingFooterEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -283,7 +334,7 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+ContentAlignment Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -299,10 +350,10 @@ The ApplyContentMarkingHeaderEnabled parameter enables or disables the Apply Con - $false: The Apply Content Marking Header action is disabled. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -320,7 +371,7 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -338,7 +389,7 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -353,10 +404,10 @@ The ApplyContentMarkingHeaderFontSize parameter specifies the font size (in poin This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -370,11 +421,13 @@ The ApplyContentMarkingHeaderMargin parameter specifies the size (in points) of This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled parameter value is either $true or $false. +**Note**: In Microsoft Word and PowerPoint, the specified value is used as a top margin and left margin or right margin for left-aligned or right-aligned content marks. A minimum value of 15 points is required. Word also adds a constant offset of 5 points to the left margin for left-aligned content marks, or to the right margin for right-aligned content marks. + ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -392,7 +445,30 @@ This parameter is meaningful only when the ApplyContentMarkingHeaderEnabled para Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ApplyDynamicWatermarkingEnabled +**Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. + +The ApplyDynamicWatermarkingEnabled parameter enables dynamic watermarking for a specific label that applies encryption. Valid values are: + +- $true: Enables dynamic watermarking for a specific label. +- $false: Disables dynamic watermarking for a specific label. + +You set the watermark text with the DynamicWatermarkDisplay parameter. For more information about using dynamic watermarks for supported apps, see [Dynamic watermarks](https://learn.microsoft.com/purview/encryption-sensitivity-labels#dynamic-watermarks). + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -408,10 +484,10 @@ The ApplyWaterMarkingEnabled parameter enables or disables the Apply Watermarkin - $false: The Apply Watermarking Header action is disabled. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -429,7 +505,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -447,7 +523,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -462,10 +538,10 @@ The ApplyWaterMarkingFontSize parameter specifies the font size (in points) of t This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter value is either $true or $false. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -475,7 +551,7 @@ Accept wildcard characters: False ``` ### -ApplyWaterMarkingLayout -The ApplyWaterMarkingAlignment parameter specifies the watermark alignment. Valid values are: +The ApplyWaterMarkingLayout parameter specifies the watermark alignment. Valid values are: - Horizontal - Diagonal @@ -486,7 +562,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+WaterMarkingLayout Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -504,7 +580,7 @@ This parameter is meaningful only when the ApplyWaterMarkingEnabled parameter va Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -514,13 +590,13 @@ Accept wildcard characters: False ``` ### -ColumnAssetCondition -{{ Fill ColumnAssetCondition Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -536,7 +612,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -546,13 +622,13 @@ Accept wildcard characters: False ``` ### -Conditions -This parameter is reserved for internal Microsoft use. +The Conditions parameter is used for automatic labeling of files and email for data in use. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -571,7 +647,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -581,19 +657,39 @@ Accept wildcard characters: False ``` ### -ContentType -The ContentType parameter specifies where the sensivity label can be applied. Valid values are: +The ContentType parameter specifies where the sensitivity label can be applied. Valid values are: -- File, Email -- Site, UnifiedGroup +- File +- Email +- Site +- UnifiedGroup - PurviewAssets +- Teamwork +- SchematizedData -Values can be combined, for example: "File, Email, PurviewAssets". Splitting related content types like "File, Email" into just "File" or just "Email" is not supported. +Values can be combined, for example: "File, Email, PurviewAssets". ```yaml Type: MipLabelContentType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultContentLabel +The DefaultContentLabel specifies a label that can be automatically applied to meetings created in a labeled Teams channel. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -609,7 +705,32 @@ The DisplayName parameter specifies the display name for the sensitivity label. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DynamicWatermarkDisplay +**Note**: This parameter is Generally Available only for labels with admin-defined permissions. Support for label with user-defined permissions is currently in Public Preview, isn't available in all organizations, and is subject to change. + +The DynamicWatermarkDisplay parameter specifies the watermark text to display for a given label. This parameter supports text and the following special tokens: + +- **"\`${Consumer.PrincipalName}**": Required. The value is the user principal name (UPN) of the user. +- **"\`${Device.DateTime}**": Optional. The value is current date/time of the device used to view the document. + +**Tip** The back quotation mark character ( \` ) is required as an escape character for the dollar sign character ( $ ) in PowerShell. For more information, see [Escape characters in Exchange PowerShell](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax#escape-characters-in-exchange-powershell). + +This parameter is meaningful only when the ApplyDynamicWatermarkingEnabled parameter value is $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -630,7 +751,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -648,10 +769,10 @@ The EncryptionDoNotForward parameter specifies whether the Do Not Forward templa This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -667,7 +788,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -677,16 +798,16 @@ Accept wildcard characters: False ``` ### -EncryptionEnabled -The EncryptionEnabled parameter specifies whether encryption in enabled. Value values are: +The EncryptionEnabled parameter specifies whether encryption in enabled. Valid values are: - $true: Encryption is enabled. - $false: Encryption is disabled. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -704,10 +825,10 @@ The EncryptionEncryptOnly parameter specifies whether the encrypt-only template This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -722,10 +843,10 @@ The EncryptionOfflineAccessDays parameter specifies the number of days that offl This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -743,10 +864,10 @@ The EncryptionPromptUser parameter specifies whether to set the label with user This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false, and when the EncryptionProtectionType parameter value is UserDefined. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -768,7 +889,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: Microsoft.Office.CompliancePolicy.Tasks.FlattenLabelActionUtils+SupportedProtectionType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -783,10 +904,10 @@ The EncryptionRightsDefinitions parameter specifies the rights users have when a This parameter is meaningful only when the EncryptionEnabled parameter value is either $true or $false and the EncryptionProtectionType parameter value is Template. ```yaml -Type: String +Type: EncryptionRightsDefinitionsParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -804,7 +925,7 @@ This parameter is meaningful only when the EncryptionEnabled parameter value is Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -814,13 +935,13 @@ Accept wildcard characters: False ``` ### -LabelActions -This parameter is reserved for internal Microsoft use. +The LabelActions parameter is used to specify actions that can be performed on labels. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -841,7 +962,7 @@ To remove a language, you need to enter an empty value for that language. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -857,7 +978,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -873,7 +994,7 @@ This parameter is reserved for internal Microsoft use. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -893,7 +1014,7 @@ The ParentId parameter specifies the parent label that you want this label to be Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -909,7 +1030,7 @@ This parameter is reserved for internal Microsoft use. Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -922,10 +1043,26 @@ Accept wildcard characters: False The Priority parameter specifies a priority value for the sensitivity label that determines the order of label processing. A higher integer value indicates a higher priority. ```yaml -Type: Int32 +Type: System.Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SchematizedDataCondition +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -941,7 +1078,7 @@ This parameter is reserved for internal Microsoft use. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -957,7 +1094,7 @@ This parameter is reserved for internal Microsoft use. Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -978,7 +1115,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -999,7 +1136,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1020,7 +1157,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1041,7 +1178,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1062,7 +1199,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1081,7 +1218,23 @@ The SiteAndGroupProtectionEnabled parameter enables or disables the Site and Gro Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteAndGroupProtectionLevel +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SiteAndGroupProtectionLevelParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1102,7 +1255,7 @@ This parameter is meaningful only when the SiteAndGroupProtectionEnabled paramet Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AccessType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1130,7 +1283,7 @@ These correspond to the following settings through the admin center: Type: Microsoft.Office.CompliancePolicy.Tasks.SiteExternalSharingControlType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1139,14 +1292,325 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlAssetCondition -{{ Fill SqlAssetCondition Description }} +### -TeamsAllowedPresenters +The TeamsAllowedPresenters parameter controls who can present in Teams meetings. Valid values are: + +- Everyone +- Organization +- Organizer +- RoleIsPresenter +- $null (blank): Users configure this setting themselves in the Teams app. ```yaml -Type: String +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.AllowedPresenters +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowMeetingChat +The TeamsAllowMeetingChat parameter controls whether chat is available in Teams meetings. Valid values are: + +- Enabled +- Disabled +- Limited: Chat is available only for the duration of the call. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.MeetingChatMode +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch +{{ Fill TeamsAllowPrivateTeamsToBeDiscoverableUsingSearch Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsBypassLobbyForDialInUsers +The TeamsBypassLobbyForDialInUsers parameter controls the lobby experience for dial-in users who join Teams meetings. Valid values are: + +- $true: Dial in users bypass the lobby when joining Teams meetings. +- $false: Dial in users don't bypass the lobby when joining Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelProtectionEnabled +{{ Fill TeamsChannelProtectionEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithExternalTenants +{{ Fill TeamsChannelSharedWithExternalTenants Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithPrivateTeamsOnly +{{ Fill TeamsChannelSharedWithPrivateTeamsOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsChannelSharedWithSameLabelOnly +{{ Fill TeamsChannelSharedWithSameLabelOnly Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsCopyRestrictionEnforced +The TeamsCopyRestrictionEnforced parameter controls whether chat messages in Teams meetings can be copied to the clipboard. Valid values are: + +- $true: Chat messages can be copied to the clipboard. +- $false: Chat messages can't be copied to the clipboard. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsEndToEndEncryptionEnabled +The TeamsEndToEndEncryptionEnabled parameter controls video stream encryption in Teams meetings. Valid values are: + +- $true: Video stream encryption is enabled. +- $false: Video stream encryption is not enabled. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLobbyBypassScope +The TeamsLobbyBypassScope parameter controls who bypasses the lobby when joining Teams meetings. Valid values are: + +- Everyone +- Invited +- Organization +- OrganizationAndFederated +- OrganizationExcludingGuests +- Organizer +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.LobbyBypassScope +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsLobbyRestrictionEnforced +The TeamsLobbyRestrictionEnforced parameter controls whether participants bypass the lobby when joining Teams meetings. Valid values are: + +- $true: Users bypass the lobby when joining Teams meetings. +- $false: Users don't bypass the lobby when joining Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsPresentersRestrictionEnforced +The TeamsPresentersRestrictionEnforced parameter controls whether presenter restrictions are enabled in Teams meetings. Valid values are: + +- $true: Presenter restrictions are enabled in Teams meetings. +- $false: Presenter restrictions aren't enabled in Teams meetings. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsProtectionEnabled +The TeamsProtectionEnabled parameter controls whether Teams protection is enabled in Teams meetings. Valid values are: + +- $true: Teams protection is enabled in Teams meetings. +- $false: Teams protection is not enabled in Teams meetings. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsRecordAutomatically +The TeamsRecordAutomatically parameter controls whether Teams meetings are automatically recorded after they start. Valid values are: + +- $true: Teams meetings are automatically recorded after they start. +- $false: Teams meetings are not automatically recorded. +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsVideoWatermark +The TeamsVideoWatermark parameter controls whether a watermark is shown in Teams meetings. Valid values are: + +- None +- EnabledForContentSharing +- EnabledForVideo +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WaterMarkProtectionValues +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TeamsWhoCanRecord +The TeamsWhoCanRecord parameter controls who can record Teams meetings. Valid values are: + +- Organizer +- Coorganizers +- Presenters +- $null (blank): Users configure this setting themselves in the Teams app. + +```yaml +Type: Microsoft.Office.CompliancePolicy.PolicyConfiguration.WhoCanRecordOptions +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -1162,7 +1626,7 @@ The ToolTip parameter specifies the default tooltip and sensitivity label descri Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1172,13 +1636,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -1192,13 +1656,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[New-Label](New-Label.md) + +[New-Label](https://learn.microsoft.com/powershell/module/exchange/new-label) diff --git a/exchange/exchange-ps/exchange/Set-LabelPolicy.md b/exchange/exchange-ps/exchange/Set-LabelPolicy.md index 3b6ca4a8f0..5b190d2637 100644 --- a/exchange/exchange-ps/exchange/Set-LabelPolicy.md +++ b/exchange/exchange-ps/exchange/Set-LabelPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-labelpolicy -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-labelpolicy +applicable: Security & Compliance title: Set-LabelPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-LabelPolicy ## SYNOPSIS -This cmdlet is available or functional only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is functional only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-Label cmdlet to modify sensitivity label policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -53,6 +53,7 @@ Set-LabelPolicy [-Identity] [-Confirm] [-MigrationId ] [-NextLabelPolicy ] + [-PolicyRBACScopes ] [-RemoveExchangeLocation ] [-RemoveExchangeLocationException ] [-RemoveLabels ] @@ -87,7 +88,9 @@ Set-LabelPolicy [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-LabelPolicy -Identity "Global Policy" -RemoveExchangeLocation $_ }`. ## EXAMPLES @@ -111,7 +114,7 @@ The Identity parameter specifies the policy that you want to view. You can use a Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -121,7 +124,7 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. You don't need to specify a value with this switch. +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online locations. You don't need to specify a value with this switch. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. @@ -131,7 +134,7 @@ Locations whose initial distributions succeeded aren't included in the retry. Po Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -156,7 +159,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -181,7 +184,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -203,7 +206,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -221,7 +224,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -237,7 +240,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -247,13 +250,13 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -263,13 +266,13 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -279,13 +282,13 @@ Accept wildcard characters: False ``` ### -AddPublicFolderLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -295,13 +298,13 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -311,13 +314,13 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -327,13 +330,13 @@ Accept wildcard characters: False ``` ### -AddSkypeLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -343,13 +346,13 @@ Accept wildcard characters: False ``` ### -AddSkypeLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -361,28 +364,41 @@ Accept wildcard characters: False ### -AdvancedSettings The AdvancedSettings parameter enables client-specific features and capabilities for the sensitivity label policy. -Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. +Specify this parameter with the identity (name or GUID) of the policy, with key/value pairs in a [hash table](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_hash_tables). To remove an advanced setting, use the same AdvancedSettings parameter syntax, but specify a null string value. -Most of the settings that you configure with this parameter are supported only by the Azure Information Protection unified labeling client and not by Office apps that support built-in labeling. For instructions, see [Custom configurations for the Azure Information Protection unified labeling client](https://docs.microsoft.com/azure/information-protection/rms-client/clientv2-admin-guide-customizations). +Some of the settings that you configure with this parameter are supported only by the Microsoft Purview Information Protection client and not by Office apps and services that support built-in labeling. For a list of these, see [Advanced settings for Microsoft Purview Information Protection client](https://learn.microsoft.com/powershell/exchange/client-advanced-settings). Supported settings for built-in labeling: -- **OutlookDefaultLabel**: Outlook apps that support this setting apply a default label, or no label. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{OutlookDefaultLabel="None"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). +- **AttachmentAction**: Unlabeled emails inherit the highest priority label from file attachments. Set the value to **Automatic** (to automatically apply the label) or **Recommended** (as a recommended prompt to the user. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{AttachmentAction="Automatic"}`. For more information about this configuration choice, see [Configure label inheritance from email attachments](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#configure-label-inheritance-from-email-attachments). -- **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: ` Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). +- **EnableAudit**: Prevent Office apps from sending sensitivity label data to Microsoft 365 auditing solutions. Supported apps: Word, Excel, and PowerPoint on Windows (version 2201+), macOS (version 16.57+), iOS (version 2.57+), and Android (version 16.0.14827+); Outlook on Windows (version 2201+), Outlook on the web, and rolling out to macOS, iOS, and Android. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableAudit="False"}`. -Additionally, for Power BI: +- **EnableRevokeGuiSupport**: Remove the Track & Revoke button from the sensitivity menu in Office clients. Supported apps: Word, Excel, and PowerPoint on Windows (version 2406+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{EnableRevokeGuiSupport="False"}`. For more information about this configuration choice, see [Track and revoke document access](https://learn.microsoft.com/purview/track-and-revoke-admin). + +- **DisableMandatoryInOutlook**: Outlook apps that support this setting exempt Outlook messages from mandatory labeling. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableMandatoryInOutlook="True"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). + +- **OutlookDefaultLabel**: Outlook apps that support this setting apply a default label, or no label. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{OutlookDefaultLabel="None"}`. For more information about this configuration choice, see [Outlook-specific options for default label and mandatory labeling](https://learn.microsoft.com/purview/sensitivity-labels-office-apps#outlook-specific-options-for-default-label-and-mandatory-labeling). -- **powerbimandatory**: Mandatory labeling for Power BI. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{powerbimandatory="true"}`. For more information about this configuration choice, see [Mandatory label policy for Power BI](https://docs.microsoft.com/power-bi/admin/service-security-sensitivity-label-mandatory-label-policy). +- **TeamworkMandatory**: Outlook and Teams apps that support this setting can enable or disable mandatory labeling for meetings. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{TeamworkMandatory="True"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). -- **powerbidefaultlabelid**: Default label for Power BI content. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{powerbidefaultlabelid="General"}`. For more information about this configuration choice, see [Default label policy for Power BI](https://docs.microsoft.com/power-bi/admin/service-security-sensitivity-label-default-label-policy). +- **teamworkdefaultlabelid**: Outlook and Teams apps that support this setting apply a default label, or no label for meetings. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{teamworkdefaultlabelid="General"}`. For more information about labeling meetings, see [Use sensitivity labels to protect calendar items, Teams meetings, and chat](https://learn.microsoft.com/purview/sensitivity-labels-meetings). +- **HideBarByDefault**: For Office apps that support the sensitivity bar, don't display the sensitivity label name on the window bar title so that there's more space to display long file names. Just the label icon and color (if configured) will be displayed. Users can't revert this setting in the app. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{HideBarByDefault="True"}` + +- **DisableShowSensitiveContent**: For Office apps that highlight the sensitive content that caused a label to be recommended, turn off these highlights and corresponding indications about the sensitive content. For more information, see [Sensitivity labels are automatically applied or recommended for your files and emails in Office](https://support.microsoft.com/office/sensitivity-labels-are-automatically-applied-or-recommended-for-your-files-and-emails-in-office-622e0d9c-f38c-470a-bcdb-9e90b24d71a1). Supported apps: Word for Windows (version 2311+). Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{DisableShowSensitiveContent="True"}` + +Additionally, for Power BI: + +- **powerbimandatory**: Mandatory labeling for Power BI. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{powerbimandatory="true"}`. For more information about this configuration choice, see [Mandatory label policy for Power BI](https://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-mandatory-label-policy). + +- **powerbidefaultlabelid**: Default label for Power BI content. Example: `Set-LabelPolicy -Identity Global -AdvancedSettings @{powerbidefaultlabelid="General"}`. For more information about this configuration choice, see [Default label policy for Power BI](https://learn.microsoft.com/power-bi/admin/service-security-sensitivity-label-default-label-policy). ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -398,7 +414,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity, AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -417,7 +433,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -427,13 +443,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: AdaptiveScopeLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -443,13 +461,13 @@ Accept wildcard characters: False ``` ### -MigrationId -{{ Fill MigrationId Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -459,13 +477,35 @@ Accept wildcard characters: False ``` ### -NextLabelPolicy -This parameter is reserved for internal Microsoft use. +The NextLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is after the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. + +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -475,13 +515,17 @@ Accept wildcard characters: False ``` ### -PreviousLabelPolicy -This parameter is reserved for internal Microsoft use. +The PreviousLabelPolicy parameter updates the policy order so the policy that's specified by this parameter is before the current policy that you're modifying. You can use any value that uniquely identifies the policy. For example: + +- Name +- Distinguished name (DN) +- GUID ```yaml Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -509,7 +553,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -537,7 +581,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -559,7 +603,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -577,7 +621,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -593,7 +637,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -603,13 +647,13 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -619,13 +663,13 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -635,13 +679,13 @@ Accept wildcard characters: False ``` ### -RemovePublicFolderLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -651,13 +695,13 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -667,13 +711,13 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -683,13 +727,13 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocation -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -699,13 +743,13 @@ Accept wildcard characters: False ``` ### -RemoveSkypeLocationException -PARAMVALUE: MultiValuedProperty +This parameter is reserved for internal Microsoft use. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -715,13 +759,13 @@ Accept wildcard characters: False ``` ### -Setting -{{ Fill Setting Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -731,13 +775,13 @@ Accept wildcard characters: False ``` ### -Settings -PARAMVALUE: PswsHashtable +This parameter is reserved for internal Microsoft use. ```yaml Type: PswsHashtable Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -747,13 +791,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -767,12 +811,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-LinkedUser.md b/exchange/exchange-ps/exchange/Set-LinkedUser.md index 561876f1e3..ab7afd569b 100644 --- a/exchange/exchange-ps/exchange/Set-LinkedUser.md +++ b/exchange/exchange-ps/exchange/Set-LinkedUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-linkeduser +online version: https://learn.microsoft.com/powershell/module/exchange/set-linkeduser applicable: Exchange Online, Exchange Online Protection title: Set-LinkedUser schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-LinkedUser cmdlet to modify the properties of an existing linked user account. The Outlook Live Directory Sync (OLSync) service account is a linked user. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +31,7 @@ Set-LinkedUser [-Identity] ## DESCRIPTION The OLSync service account is the only linked user in your organization. By default, the account is named GALSync-ServiceAccount. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -121,12 +119,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md index 5de20a98b0..db10ad8518 100644 --- a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection title: Set-M365DataAtRestEncryptionPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-M365DataAtRestEncryptionPolicy cmdlet to modify Microsoft 365 data-at-rest encryption policies in Exchange Online. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +45,7 @@ Set-M365DataAtRestEncryptionPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -158,7 +156,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -226,12 +226,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md index 0f7966bcbc..d5a82bfdda 100644 --- a/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md +++ b/exchange/exchange-ps/exchange/Set-M365DataAtRestEncryptionPolicyAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicyassignment +online version: https://learn.microsoft.com/powershell/module/exchange/set-m365dataatrestencryptionpolicyassignment applicable: Exchange Online title: Set-M365DataAtRestEncryptionPolicyAssignment schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-M365DataAtRestEncryptionPolicyAssignment cmdlet to assign a Microsoft 365 data-at-rest encryption policy at the tenant level. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,7 +25,7 @@ Set-M365DataAtRestEncryptionPolicyAssignment -DataEncryptionPolicy [-UMDtmfMap ] [-UseMapiRichTextFormat ] [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] [-WhatIf] [-WindowsEmailAddress ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -117,7 +119,7 @@ The Identity parameter specifies the mail contact that you want to modify. You c Type: MailContactIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -150,7 +152,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -183,7 +185,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -218,7 +220,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -228,15 +230,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -247,7 +254,7 @@ The Alias parameter never generates or updates the primary email address of a ma Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -307,7 +314,7 @@ This parameter is meaningful only when moderation is enabled for the recipient. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -326,7 +333,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -363,7 +370,7 @@ This parameter specifies a value for the CustomAttribute1 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -379,7 +386,7 @@ This parameter specifies a value for the CustomAttribute10 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -395,7 +402,7 @@ This parameter specifies a value for the CustomAttribute11 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -411,7 +418,7 @@ This parameter specifies a value for the CustomAttribute12 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -427,7 +434,7 @@ This parameter specifies a value for the CustomAttribute13 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -443,7 +450,7 @@ This parameter specifies a value for the CustomAttribute14 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -459,7 +466,7 @@ This parameter specifies a value for the CustomAttribute15 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -475,7 +482,7 @@ This parameter specifies a value for the CustomAttribute2 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -491,7 +498,7 @@ This parameter specifies a value for the CustomAttribute3 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -507,7 +514,7 @@ This parameter specifies a value for the CustomAttribute4 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -523,7 +530,7 @@ This parameter specifies a value for the CustomAttribute5 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -539,7 +546,7 @@ This parameter specifies a value for the CustomAttribute6 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -555,7 +562,7 @@ This parameter specifies a value for the CustomAttribute7 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -571,7 +578,7 @@ This parameter specifies a value for the CustomAttribute8 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -587,7 +594,7 @@ This parameter specifies a value for the CustomAttribute9 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -603,7 +610,7 @@ The DisplayName parameter specifies the display name of the mail contact. The di Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -631,16 +638,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -658,7 +665,7 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -701,7 +708,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute1 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -723,7 +730,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute2 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -745,7 +752,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute3 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -767,7 +774,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute4 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -789,7 +796,7 @@ Although this is a multivalued property, the filter `"ExtensionCustomAttribute5 Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -809,7 +816,7 @@ When you use the ExternalEmailAddress parameter to change the external email add Type: ProxyAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -819,13 +826,13 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -860,7 +867,7 @@ By default, this parameter is blank, which means no one else has permission to s Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -879,7 +886,7 @@ The HiddenFromAddressListsEnabled parameter specifies whether this recipient is Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -891,9 +898,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -928,7 +935,7 @@ The MacAttachmentFormat and MessageFormat parameters are interdependent: Type: MacAttachmentFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -949,7 +956,7 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -973,7 +980,7 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1086,7 +1093,7 @@ The MessageFormat and MessageBodyFormat parameters are interdependent: Type: MessageBodyFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1112,7 +1119,7 @@ Therefore, if you want to change the MessageFormat parameter from Mime to Text, Type: MessageFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1141,7 +1148,7 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1162,7 +1169,7 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1178,7 +1185,7 @@ The Name parameter specifies the unique name of the mail contact. The maximum le Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1194,7 +1201,7 @@ The PrimarySmtpAddress parameter specifies the primary return email address that By default, the primary address is the same as the ExternalEmailAddress parameter value. -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, which means the email addresses of the mail contact aren't automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario. +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mail contact aren't automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. @@ -1235,7 +1242,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1268,7 +1275,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1303,7 +1310,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1315,7 +1322,7 @@ Accept wildcard characters: False ### -RemovePicture This parameter is available only in on-premises Exchange. -The RemovePicture switch specifies whether to remove the picture from the mail contact. You don't need to specify a value with this switch. +The RemovePicture switch removes the picture from the mail contact. You don't need to specify a value with this switch. You can add a picture to a mail contact by using the Import-RecipientDataProperty cmdlet. @@ -1335,7 +1342,7 @@ Accept wildcard characters: False ### -RemoveSpokenName This parameter is available only in on-premises Exchange. -The RemoveSpokenName parameter specifies whether to remove the spoken name from the mail contact. You don't need to specify a value with this switch. +The RemoveSpokenName switch removes the spoken name from the mail contact. You don't need to specify a value with this switch. You can add a sound file to a mail contact by using the Import-RecipientDataProperty cmdlet. @@ -1362,7 +1369,7 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1372,13 +1379,15 @@ Accept wildcard characters: False ``` ### -SecondaryAddress +This parameter is available only in on-premises Exchange. + The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled mail contact. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -1418,7 +1427,7 @@ This parameter is only meaningful when moderation is enabled (the ModerationEnab Type: TransportModerationNotificationFlags Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1440,7 +1449,7 @@ The SimpleDisplayName parameter is used to display an alternative description of Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1492,7 +1501,7 @@ The default value is UseDefaultSettings. Type: UseMapiRichTextFormat Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1511,7 +1520,43 @@ The UsePreferMessageFormat specifies whether the message format settings configu Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCertificate +This parameter is available only in the cloud-based service. + +The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSMimeCertificate +This parameter is available only in the cloud-based service. + +The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1527,7 +1572,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1548,7 +1593,7 @@ The WindowsEmailAddress property is visible for the recipient in Active Director Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1562,12 +1607,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md index e60afbb9ac..8dd27b3503 100644 --- a/exchange/exchange-ps/exchange/Set-MailPublicFolder.md +++ b/exchange/exchange-ps/exchange/Set-MailPublicFolder.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailpublicfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailpublicfolder +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailPublicFolder schema: 2.0.0 author: chrisda @@ -18,7 +18,7 @@ Use the Set-MailPublicFolder cmdlet to configure the mail-related settings of ma NOTE: The settings that you configure on a public folder mailbox might interfere with the existing settings on a public folder within in the mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -90,7 +90,7 @@ Set-MailPublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -128,7 +128,7 @@ You can omit the parameter label so that only the public folder name or GUID is Type: MailPublicFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -239,15 +239,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -337,7 +342,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -685,16 +690,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -967,9 +972,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -1210,7 +1215,7 @@ Accept wildcard characters: False ### -PrimarySmtpAddress The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the public folder are no longer automatically updated by email address policies. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. @@ -1436,7 +1441,7 @@ Accept wildcard characters: False ``` ### -UMDtmfMap -This parameter is available only in Exchange 2010. +This parameter is available only in Exchange Server 2010. The UMDtmfMap parameter specifies if you want to create a user-defined DTMF map for the UM-enabled user. @@ -1460,7 +1465,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1495,12 +1500,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailUser.md b/exchange/exchange-ps/exchange/Set-MailUser.md index 8e1f80c1eb..45d451af6c 100644 --- a/exchange/exchange-ps/exchange/Set-MailUser.md +++ b/exchange/exchange-ps/exchange/Set-MailUser.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailuser +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailuser applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailUser schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailUser cmdlet to modify mail users. Mail users (also known as mail-enabled users) have email addresses and accounts in the Exchange organization, but they don't have Exchange mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -103,7 +103,7 @@ Set-MailUser [-Identity] ### EnableLitigationHoldForMigration ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-EnableLitigationHoldForMigration] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -130,7 +130,6 @@ Set-MailUser [-Identity] [-DataEncryptionPolicy ] [-DisplayName ] [-EmailAddresses ] - [-EnableLitigationHoldForMigration] [-ExchangeGuid ] [-ExtensionCustomAttribute1 ] [-ExtensionCustomAttribute2 ] @@ -142,8 +141,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailTip ] [-MailTipTranslations ] @@ -179,7 +180,7 @@ Set-MailUser [-Identity] ### ExcludeFromAllOrgHolds ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-ExcludeFromAllOrgHolds] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -207,7 +208,6 @@ Set-MailUser [-Identity] [-DisplayName ] [-EmailAddresses ] [-ExchangeGuid ] - [-ExcludeFromAllOrgHolds] [-ExtensionCustomAttribute1 ] [-ExtensionCustomAttribute2 ] [-ExtensionCustomAttribute3 ] @@ -218,7 +218,9 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] + [-LOBAppAccount] [-JournalArchiveAddress ] [-MacAttachmentFormat ] [-MailTip ] @@ -255,7 +257,7 @@ Set-MailUser [-Identity] ### ExcludeFromOrgHolds ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-ExcludeFromOrgHolds ] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -283,7 +285,6 @@ Set-MailUser [-Identity] [-DisplayName ] [-EmailAddresses ] [-ExchangeGuid ] - [-ExcludeFromOrgHolds ] [-ExtensionCustomAttribute1 ] [-ExtensionCustomAttribute2 ] [-ExtensionCustomAttribute3 ] @@ -294,8 +295,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailboxRegion ] [-MailTip ] @@ -331,7 +334,7 @@ Set-MailUser [-Identity] ### RecalculateInactiveMailUser ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-RecalculateInactiveMailUser] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -369,8 +372,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailboxRegion ] [-MailTip ] @@ -383,7 +388,6 @@ Set-MailUser [-Identity] [-Name ] [-Password ] [-PrimarySmtpAddress ] - [-RecalculateInactiveMailUser] [-RecipientLimits ] [-RejectMessagesFrom ] [-RejectMessagesFromDLMembers ] @@ -407,7 +411,7 @@ Set-MailUser [-Identity] ### RemoveComplianceTagHoldApplied ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-RemoveComplianceTagHoldApplied] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -445,8 +449,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailboxRegion ] [-MailTip ] @@ -463,7 +469,6 @@ Set-MailUser [-Identity] [-RejectMessagesFrom ] [-RejectMessagesFromDLMembers ] [-RejectMessagesFromSendersOrMembers ] - [-RemoveComplianceTagHoldApplied] [-RemoveMailboxProvisioningConstraint] [-RequireSenderAuthenticationEnabled ] [-ResetPasswordOnNextLogon ] @@ -483,7 +488,7 @@ Set-MailUser [-Identity] ### RemoveDelayHoldApplied ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-RemoveDelayHoldApplied] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -521,8 +526,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailTip ] [-MailTipTranslations ] @@ -539,7 +546,6 @@ Set-MailUser [-Identity] [-RejectMessagesFrom ] [-RejectMessagesFromDLMembers ] [-RejectMessagesFromSendersOrMembers ] - [-RemoveDelayHoldApplied] [-RemoveMailboxProvisioningConstraint] [-RequireSenderAuthenticationEnabled ] [-ResetPasswordOnNextLogon ] @@ -559,7 +565,7 @@ Set-MailUser [-Identity] ### RemoveDelayReleaseHoldApplied ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-RemoveDelayReleaseHoldApplied] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -597,8 +603,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailTip ] [-MailTipTranslations ] @@ -615,7 +623,6 @@ Set-MailUser [-Identity] [-RejectMessagesFrom ] [-RejectMessagesFromDLMembers ] [-RejectMessagesFromSendersOrMembers ] - [-RemoveDelayReleaseHoldApplied] [-RemoveMailboxProvisioningConstraint] [-RequireSenderAuthenticationEnabled ] [-ResetPasswordOnNextLogon ] @@ -633,9 +640,83 @@ Set-MailUser [-Identity] [] ``` +### RemoveDisabledArchive +``` +Set-MailUser [-Identity] [-RemoveDisabledArchive] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HiddenFromAddressListsEnabled ] + [-HVEAccount] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailboxRegion ] + [-MailTip ] + [-MailTipTranslations ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SecondaryAddress ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + ### RemoveLitigationHoldEnabled ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-RemoveLitigationHoldEnabled] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -673,8 +754,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailTip ] [-MailTipTranslations ] @@ -691,7 +774,6 @@ Set-MailUser [-Identity] [-RejectMessagesFrom ] [-RejectMessagesFromDLMembers ] [-RejectMessagesFromSendersOrMembers ] - [-RemoveLitigationHoldEnabled] [-RemoveMailboxProvisioningConstraint] [-RequireSenderAuthenticationEnabled ] [-ResetPasswordOnNextLogon ] @@ -711,7 +793,7 @@ Set-MailUser [-Identity] ### RemoveOrphanedHolds ``` -Set-MailUser [-Identity] +Set-MailUser [-Identity] [-RemoveOrphanedHolds ] [-AcceptMessagesOnlyFrom ] [-AcceptMessagesOnlyFromDLMembers ] [-AcceptMessagesOnlyFromSendersOrMembers ] @@ -749,8 +831,10 @@ Set-MailUser [-Identity] [-ForceUpgrade] [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] + [-HVEAccount] [-ImmutableId ] [-JournalArchiveAddress ] + [-LOBAppAccount] [-MacAttachmentFormat ] [-MailTip ] [-MailTipTranslations ] @@ -768,7 +852,6 @@ Set-MailUser [-Identity] [-RejectMessagesFromDLMembers ] [-RejectMessagesFromSendersOrMembers ] [-RemoveMailboxProvisioningConstraint] - [-RemoveOrphanedHolds ] [-RequireSenderAuthenticationEnabled ] [-ResetPasswordOnNextLogon ] [-SecondaryAddress ] @@ -785,8 +868,83 @@ Set-MailUser [-Identity] [] ``` +### UnblockForwardSyncPostCrossTenantMigration +``` +Set-MailUser [-Identity] [-UnblockForwardSyncPostCrossTenantMigration] + [-AcceptMessagesOnlyFrom ] + [-AcceptMessagesOnlyFromDLMembers ] + [-AcceptMessagesOnlyFromSendersOrMembers ] + [-Alias ] + [-ArchiveGuid ] + [-BypassModerationFromSendersOrMembers ] + [-Confirm] + [-CustomAttribute1 ] + [-CustomAttribute10 ] + [-CustomAttribute11 ] + [-CustomAttribute12 ] + [-CustomAttribute13 ] + [-CustomAttribute14 ] + [-CustomAttribute15 ] + [-CustomAttribute2 ] + [-CustomAttribute3 ] + [-CustomAttribute4 ] + [-CustomAttribute5 ] + [-CustomAttribute6 ] + [-CustomAttribute7 ] + [-CustomAttribute8 ] + [-CustomAttribute9 ] + [-DataEncryptionPolicy ] + [-DisplayName ] + [-EmailAddresses ] + [-ExchangeGuid ] + [-ExtensionCustomAttribute1 ] + [-ExtensionCustomAttribute2 ] + [-ExtensionCustomAttribute3 ] + [-ExtensionCustomAttribute4 ] + [-ExtensionCustomAttribute5 ] + [-ExternalEmailAddress ] + [-FederatedIdentity ] + [-ForceUpgrade] + [-GrantSendOnBehalfTo ] + [-HVEAccount] + [-HiddenFromAddressListsEnabled ] + [-ImmutableId ] + [-JournalArchiveAddress ] + [-LOBAppAccount] + [-MacAttachmentFormat ] + [-MailTip ] + [-MailTipTranslations ] + [-MailboxRegion ] + [-MaxReceiveSize ] + [-MaxSendSize ] + [-MessageBodyFormat ] + [-MessageFormat ] + [-MicrosoftOnlineServicesID ] + [-ModeratedBy ] + [-ModerationEnabled ] + [-Name ] + [-Password ] + [-PrimarySmtpAddress ] + [-RecipientLimits ] + [-RejectMessagesFrom ] + [-RejectMessagesFromDLMembers ] + [-RejectMessagesFromSendersOrMembers ] + [-RemoveMailboxProvisioningConstraint] + [-RequireSenderAuthenticationEnabled ] + [-ResetPasswordOnNextLogon ] + [-SendModerationNotifications ] + [-SimpleDisplayName ] + [-UseMapiRichTextFormat ] + [-UsePreferMessageFormat ] + [-UserCertificate ] + [-UserSMimeCertificate ] + [-WhatIf] + [-WindowsEmailAddress ] + [] +``` + ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -924,15 +1082,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -988,7 +1151,7 @@ This parameter is reserved for internal Microsoft use. Type: Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1339,7 +1502,7 @@ You can use the Get-DataEncryptionPolicy cmdlet to view the available policies. ```yaml Type: DataEncryptionPolicyIdParameter -Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveLitigationHoldEnabled, RemoveOrphanedHolds +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: Applicable: Exchange Online @@ -1385,16 +1548,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -1445,13 +1608,15 @@ Accept wildcard characters: False ### -EnableLitigationHoldForMigration This parameter is available only in the cloud-based service. -{{ Fill EnableLitigationHoldForMigration Description }} +The EnableLitigationHoldForMigration switch is used in cross-tenant mailbox migrations to increase the quota on the Recoverable Items folder to 100 GB (and also enable Litigation Hold) prior to migration. You don't need to specify a value with this switch. + +This feature is not available in hybrid tenants. ```yaml Type: SwitchParameter Parameter Sets: EnableLitigationHoldForMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -1479,13 +1644,19 @@ Accept wildcard characters: False ### -ExcludeFromAllOrgHolds This parameter is available only in the cloud-based service. -{{ Fill ExcludeFromAllOrgHolds Description }} +The ExcludeFromAllOrgHolds switch specifies whether to exclude the soft-deleted mail user from all organization-wide Microsoft 365 retention policies. You don't need to specify a value with this switch. + +When you use this switch, use one of the following values to uniquely identify the soft-deleted mail user in the Identity parameter: + +- DistinguishedName +- Guid +- ExchangeGuid ```yaml Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1503,7 +1674,7 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: ExcludeFromOrgHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1661,7 +1832,7 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -1730,12 +1901,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HVEAccount +This parameter is available only in the cloud-based service. + +The HVEAccount switch specifies that this mail user account is specifically used for the [High volume email service](https://learn.microsoft.com/exchange/mail-flow-best-practices/high-volume-mails-m365). You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Position: Named +Default value: None +Required: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -1778,9 +1967,27 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SmtpAddress -Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveLitigationHoldEnabled, RemoveOrphanedHolds +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LOBAppAccount +This parameter is available only in the cloud-based service. + +{{ Fill LOBAppAccount Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1822,7 +2029,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: String -Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveLitigationHoldEnabled, RemoveOrphanedHolds +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -1879,8 +2086,6 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize -This parameter is available only in on-premises Exchange. - The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail user. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -1900,7 +2105,7 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1910,8 +2115,6 @@ Accept wildcard characters: False ``` ### -MaxSendSize -This parameter is available only in on-premises Exchange. - The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail user. When you enter a value, qualify the value with one of the following units: @@ -1931,7 +2134,7 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: Default Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -1998,7 +2201,7 @@ The MicrosoftOnlineServicesID parameter specifies the user ID for the object. Th ```yaml Type: SmtpAddress -Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveLitigationHoldEnabled, RemoveOrphanedHolds +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: Applicable: Exchange Online, Exchange Online Protection @@ -2078,11 +2281,13 @@ Accept wildcard characters: False ### -Password This parameter is available only in the cloud-based service. -The Password parameter allows users to change their own password. +The Password parameter allows users to change their own password. You can use the following methods as a value for this parameter: -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. -You can't use this parameter to change another user's password (the parameter is available only via the MyBaseOptions user role). To change another user's password, use the NewPassword parameter on the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see [Connect to Office 365 PowerShell](https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). +You can't use this parameter to change another user's password (the parameter is available only via the MyBaseOptions user role). To change another user's password, use the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: SecureString @@ -2098,13 +2303,13 @@ Accept wildcard characters: False ``` ### -PrimarySmtpAddress -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. By default, the primary address is the same as the ExternalEmailAddress parameter value. -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user are no longer automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario. +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mail user are no longer automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. @@ -2112,7 +2317,7 @@ The PrimarySmtpAddress parameter updates the primary email address and WindowsEm Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2130,7 +2335,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailUser Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2140,7 +2345,7 @@ Accept wildcard characters: False ``` ### -RecipientLimits -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mail user. @@ -2335,7 +2540,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveComplianceTagHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2353,7 +2558,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDelayHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2371,7 +2576,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RemoveDelayReleaseHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -2380,36 +2585,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoveLitigationHoldEnabled +### -RemoveDisabledArchive This parameter is available only in the cloud-based service. -{{ Fill RemoveLitigationHoldEnabled Description }} +The RemoveDisabledArchive switch specifies whether to remove the disabled archive that's associated with the mail user. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter -Parameter Sets: RemoveLitigationHoldEnabled +Parameter Sets: RemoveDisabledArchive Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoveMailboxProvisioningConstraint +### -RemoveLitigationHoldEnabled This parameter is available only in the cloud-based service. -{{ Fill RemoveMailboxProvisioningConstraint Description }} +The RemoveLitigationHoldEnabled switch specifies whether to remove litigation hold from all mailbox locations of a mail user, including online archive, in an Exchange hybrid environment. You don't need to specify a value with this switch. + +This switch is useful in scenarios where admins can't permanently delete mail users due to litigation holds on the mail users. For more information on litigation hold, see [Create a Litigation hold](https://learn.microsoft.com/en-us/purview/ediscovery-create-a-litigation-hold). ```yaml Type: SwitchParameter -Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveLitigationHoldEnabled, RemoveOrphanedHolds +Parameter Sets: RemoveLitigationHoldEnabled Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -2419,15 +2626,13 @@ Accept wildcard characters: False ### -RemoveMailboxProvisioningConstraint This parameter is available only in the cloud-based service. -The RemoveMailboxProvisioningConstraint switch removes the mailbox provisioning constraint from the user. You don't need to specify a value with this switch. - -You should use this switch when the provisioning constraint is no longer needed, or if it's preventing the mailbox from being moved. +{{ Fill RemoveMailboxProvisioningConstraint Description }} ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: EnableLitigationHoldForMigration, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailUser, RemoveComplianceTagHoldApplied, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveLitigationHoldEnabled, RemoveOrphanedHolds, UnblockForwardSyncPostCrossTenantMigration Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2445,7 +2650,7 @@ This parameter is available only in the cloud-based service. Type: String[] Parameter Sets: RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2457,7 +2662,7 @@ Accept wildcard characters: False ### -RemovePicture This parameter is available only in on-premises Exchange. -The RemovePicture switch specifies whether to remove the picture from the mail user. You don't need to specify a value with this switch. +The RemovePicture switch removes the picture from the mail user. You don't need to specify a value with this switch. You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet. @@ -2477,7 +2682,7 @@ Accept wildcard characters: False ### -RemoveSpokenName This parameter is available only in on-premises Exchange. -The RemoveSpokenName parameter specifies whether to remove the spoken name from the mail user. You don't need to specify a value with this switch. +The RemoveSpokenName switch removes the spoken name from the mail user. You don't need to specify a value with this switch. You can add a sound file to a mail user by using the Import-RecipientDataProperty cmdlet. @@ -2521,7 +2726,7 @@ The ResetPasswordOnNextLogon parameter allows users to require themselves to cha - $true: The user is required to change their password then next time they successfully log on. - $false: The user isn't required to change their password then next time they successfully log on. This is the default value. -You can't use this parameter to require another user to change their password (the parameter is available only via the MyBaseOptions user role). You need to use the ForceChangePassword parameter on the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see [Connect to Office 365 PowerShell](https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). +You can't use this parameter to require another user to change their password (the parameter is available only via the MyBaseOptions user role). You need to use the ForceChangePasswordNextSignIn value in the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: Boolean @@ -2555,13 +2760,15 @@ Accept wildcard characters: False ``` ### -SecondaryAddress +This parameter is available only in on-premises Exchange. + The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Online Protection Required: False Position: Named @@ -2669,7 +2876,7 @@ If you use this syntax, you don't need to specify all of the DTMF map values, an ```yaml Type: MultiValuedProperty -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -2680,6 +2887,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UnblockForwardSyncPostCrossTenantMigration +This parameter is available only in the cloud-based service. + +{{ Fill UnblockForwardSyncPostCrossTenantMigration Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: UnblockForwardSyncPostCrossTenantMigration +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UseMapiRichTextFormat The UseMapiRichTextFormat parameter specifies what to do with messages that are sent to the mail user or mail contact in MAPI rich text format, also known as Outlook Rich Text or Transport Neutral Encapsulation Format (TNEF). Valid values are: @@ -2722,7 +2947,7 @@ Accept wildcard characters: False ``` ### -UserCertificate -This parameter is reserved for internal Microsoft use. +The UserCertificate parameter specifies the digital certificate used to sign a user's email messages. ```yaml Type: MultiValuedProperty @@ -2756,7 +2981,7 @@ Accept wildcard characters: False ``` ### -UserSMimeCertificate -This parameter is reserved for internal Microsoft use. +The UserSMimeCertificate parameter specifies the S/MIME certificate that's used to sign a user's email messages. ```yaml Type: MultiValuedProperty @@ -2813,12 +3038,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-Mailbox.md b/exchange/exchange-ps/exchange/Set-Mailbox.md index 5a6ce9ae9a..f24e40f01c 100644 --- a/exchange/exchange-ps/exchange/Set-Mailbox.md +++ b/exchange/exchange-ps/exchange/Set-Mailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailbox -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailbox +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-Mailbox schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-Mailbox cmdlet to modify the settings of existing mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -228,6 +228,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -251,6 +252,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -286,7 +288,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTracking ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] @@ -316,6 +317,7 @@ Set-Mailbox [-Identity] [-RoleAssignmentPolicy ] [-RoomMailboxPassword ] [-RulesQuota ] + [-SchedulerAssistant ] [-SecondaryAddress ] [-SecondaryDialPlan ] [-SendModerationNotifications ] @@ -357,6 +359,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -380,6 +383,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -415,7 +419,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTracking ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] @@ -445,6 +448,7 @@ Set-Mailbox [-Identity] [-RoleAssignmentPolicy ] [-RoomMailboxPassword ] [-RulesQuota ] + [-SchedulerAssistant ] [-SecondaryAddress ] [-SecondaryDialPlan ] [-SendModerationNotifications ] @@ -486,6 +490,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -509,6 +514,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -544,7 +550,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTracking ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] @@ -574,6 +579,7 @@ Set-Mailbox [-Identity] [-RoleAssignmentPolicy ] [-RoomMailboxPassword ] [-RulesQuota ] + [-SchedulerAssistant ] [-SecondaryAddress ] [-SecondaryDialPlan ] [-SendModerationNotifications ] @@ -615,6 +621,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -638,6 +645,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -673,7 +681,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTracking ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] @@ -703,6 +710,7 @@ Set-Mailbox [-Identity] [-RoleAssignmentPolicy ] [-RoomMailboxPassword ] [-RulesQuota ] + [-SchedulerAssistant ] [-SecondaryAddress ] [-SecondaryDialPlan ] [-SendModerationNotifications ] @@ -743,6 +751,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-CreateDTMFMap ] [-CustomAttribute1 ] [-CustomAttribute10 ] @@ -765,6 +774,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -800,7 +810,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] [-ModeratedBy ] @@ -829,6 +838,7 @@ Set-Mailbox [-Identity] [-RoleAssignmentPolicy ] [-RoomMailboxPassword ] [-RulesQuota ] + [-SchedulerAssistant ] [-SecondaryAddress ] [-SecondaryDialPlan ] [-SendModerationNotifications ] @@ -870,6 +880,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -893,6 +904,7 @@ Set-Mailbox [-Identity] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -928,7 +940,6 @@ Set-Mailbox [-Identity] [-MessageCopyForSendOnBehalfEnabled ] [-MessageCopyForSentAsEnabled ] [-MessageCopyForSMTPClientSubmissionEnabled ] - [-MessageRecallProcessingEnabled ] [-MessageTrackingReadStatusEnabled ] [-MicrosoftOnlineServicesID ] [-ModeratedBy ] @@ -957,6 +968,7 @@ Set-Mailbox [-Identity] [-RoleAssignmentPolicy ] [-RoomMailboxPassword ] [-RulesQuota ] + [-SchedulerAssistant ] [-SecondaryAddress ] [-SecondaryDialPlan ] [-SendModerationNotifications ] @@ -998,6 +1010,7 @@ Set-Mailbox [-Identity] [-BypassModerationFromSendersOrMembers ] [-CalendarRepairDisabled ] [-CalendarVersionStoreDisabled ] + [-ClearThrottlingPolicyAssignment] [-Confirm] [-CreateDTMFMap ] [-CustomAttribute1 ] @@ -1015,12 +1028,13 @@ Set-Mailbox [-Identity] [-CustomAttribute7 ] [-CustomAttribute8 ] [-CustomAttribute9 ] - [-DataEncryptionPolicy + [-DataEncryptionPolicy ] [-DefaultAuditSet ] [-DefaultPublicFolderMailbox ] [-DeliverToMailboxAndForward ] [-DisplayName ] [-ElcProcessingDisabled ] + [-EmailAddressDisplayNames ] [-EmailAddresses ] [-EnableRoomMailboxAccount ] [-EndDateForRetentionHold ] @@ -1085,6 +1099,7 @@ Set-Mailbox [-Identity] [-RoleAssignmentPolicy ] [-RoomMailboxPassword ] [-RulesQuota ] + [-SchedulerAssistant ] [-SecondaryAddress ] [-SecondaryDialPlan ] [-SendModerationNotifications ] @@ -1108,7 +1123,7 @@ Set-Mailbox [-Identity] ## DESCRIPTION You can use this cmdlet for one mailbox at a time. To perform bulk management, you can pipeline the output of various Get- cmdlets (for example, the Get-Mailbox or Get-User cmdlets) and configure several mailboxes in a single-line command. You can also use the Set-Mailbox cmdlet in scripts. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -1143,6 +1158,7 @@ This example sets the MailTip translation in French and Chinese. ### Example 5 ```powershell $password = Read-Host "Enter password" -AsSecureString + Set-Mailbox florencef -Password $password -ResetPasswordOnNextLogon $true ``` @@ -1151,6 +1167,7 @@ In on-premises Exchange, this example resets the password for Florence Flipo's m ### Example 6 ```powershell Set-Mailbox -Arbitration -Identity "SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}" -MessageTracking $false + Set-Mailbox -Arbitration -Identity "SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}" -MessageTracking $true ``` @@ -1168,7 +1185,7 @@ This example adds a secondary email address to John's mailbox. Set-Mailbox -Identity asraf@contoso.com -RemoveDelayReleaseHoldApplied ``` -In Exchange Online, this example removes the delay hold that's applied to Asraf's mailbox so an offboarding migration (that is, a mailbox migration from Exchange Online back to on-premises Exchange) can continue successfully. For more information about delay holds, see [Managing mailboxes on delay hold](https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). +In Exchange Online, this example removes the delay hold that's applied to Asraf's mailbox so an offboarding migration (that is, a mailbox migration from Exchange Online back to on-premises Exchange) can continue successfully. For more information about delay holds, see [Managing mailboxes on delay hold](https://learn.microsoft.com/purview/ediscovery-identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). ## PARAMETERS @@ -1190,7 +1207,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -1301,7 +1318,7 @@ Accept wildcard characters: False ``` ### -AccountDisabled -This parameter is available o functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The AccountDisabled parameter specifies whether to disable the account that's associated with the mailbox. Valid values are: @@ -1312,7 +1329,7 @@ The AccountDisabled parameter specifies whether to disable the account that's as Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1328,7 +1345,7 @@ The AddressBookPolicy parameter specifies the address book policy that's applied - Distinguished name (DN) - GUID -For more information about address book policies, see [Address book policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies) or [Address book policies in Exchange Online](https://docs.microsoft.com/exchange/address-books/address-book-policies/address-book-policies). +For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies) or [Address book policies in Exchange Online](https://learn.microsoft.com/exchange/address-books/address-book-policies/address-book-policies). ```yaml Type: AddressBookMailboxPolicyIdParameter @@ -1344,15 +1361,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +The Alias value can contain letters, numbers and the following characters: -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. + +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -1394,7 +1416,9 @@ Accept wildcard characters: False ``` ### -ApplyMandatoryProperties -The ApplyMandatoryProperties switch specifies whether to update the msExchVersion attribute of the mailbox. You may need to use this switch to fix inaccessible mailboxes or mailboxes that were created in previous versions of Exchange. You don't need to specify a value with this switch. +The ApplyMandatoryProperties switch specifies whether to update the msExchVersion attribute of the mailbox. You don't need to specify a value with this switch. + +You might need to use this switch to fix inaccessible mailboxes or mailboxes that were created in previous versions of Exchange. ```yaml Type: SwitchParameter @@ -1503,9 +1527,17 @@ Accept wildcard characters: False ``` ### -ArchiveName -The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook and Outlook Web App. +The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). + +In on-premises Exchange, the following default values are used based on the version of Exchange: + +- Exchange 2016 or later: `In-Place Archive -` +- Exchange 2013: `In-Place Archive - ` +- Exchange 2010: `Personal Archive - ` + +In Exchange Online, the default value is `In-Place Archive -`. -If you don't use this parameter, the default value is `In-Place Archive - `. +In Outlook in Exchange Online, the value of this parameter is ignored. The name of the archive mailbox that's shown in the folder list is `Online Archive - `. ```yaml Type: MultiValuedProperty @@ -1705,7 +1737,7 @@ The AuditEnabled parameter specifies whether to enable or disable mailbox audit - $true: Mailbox audit logging is enabled. - $false: Mailbox audit logging is disabled. This is the default value. -**Note**: In Exchange Online, mailbox auditing on by default was enabled for all organizations in January, 2019. For more information, see [Manage mailbox auditing](https://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). +**Note**: In Exchange Online, mailbox auditing on by default was enabled for all organizations in January, 2019. For more information, see [Manage mailbox auditing](https://learn.microsoft.com/purview/audit-mailboxes). ```yaml Type: Boolean @@ -1928,6 +1960,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClearThrottlingPolicyAssignment +This parameter is available only in the cloud-based service. + +The ClearThrottlingPolicyAssignment switch specifies whether to clear any throttling policy assignments for the mailbox. You don't need to specify a value with this switch. + +Admins can contact Microsoft Support to assign a throttling policy to a mailbox, which changes the default throttling limits for various protocols. To revert those changes, use this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClientExtensions This parameter is available only in on-premises Exchange. @@ -1958,7 +2010,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2285,7 +2337,7 @@ The DefaultAuditSet parameter specifies whether to revert the mailbox operations - Delegate: Reverts the mailbox operations to log for delegate users back to the default list of operations. - Owner: Reverts the mailbox operations to log for mailbox owners back to the default list of operations. -With on-by-default mailbox auditing in the cloud-based service, a set of mailbox operations are logged by default for each logon type. This list of operations is managed by Microsoft, who will automatically add new operations to be audited when they are released. If you change the list of mailbox operations for any logon type (by using the AuditAdmin, AuditDelegate, or AuditOwner parameters), any new mailbox operation released by Microsoft will not be audited; you'll need to explicitly add new mailbox operations to the list of operations for a logon type. Use this parameter to revert the mailbox back to the Microsoft-managed list of mailbox operations that are audited for a logon type. For more information about on-by-default mailbox auditing, see [Manage mailbox auditing](https://docs.microsoft.com/microsoft-365/compliance/enable-mailbox-auditing). +With on-by-default mailbox auditing in the cloud-based service, a set of mailbox operations are logged by default for each logon type. This list of operations is managed by Microsoft, who will automatically add new operations to be audited when they are released. If you change the list of mailbox operations for any logon type (by using the AuditAdmin, AuditDelegate, or AuditOwner parameters), any new mailbox operation released by Microsoft will not be audited; you'll need to explicitly add new mailbox operations to the list of operations for a logon type. Use this parameter to revert the mailbox back to the Microsoft-managed list of mailbox operations that are audited for a logon type. For more information about on-by-default mailbox auditing, see [Manage mailbox auditing](https://learn.microsoft.com/purview/audit-mailboxes). ```yaml Type: MultiValuedProperty @@ -2483,8 +2535,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EmailAddressDisplayNames +This parameter is available only in the cloud-based service. + +{{ Fill EmailAddressDisplayNames Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: @@ -2493,7 +2563,7 @@ Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",.. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -2542,16 +2612,16 @@ Accept wildcard characters: False ``` ### -EnableRoomMailboxAccount -The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: +This parameter is functional only in on-premises Exchange. -- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. This allows the account to log on to the room mailbox. -- $false: The account that's associated with the room mailbox is disabled. You can't use the account to logon to the room mailbox. This is the default value. +The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are: -Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. +- $true: The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. The account is able to log in and access the room mailbox or other resources. +- $false: The account that's associated with the room mailbox is disabled. The account is not able to log in and access the room mailbox or other resources. In on-premises Exchange, this is the default value. -In Exchange Online, a room mailbox with an associated enabled account doesn't require a license. +You need to enable the account for features like the Skype for Business Room System or Microsoft Teams Rooms. -In an on-premises Exchange organization, you also need to enable the corresponding user account in Active Directory Users and Computers or by running the Enable-ADAccount cmdlet in Windows PowerShell. +A room mailbox in Exchange Online is created with associated an account that has a random, unknown password. This account is active and visible in Microsoft Graph PowerShell and the Microsoft 365 admin center just like a regular user account, but it consumes no licenses. To prevent this account from being able to log in after you create the mailbox, use the AccountEnabled parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: Boolean @@ -2569,7 +2639,9 @@ Accept wildcard characters: False ### -EndDateForRetentionHold The EndDateForRetentionHold parameter specifies the end date for retention hold for messaging records management (MRM). To use this parameter, you need to set the RetentionHoldEnabled parameter to the value $true. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +**Important**: Using this parameter does not change the _RetentionHoldEnabled_ value to $false after the specified date. The _RentionHoldEnabled_ will still be $true on the mailbox after the specified date, but MRM will start processing mailbox items as normal. + +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -2613,7 +2685,7 @@ When you use this switch, use the DistinguishedName or ExchangeGuid property val Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2635,7 +2707,7 @@ When you use this parameter, use the DistinguishedName or ExchangeGuid property Type: String[] Parameter Sets: ExcludeFromOrgHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -2912,7 +2984,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -3048,7 +3122,7 @@ The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't ne Type: MailboxIdParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3079,9 +3153,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -3109,7 +3183,7 @@ Valid values are: - $true: The user's Lync or Skype for Business contact list is stored in their Exchange 2016 mailbox. This prevents you from migrating the mailbox back to an Exchange 2010 server. - $false: The user's Lync or Skype for Business contact list is stored on a Lync or Skype for Business server. This doesn't prevent you from migrating the mailbox back to an Exchange 2010 server. This is the default value. -Lync Server 2013 and Skype for Business Server 2015 support storing the user's contact list in their Exchange 2016 mailbox. This feature is known as the unified contact store (UCS), and it allows applications to show a consistent, up-to-date contact list. However, Exchange 2010 doesn't support the unified contact store. Therefore, before you migrate a user's Exchange 2016 mailbox back to Exchange 2010, you need to move the user's Lync or Skype for Business contact list from the unified contact store back to a Lync 2013 or Skype for Business server. For more information, see [Configuring Microsoft Lync Server 2013 to use the unified contact store](https://docs.microsoft.com/lyncserver/lync-server-2013-configuring-lync-server-to-use-the-unified-contact-store). +Lync Server 2013 and Skype for Business Server 2015 support storing the user's contact list in their Exchange 2016 mailbox. This feature is known as the unified contact store (UCS), and it allows applications to show a consistent, up-to-date contact list. However, Exchange 2010 doesn't support the unified contact store. Therefore, before you migrate a user's Exchange 2016 mailbox back to Exchange 2010, you need to move the user's Lync or Skype for Business contact list from the unified contact store back to a Lync 2013 or Skype for Business server. For more information, see [Configuring Microsoft Lync Server 2013 to use the unified contact store](https://learn.microsoft.com/lyncserver/lync-server-2013-configuring-lync-server-to-use-the-unified-contact-store). If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's Lync or Skype for Business contact list is stored in the unified contact store, the user could permanently lose access to those contacts. After you verify the user's Lync or Skype for Business contact list has been moved back to a Lync 2013 or Skype for Business server, you should be able to complete the mailbox migration. If you need to migrate the mailbox despite the potential for data loss, you can manually set the ImListMigrationCompleted parameter to $false. @@ -3151,7 +3225,7 @@ The InactiveMailbox switch specifies that the mailbox is an inactive mailbox. Yo An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. -To find inactive mailboxes, run the command Get-Mailbox -InactiveMailboxOnly | FL Name,PrimarySmtpAddress,DistinguishedName,ExchangeGuid and then use the DistinguishedName or ExchangeGuid property values for the Identity parameter (values guaranteed to be unique). +To find inactive mailboxes, run the command `Get-Mailbox -InactiveMailboxOnly | Format-List Name,PrimarySmtpAddress,DistinguishedName,ExchangeGuid` and then use the DistinguishedName or ExchangeGuid property values for the Identity parameter (values guaranteed to be unique). This switch is required to use the LitigationHoldEnabled and LitigationHoldDuration parameters on inactive mailboxes. @@ -3161,7 +3235,7 @@ You can't use this switch to modify other properties on inactive mailboxes. Type: SwitchParameter Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3277,7 +3351,7 @@ Accept wildcard characters: False ### -Languages The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook on the web user interface, and Unified Messaging (UM) voice prompts. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -3301,7 +3375,7 @@ This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the credentials used to access the domain controller specified by the LinkedDomainController parameter. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -3384,7 +3458,7 @@ A valid value is an integer that represents the number of days, or the value unl Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3407,7 +3481,7 @@ Placing public folder mailboxes on Litigation Hold isn't supported. To place pub Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3423,7 +3497,7 @@ The LitigationHoldOwner parameter specifies the user who placed the mailbox on l Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3433,7 +3507,7 @@ Accept wildcard characters: False ``` ### -MailboxMessagesPerFolderCountReceiveQuota -This parameter is a available only in on-premises Exchange. +This parameter is an available only in on-premises Exchange. The MailboxMessagesPerFolderCountReceiveQuota parameter specifies the maximum number of messages for a mailbox folder. When this limit is reached, the folder can't receive new messages. @@ -3455,7 +3529,7 @@ Accept wildcard characters: False ``` ### -MailboxMessagesPerFolderCountWarningQuota -This parameter is a available only in on-premises Exchange. +This parameter is an available only in on-premises Exchange. The MailboxMessagesPerFolderCountWarningQuota parameter specifies the number of messages that a mailbox folder can hold before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day. @@ -3483,7 +3557,7 @@ The MailboxRegion parameter specifies the geo location for the mailbox in multi- To see the list of configured geo locations in Microsoft 365 Multi-Geo, run the following command: `Get-OrganizationConfig | Select -ExpandProperty AllowedMailboxRegions | Format-Table`. To view your central geo location, run the following command: `Get-OrganizationConfig | Select DefaultMailboxRegion`. - For more information, see [Administering Exchange Online mailboxes in a multi-geo environment](https://docs.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). + For more information, see [Administering Exchange Online mailboxes in a multi-geo environment](https://learn.microsoft.com/microsoft-365/enterprise/administering-exchange-online-multi-geo). ```yaml Type: String @@ -3544,7 +3618,7 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicy -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The ManagedFolderMailboxPolicy parameter specifies a managed folder mailbox policy that controls MRM for the mailbox. If the parameter is set to $null, Exchange removes the managed folder mailbox policy from the mailbox but any managed folders in the mailbox remain. @@ -3562,9 +3636,11 @@ Accept wildcard characters: False ``` ### -ManagedFolderMailboxPolicyAllowed -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. + +The ManagedFolderMailboxPolicyAllowed switch bypasses the warning that MRM features aren't supported for clients running versions of Outlook earlier than Outlook 2007. You don't need to specify a value with this switch. -The ManagedFolderMailboxPolicyAllowed parameter bypasses the warning that MRM features aren't supported for clients running versions of Outlook earlier than Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox by using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed parameter is used. +When a managed folder mailbox policy is assigned to a mailbox by using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless you also use the ManagedFolderMailboxPolicyAllowed switch. Although Outlook 2003 Service Pack 3 clients are supported, they have limited MRM functionality. @@ -3758,25 +3834,10 @@ Accept wildcard characters: False ### -MessageCopyForSMTPClientSubmissionEnabled This parameter is available only in the cloud-based service. -{{ Fill MessageCopyForSMTPClientSubmissionEnabled Description }} +The MessageCopyForSMTPClientSubmissionEnabled parameter specifies whether to copy the sender for messages that are sent using SMTP client submission (SMTP AUTH). Valid values are: -```yaml -Type: Boolean -Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageRecallProcessingEnabled -This parameter is available only in the cloud-based service. - -{{ Fill MessageRecallProcessingEnabled Description }} +- $true: When the user's account sends messages using SMTP AUTH, a copy of the message is sent to the users's mailbox. This is the default value. +- $false: When the user's account sends messages using SMTP AUTH, a copy of the message isn't sent to the users's mailbox. ```yaml Type: Boolean @@ -3919,6 +3980,8 @@ Accept wildcard characters: False ### -Name The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). +In the cloud-based service, many special characters aren't allowed in the Name value (for example, ö, ü, or ä). For more information, see [Error when you try to create a username that contains a special character in Microsoft 365](https://learn.microsoft.com/office/troubleshoot/office-suite-issues/username-contains-special-character). + ```yaml Type: String Parameter Sets: (All) @@ -3937,7 +4000,11 @@ This parameter is available only in on-premises Exchange. The NewPassword parameter is used with the OldPassword parameter when a user changes their own password in Outlook on the web. By default, the NewPassword and OldPassword parameters are also available to members of the Help Desk and Organization Management role groups via the User Options role. However, administrators use the Password parameter to reset a user's password, because that parameter doesn't require the user's current password. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString @@ -3961,7 +4028,7 @@ This parameter is available only in the cloud-based service. Type: MultiValuedProperty Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4035,7 +4102,11 @@ This parameter is available only in on-premises Exchange. The OldPassword parameter is used with the NewPassword parameter when a user changes their own password in Outlook on the web. By default, the NewPassword and OldPassword parameters are also available to members of the Help Desk and Organization Management role groups via the User Options role. However, administrators typically use the Password parameter to reset a user's password, because that parameter doesn't require the user's current password. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString @@ -4087,12 +4158,16 @@ Accept wildcard characters: False ``` ### -Password -The Password parameter resets the password of the user account that's associated with the mailbox to the value you specify. To use this parameter on a mailbox other than your own, you need to be a member of one of the following role groups: +The Password parameter resets the password of the user account that's associated with the mailbox to the value you specify. To use this parameter on a mailbox other than your own, consider the following options: + +- Exchange Online: You can't use this parameter to change another user's password. Use the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. +- On-premises Exchange: You need the User Options or Reset Password role. The User Options role is assigned to the Organization Management or Help Desk role groups. The Reset Password role it isn't assigned to any role groups by default. -- Exchange Online: You can't use this parameter to change another user's password. To change another user's password, use the Set-MsolUserPassword cmdlet in Azure AD PowerShell. For connection instructions, see [Connect to Office 365 PowerShell](https://docs.microsoft.com/office365/enterprise/powershell/connect-to-office-365-powershell). To change a another user's password in the Microsoft 365 admin center, see [Reset Microsoft 365 for business passwords](https://docs.microsoft.com/microsoft-365/admin/add-users/reset-passwords). -- On-premises Exchange: The Organization Management or Help Desk role groups via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. +You can use the following methods as a value for this parameter: -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. ```yaml Type: SecureString @@ -4112,7 +4187,7 @@ This parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mailbox are no longer automatically updated by email address policies. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. @@ -4278,7 +4353,7 @@ You use this switch with the InactiveMailbox switch and the Identity parameter ( Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4292,7 +4367,7 @@ The RecipientLimits parameter specifies the maximum number of recipients allowed In on-premises Exchange, a valid value is an integer or the value unlimited. The default value is unlimited, which indicates the maximum number of recipients per message for the mailbox is controlled elsewhere (for example, organization, server, or connector limits). -In the cloud-based service, a valid value is an integer from 1 to 1000. +In the cloud-based service, a valid value is an integer from 1 to 1000. The default value is 500. This value does not apply to meeting messages. ```yaml Type: Unlimited @@ -4502,13 +4577,13 @@ The RemoveDelayHoldApplied switch specifies whether to remove delay holds on ema The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace `` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity -ComponentName HoldTracking`. You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. -For more information, see [Managing mailboxes on delay hold](https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). +For more information, see [Managing mailboxes on delay hold](https://learn.microsoft.com/purview/ediscovery-identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). ```yaml Type: SwitchParameter Parameter Sets: RemoveDelayHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4520,19 +4595,19 @@ Accept wildcard characters: False ### -RemoveDelayReleaseHoldApplied This parameter is available only in the cloud-based service. -The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Yammer) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. +The RemoveDelayReleaseHoldApplied switch specifies whether to remove delay holds on cloud data generated by non-Exchange apps (such as Teams, Forms, and Viva Engage) from the mailbox. Data generated by a non-Exchange cloud-based app is typically stored in a hidden folder in the mailbox. You don't need to specify a value with this switch. The removal of a hold from a mailbox is temporarily delayed to prevent the accidental purge of content that's no longer affected by the hold. This temporary delay in the removal of the hold is known as a delay hold. To see the hold history on a mailbox, replace `` with the name, email address, or alias of the mailbox, and run this command: `Export-MailboxDiagnosticLogs -Identity -ComponentName SubstrateHoldTracking`. You can use this switch with the GroupMailbox or InactiveMailbox switch to remove delay holds from group mailboxes or inactive mailboxes. -For more information, see [Managing mailboxes on delay hold](https://docs.microsoft.com/microsoft-365/compliance/identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). +For more information, see [Managing mailboxes on delay hold](https://learn.microsoft.com/purview/ediscovery-identify-a-hold-on-an-exchange-online-mailbox#managing-mailboxes-on-delay-hold). ```yaml Type: SwitchParameter Parameter Sets: RemoveDelayReleaseHoldApplied Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -4568,7 +4643,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4580,9 +4655,7 @@ Accept wildcard characters: False ### -RemoveManagedFolderAndPolicy This parameter is available only in on-premises Exchange. -The RemoveManagedFolderAndPolicy switch specifies whether to remove all MRM policies and attributes from a mailbox. - -You don't need to specify a value with this switch. +The RemoveManagedFolderAndPolicy switch specifies whether to remove all MRM policies and attributes from a mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -4610,7 +4683,7 @@ In an Exchange hybrid deployment, In-Place Holds that are created in the on-prem Type: String[] Parameter Sets: RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4750,7 +4823,7 @@ The RetainDeletedItemsFor parameter specifies the length of time to keep soft-de These actions move the items into the Recoverable Items\\Deletions folder. -Before the deleted item retention period expires, users can recover soft-deleted items in Outlook and Outlook on the web by using the Recover Deleted Items feature. For more information, see [Recoverable Items folder in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). +Before the deleted item retention period expires, users can recover soft-deleted items in Outlook and Outlook on the web by using the Recover Deleted Items feature. For more information, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -4783,7 +4856,7 @@ The RetainDeletedItemsUntilBackup parameter specifies whether to keep items in t When the UseDatabaseRetentionDefaults parameter on the mailbox is set to the value $true (the default value), the value of the this parameter is ignored, and the mailbox uses the RetainDeletedItemsUntilBackup parameter value from the mailbox database. To use the RetainDeletedItemsUntilBackup parameter on the mailbox, you need to set the UseDatabaseRetentionDefaults parameter to the value $false. -For more information, see [Recoverable Items folder in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). +For more information, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). ```yaml Type: Boolean @@ -4811,7 +4884,7 @@ This comment should be localized to the user's preferred language. If the commen Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4823,7 +4896,7 @@ Accept wildcard characters: False ### -RetentionHoldEnabled The RetentionHoldEnabled parameter specifies whether the mailbox is placed on retention hold. Placing the mailbox on retention hold temporarily suspends the processing of retention policies or managed folder mailbox policies for the mailbox (for example, when the user is on vacation). Valid values are: -- $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox. +- $true: The mailbox is placed on retention hold. Retention policies and managed folder policies are suspended for the mailbox, and purging items from the mailbox isn't possible (even using MFCMapi). - $false: The retention hold is removed from the mailbox. The mailbox is subject to retention policies and managed folder policies. This is the default value. To set the start date for retention hold, use the StartDateForRetentionHold parameter. @@ -4874,7 +4947,7 @@ This URL can be used to expose details regarding retention policies in general, Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -4892,7 +4965,7 @@ The RoleAssignmentPolicy parameter specifies the role assignment policy that's a In Exchange Online, a role assignment policy must be assigned to the mailbox. In on-premises Exchange, to configure the mailbox so there's no role assignment policy assigned, use the value $null. -Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information, see [Understanding management role assignment policies](https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). +Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). ```yaml Type: MailboxPolicyIdParameter @@ -4908,9 +4981,25 @@ Accept wildcard characters: False ``` ### -RoomMailboxPassword -Use the RoomMailboxPassword parameter to change the password for a room mailbox that has an enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.) +This parameter is functional only in on-premises Exchange. + +Use the RoomMailboxPassword parameter to configure the password for the account that's associated with the room mailbox when that account is enabled and able to log in (the EnableRoomMailboxAccount parameter is set to the value $true). + +To use this parameter in on-premises Exchange, you need to be a member of one of the following role groups: + +- The Organization Management role group via the Mail Recipients and User Options roles. +- The Recipient Management role group via the Mail Recipients role. +- The Help Desk role group via the User Options role. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default. + +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. + +To configure the password for a room mailbox account in Exchange Online, use the PasswordProfile parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: SecureString @@ -4972,12 +5061,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SchedulerAssistant +This parameter is available only in the cloud-based service. + +{{ Fill SchedulerAssistant Description }} + +```yaml +Type: Boolean +Parameter Sets: ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDelayReleaseHoldApplied, RemoveDisabledArchive, RemoveOrphanedHolds +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SCLDeleteEnabled This parameter is available only in on-premises Exchange. The SCLDeleteEnabled parameter specifies whether to silently delete messages that meet or exceed the spam confidence level (SCL) specified by the SCLDeleteThreshold parameter. Valid values are: -- $true: Messages that meet or exceed the SCLDeleteThreshold value are silently deleted without sending an non-delivery report (NDR). +- $true: Messages that meet or exceed the SCLDeleteThreshold value are silently deleted without sending a non-delivery report (NDR). - $false: Messages that meet or exceed the SCLDeleteThreshold value aren't deleted. - $null (blank): The value isn't configured. This is the default value. @@ -5065,7 +5172,7 @@ The SCLQuarantineEnabled parameter specifies whether messages that meet or excee - $false: Messages that meet or exceed the SCLQuarantineThreshold value aren't sent to the quarantine mailbox. - $null (blank): The value isn't configured. This is the default value. -To configure the quarantine mailbox, see [Configure a spam quarantine mailbox](https://docs.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-quarantine-mailboxes). +To configure the quarantine mailbox, see [Configure a spam quarantine mailbox](https://learn.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-quarantine-mailboxes). ```yaml Type: Boolean @@ -5143,13 +5250,15 @@ Accept wildcard characters: False ``` ### -SecondaryAddress +This parameter is available only in on-premises Exchange. + The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -5243,10 +5352,10 @@ Accept wildcard characters: False ``` ### -SingleItemRecoveryEnabled -The SingleItemRecoveryEnabled parameter specifies whether to prevent the Recovery Items folder from being purged. Valid values are: +The SingleItemRecoveryEnabled parameter specifies whether to prevent the Recoverable Items folder from being purged. Valid values are: -- $true: Single item recovery is enabled. The Recovery Items folder can't be purged. and items that have been deleted or edited can't be removed. -- $false: Single item recovery isn't enabled. The Recovery Items folder can be purged, and, items that have been deleted or edited can be removed. This is the default value. +- $true: Single item recovery is enabled. The Recoverable Items folder can't be purged, and deleted or edited items can't be removed. This is the default value in Exchange Online. For more information, see [Enable or disable single item recovery for a mailbox in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/enable-or-disable-single-item-recovery). +- $false: Single item recovery isn't enabled. The Recoverable Items folder can be purged, and deleted or edited items can be removed. This is the default value in Exchange Server. For more information, see [Enable or disable single item recovery for a mailbox](https://learn.microsoft.com/exchange/recipients/user-mailboxes/single-item-recovery). ```yaml Type: Boolean @@ -5282,7 +5391,7 @@ Accept wildcard characters: False ### -StartDateForRetentionHold The StartDateForRetentionHold parameter specifies the start date for the retention hold that's placed on the mailbox. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". To use this parameter, you need to set the RetentionHoldEnabled parameter to value $true. @@ -5306,7 +5415,7 @@ This parameter is reserved for internal Microsoft use. Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5383,6 +5492,7 @@ The Type parameter specifies the mailbox type for the mailbox. Valid values are: - Room - Shared - Workspace (cloud-only) +- Desk (cloud-only): This value doesn't result in a desk that's available for booking. Instead, create the desk in Places PowerShell using the [New-Place](https://learn.microsoft.com/microsoft-365/places/powershell/new-place) cmdlet, and then link the desk to this mailbox using the [Set-PlaceV3](/microsoft-365/places/powershell/set-placev3) cmdlet. ```yaml Type: ConvertibleMailboxSubType @@ -5476,7 +5586,7 @@ This parameter is available only in the cloud-based service. Type: SwitchParameter Parameter Sets: RecalculateInactiveMailbox, RemoveDelayHoldApplied, RemoveDisabledArchive, ExcludeFromAllOrgHolds, ExcludeFromOrgHolds, RemoveDelayReleaseHoldApplied, RemoveOrphanedHolds Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5514,7 +5624,7 @@ Accept wildcard characters: False ``` ### -UseDatabaseRetentionDefaults -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The UseDatabaseRetentionDefaults parameter specifies whether the retention settings for items in the Recoverable Items folder in the mailbox are determined by the settings on the mailbox or the corresponding settings on the mailbox database. Valid values are: @@ -5601,7 +5711,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -5636,12 +5746,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md b/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md index 195645bc72..bf087d92fa 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md +++ b/exchange/exchange-ps/exchange/Set-MailboxAuditBypassAssociation.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxauditbypassassociation +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxAuditBypassAssociation schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxAuditBypassAssociation cmdlet to configure mailbox audit logging bypass for user or computer accounts such as service accounts for applications that access mailboxes frequently. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ When you configure a user or computer account to bypass mailbox audit logging, a If you use mailbox audit logging to audit mailbox access and actions, you must monitor mailbox audit bypass associations at regular intervals. If a mailbox audit bypass association is added for an account, the account can access any mailbox in the organization to which it has been assigned access permissions, without any mailbox audit logging entries being generated for such access, or any actions taken such as message deletions. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,7 +60,7 @@ The Identity parameter specifies a user or computer account to be bypassed from Type: MailboxAuditBypassAssociationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -98,7 +98,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -132,7 +132,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,12 +146,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md index dc8b06e0f2..24d0f4377e 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxAutoReplyConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxautoreplyconfiguration +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxAutoReplyConfiguration schema: 2.0.0 search.appverid: MET150 @@ -17,7 +17,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxAutoReplyConfiguration cmdlet to configure Automatic Replies settings for a specific mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -46,7 +46,7 @@ Set-MailboxAutoReplyConfiguration [-Identity] ## DESCRIPTION You can disable Automatic Replies for a specified mailbox or organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,14 +55,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-MailboxAutoReplyConfiguration -Identity tony@contoso.com -AutoReplyState Scheduled -StartTime "7/10/2018 08:00:00" -EndTime "7/15/2018 17:00:00" -InternalMessage "Internal auto-reply message" ``` -This example configures Automatic Replies for Tony's mailbox to be sent between the specified start and end dates and includes an internal message. +This example configures Automatic Replies for Tony's mailbox to be sent between the specified start and end dates and includes an internal reply. ### Example 2 ```powershell -Set-MailboxAutoReplyConfiguration -Identity tony@contoso.com -AutoReplyState Enabled -InternalMessage "Internal auto-reply message." -ExternalMessage "External auto-reply message." +Set-MailboxAutoReplyConfiguration -Identity tony@contoso.com -AutoReplyState Enabled -InternalMessage "Internal auto-reply message." -ExternalMessage "External auto-reply message." -ExternalAudience All ``` -This example configures Automatic Replies for Tony's mailbox to be sent and includes an internal and an external message. +This example configures Automatic Replies for Tony's mailbox to be sent, specifies the reply for messages from internal and external senders, and specifies the external reply is sent to any external address. ## PARAMETERS @@ -84,7 +84,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -94,7 +94,7 @@ Accept wildcard characters: False ``` ### -AutoDeclineFutureRequestsWhenOOF -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The AutoDeclineFutureRequestsWhenOOF parameter specifies whether to automatically decline new meeting requests that are sent to the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: @@ -151,7 +151,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -161,7 +161,7 @@ Accept wildcard characters: False ``` ### -CreateOOFEvent -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The CreateOOFEvent parameter specifies whether to create a calendar event that corresponds to the scheduled time period when Automatic Replies are being sent for the mailbox. Valid values are: @@ -182,11 +182,11 @@ Accept wildcard characters: False ``` ### -DeclineAllEventsForScheduledOOF -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The DeclineAllEventsForScheduledOOF parameter specifies whether to decline all existing calendar events in the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: -- $true: Existing calendar events in the mailbox that occur during the scheduled time period are declined and removed from the calendar. +- $true: Existing calendar events in the mailbox that occur during the scheduled time period are declined and removed from the calendar. If the mailbox is the meeting organizer, the events are cancelled for all other attendees. - $false: Existing calendar events in the mailbox that occur during the scheduled time period remain in the calendar. This is the default value. You can use this parameter only when the DeclineEventsForScheduledOOF parameter is set to $true. @@ -207,11 +207,14 @@ Accept wildcard characters: False ``` ### -DeclineEventsForScheduledOOF -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The DeclineEventsForScheduledOOF parameter specifies whether it's possible to decline existing calendar events in the mailbox during the scheduled time period when Automatic Replies are being sent. Valid values are: -- $true: Existing calendar events in the mailbox that occur during the scheduled time period can be declined and removed from the calendar. To decline specific events during the scheduled time period, use the EventsToDeleteIDs parameter. To decline all events during the scheduled time period, use the DeclineAllEventsForScheduledOOF parameter. +- $true: Existing calendar events in the mailbox that occur during the scheduled time period can be declined and removed from the calendar. If the mailbox is the meeting organizer, the events are cancelled for all other attendees. + + To decline specific events during the scheduled time period, use the EventsToDeleteIDs parameter. To decline all events during the scheduled time period, use the DeclineAllEventsForScheduledOOF parameter. + - $false: Existing calendar events in the mailbox that occur during the scheduled time period remain in the calendar. This is the default value. You can use this parameter only when the AutoReplyState parameter is set to Scheduled. @@ -230,7 +233,7 @@ Accept wildcard characters: False ``` ### -DeclineMeetingMessage -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The DeclineMeetingMessage parameter specifies the text in the message when meetings requests that are sent to the mailbox are automatically declined. For example: @@ -275,7 +278,7 @@ Accept wildcard characters: False ### -EndTime The EndTime parameter specifies the end date and time that Automatic Replies are sent for the mailbox. You use this parameter only when the AutoReplyState parameter is set to Scheduled, and the value of this parameter is meaningful only when AutoReplyState is Scheduled. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -291,7 +294,7 @@ Accept wildcard characters: False ``` ### -EventsToDeleteIDs -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The EventsToDeleteIDs parameter specifies the calendar events to delete from the mailbox when the DeclineEventsForScheduledOOF parameter is set to $true. @@ -360,9 +363,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -403,7 +406,7 @@ Accept wildcard characters: False ``` ### -OOFEventSubject -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The OOFEventSubject parameter specifies the subject for the calendar event that's automatically created when the CreateOOFEvent parameter is set to $true. @@ -425,7 +428,7 @@ Accept wildcard characters: False ### -StartTime The StartTime parameter specifies the start date and time that Automatic Replies are sent for the specified mailbox. You use this parameter only when the AutoReplyState parameter is set to Scheduled, and the value of this parameter is meaningful only when AutoReplyState is Scheduled. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -447,7 +450,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -461,12 +464,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md index 3b46b29bce..78d43a57d3 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxcalendarconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarconfiguration +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxCalendarConfiguration schema: 2.0.0 author: chrisda @@ -16,15 +16,43 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxCalendarConfiguration cmdlet to modify mailbox calendar settings for Outlook on the web. This affects how the user's calendar looks and how reminders work in Outlook on the web. This also affects settings that define how meeting invitations, responses, and notifications are sent to the user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Default +``` +Set-MailboxCalendarConfiguration [-Identity] + [-AgendaMailEnabled ] + [-Confirm] + [-ConversationalSchedulingEnabled ] + [-DailyAgendaMailSchedule ] + [-DefaultMeetingDuration ] + [-DefaultReminderTime ] + [-DomainController ] + [-FirstWeekOfYear ] + [-RemindersEnabled ] + [-ReminderSoundEnabled ] + [-ShowWeekNumbers ] + [-SkipAgendaMailOnFreeDays ] + [-TimeIncrement ] + [-UseBrightCalendarColorThemeInOwa ] + [-WeekStartDay ] + [-WhatIf] + [-WorkDays ] + [-WorkingHoursEndTime ] + [-WorkingHoursStartTime ] + [-WorkingHoursTimeZone ] + [] +``` + +### Identity ``` Set-MailboxCalendarConfiguration [-Identity] [-AgendaMailEnabled ] [-AgendaMailIntroductionEnabled ] [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] [-CalendarFeedsPreferredLanguage ] [-CalendarFeedsPreferredRegion ] [-CalendarFeedsRootPageId ] @@ -33,26 +61,86 @@ Set-MailboxCalendarConfiguration [-Identity] [-CreateEventsFromEmailAsPrivate ] [-DailyAgendaMailSchedule ] [-DefaultMeetingDuration ] + [-DefaultMinutesToReduceLongEventsBy ] + [-DefaultMinutesToReduceShortEventsBy ] + [-DefaultOnlineMeetingProvider ] [-DefaultReminderTime ] + [-DeleteMeetingRequestOnRespond ] [-DiningEventsFromEmailEnabled ] - [-DomainController ] [-EntertainmentEventsFromEmailEnabled ] [-EventsFromEmailEnabled ] [-FirstWeekOfYear ] [-FlightEventsFromEmailEnabled ] [-HotelEventsFromEmailEnabled ] [-InvoiceEventsFromEmailEnabled ] - [-OnlineMeetingsByDefaultEnabled ] + [-LocationDetailsInFreeBusy ] + [-OnlineMeetingsByDefaultEnabled ] [-PackageDeliveryEventsFromEmailEnabled ] + [-PreserveDeclinedMeetings ] + [-RemindersEnabled ] [-ReminderSoundEnabled ] + [-RentalCarEventsFromEmailEnabled ] + [-ServiceAppointmentEventsFromEmailEnabled ] + [-ShortenEventScopeDefault ] + [-ShowWeekNumbers ] + [-SkipAgendaMailOnFreeDays ] + [-TimeIncrement ] + [-UseBrightCalendarColorThemeInOwa ] + [-WeatherEnabled ] + [-WeatherLocationBookmark ] + [-WeatherLocations ] + [-WeatherUnit ] + [-WeekStartDay ] + [-WhatIf] + [-WorkDays ] + [-WorkingHoursEndTime ] + [-WorkingHoursStartTime ] + [-WorkingHoursTimeZone ] + [-WorkspaceUserEnabled ] + [] +``` + +### MailboxLocation +``` +Set-MailboxCalendarConfiguration [-MailboxLocation ] + [-AgendaMailEnabled ] + [-AgendaMailIntroductionEnabled ] + [-AgendaPaneEnabled ] + [-AutoDeclineWhenBusy ] + [-CalendarFeedsPreferredLanguage ] + [-CalendarFeedsPreferredRegion ] + [-CalendarFeedsRootPageId ] + [-Confirm] + [-ConversationalSchedulingEnabled ] + [-CreateEventsFromEmailAsPrivate ] + [-DailyAgendaMailSchedule ] + [-DefaultMeetingDuration ] + [-DefaultMinutesToReduceLongEventsBy ] + [-DefaultMinutesToReduceShortEventsBy ] + [-DefaultOnlineMeetingProvider ] + [-DefaultReminderTime ] + [-DeleteMeetingRequestOnRespond ] + [-DiningEventsFromEmailEnabled ] + [-EntertainmentEventsFromEmailEnabled ] + [-EventsFromEmailEnabled ] + [-FirstWeekOfYear ] + [-FlightEventsFromEmailEnabled ] + [-HotelEventsFromEmailEnabled ] + [-InvoiceEventsFromEmailEnabled ] + [-LocationDetailsInFreeBusy ] + [-OnlineMeetingsByDefaultEnabled ] + [-PackageDeliveryEventsFromEmailEnabled ] + [-PreserveDeclinedMeetings ] [-RemindersEnabled ] + [-ReminderSoundEnabled ] [-RentalCarEventsFromEmailEnabled ] [-ServiceAppointmentEventsFromEmailEnabled ] + [-ShortenEventScopeDefault ] [-ShowWeekNumbers ] [-SkipAgendaMailOnFreeDays ] [-TimeIncrement ] [-UseBrightCalendarColorThemeInOwa ] - [-WeatherEnabled ] + [-WeatherEnabled ] [-WeatherLocationBookmark ] [-WeatherLocations ] [-WeatherUnit ] @@ -62,14 +150,14 @@ Set-MailboxCalendarConfiguration [-Identity] [-WorkingHoursEndTime ] [-WorkingHoursStartTime ] [-WorkingHoursTimeZone ] - [-WorkspaceUserEnabled ] + [-WorkspaceUserEnabled ] [] ``` ## DESCRIPTION -The Set-MailboxCalendarConfiguration cmdlet primarily allows users to manage their own calendar settings in Outlook on the web Options. However, administrators who have the Organization Management or Recipient Management management roles may configure the calendar settings for users by using this cmdlet. +The Set-MailboxCalendarConfiguration cmdlet primarily allows users to manage their own calendar settings in Outlook on the web Options. However, administrators who are members of the Organization Management or Recipient Management role groups can configure the calendar settings for users by using this cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -112,9 +200,9 @@ The Identity parameter specifies the mailbox that you want to modify. You can us ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -146,7 +234,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -164,7 +252,25 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoDeclineWhenBusy +This parameter is available only in the cloud-based service. + +{{ Fill AutoDeclineWhenBusy Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -182,7 +288,7 @@ The CalendarFeedsPreferredLanguage parameter specifies the preferred language fo ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -202,7 +308,7 @@ A reference for two-letter country codes is available at [Country Codes List](ht ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -220,7 +326,7 @@ The CalendarFeedsRootPageId parameter specifies the root page ID for calendar fe ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -241,7 +347,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -279,7 +385,7 @@ The CreateEventsFromEmailAsPrivate parameter specifies whether to create events ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -322,8 +428,79 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultMinutesToReduceLongEventsBy +This parameter is available only in the cloud-based service. + +{{ Fill DefaultMinutesToReduceLongEventsBy Description }} + +```yaml +Type: Int32 +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultMinutesToReduceShortEventsBy +This parameter is available only in the cloud-based service. + +{{ Fill DefaultMinutesToReduceShortEventsBy Description }} + +```yaml +Type: Int32 +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOnlineMeetingProvider +This parameter is available only in the cloud-based service. + +The DefaultOnlineMeetingProvider parameter specifies the default provider for online meetings. Valid values are: + +- AlibabaDingTalk +- AmazonChimePrivate +- AmazonChimePublic +- AppleFacetime +- BlueJeans +- ClaroVideoconferencia +- FacebookWorkplace +- GoogleMeet +- GoToMeeting +- JioMeet +- RingCentral +- SkypeForBusiness +- SkypeForConsumer +- TeamsForBusiness (This is the default value.) +- Webex +- Zoom + +```yaml +Type: OnlineMeetingProviderType +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultReminderTime -The DefaultReminderTime parameter specifies the length of time before a meeting or appointment whenthe reminder is first displayed. +The DefaultReminderTime parameter specifies the length of time before a meeting or appointment when the reminder is first displayed. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -361,6 +538,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DeleteMeetingRequestOnRespond +This parameter is available only in the cloud-based service. + +{{ Fill DeleteMeetingRequestOnRespond Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DiningEventsFromEmailEnabled This parameter is available only in the cloud-based service. @@ -373,7 +568,7 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -391,7 +586,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -414,7 +609,7 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -444,7 +639,7 @@ When this setting is enabled, you can enable or disable creating specific types ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -455,49 +650,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FlightEventsFromEmailEnabled -This parameter is available only in the cloud-based service. - -The FlightEventsFromEmailEnabled parameter specifies whether to create flight reservation events from email messages. Valid values are: +### -FirstWeekOfYear +The FirstWeekOfYear parameter specifies the first week of the year. Valid values are: -- $true: Create flight reservation events from email messages. This is the default value. -- $false: Don't create flight reservation events from email messages. +- FirstDay: Week numbers start on the first day of the year. This is the default value. +- FirstFourDayWeek: Week numbers start on the first week that has at least four days. +- FirstFullWeek: Week numbers start on the first week that has seven days. +- LegacyNotSet: You can't set this value. This is a null value that appears only when the mailbox has been moved from an earlier version of Exchange. -This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). +You configure the first day of the week by using the WeekStartDay parameter. ```yaml -Type: Boolean +Type: FirstWeekRules Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: false Accept wildcard characters: False ``` -### -FirstWeekOfYear -The FirstWeekOfYear parameter specifies the first week of the year. Valid values are: +### -FlightEventsFromEmailEnabled +This parameter is available only in the cloud-based service. -- FirstDay: Week numbers start on the first day of the year. This is the default value. -- FirstFourDayWeek: Week numbers start on the first week that has at least four days. -- FirstFullWeek: Week numbers start on the first week that has seven days. -- LegacyNotSet: You can't set this value. This is a null value that appears only when the mailbox has been moved from an earlier version of Exchange. +The FlightEventsFromEmailEnabled parameter specifies whether to create flight reservation events from email messages. Valid values are: -You configure the first day of the week by using the WeekStartDay parameter. +- $true: Create flight reservation events from email messages. This is the default value. +- $false: Don't create flight reservation events from email messages. + +This parameter is meaningful only when the EventsFromEmailEnabled parameter is set to $true (which is the default value). ```yaml -Type: FirstWeekRules -Parameter Sets: (All) +Type: Boolean +Parameter Sets: Identity, MailboxLocation Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online Required: False Position: Named Default value: None -Accept pipeline input: false +Accept pipeline input: False Accept wildcard characters: False ``` @@ -513,7 +708,7 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -534,7 +729,7 @@ The InvoiceEventsFromEmailEnabled parameter specifies whether to allow creating ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -545,18 +740,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LocationDetailsInFreeBusy +This parameter is available only in the cloud-based service. + +The LocationDetailsInFreeBusy parameter specifies the level of work location information that's returned as part of a user's availability. Work location information is visible across several Microsoft 365 application experiences, and the level of location information that's shown to other users in the organization is controlled by this parameter. Valid values are: + +- None: No location information is returned. +- Building: Only Office or Remote are returned as work location information, if provided. +- Desk: All work location information is returned, including Building and Desk, if provided. This is the default value. + +```yaml +Type: LocationDetailsPermissionInFreeBusy +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: Desk +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OnlineMeetingsByDefaultEnabled This parameter is available only in the cloud-based service. -The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Valid values are: +The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetings as Teams or Skype for Business by default during meeting creation. Currently, this parameter sets the default value, so if the user has already directly interacted with this setting from an Outlook client, this default value will be ignored. Eventually, this parameter will override the Outlook-configured setting. + +Valid values are: - $true: All meetings are online by default. - $false: All meetings are not online by default. - $null: The value of the OnlineMeetingsByDefaultEnabled parameter on the Set-OrganizationConfig cmdlet (the organizational setting) is used. +Setting this parameter enables the display of the **Add online meeting to all meetings** option in **Calendar options** in Outlook for Windows. This setting allows users to enable or disable the option when Teams is used for online meetings. It does not override the organization setting that's configured by the OnlineMeetingsByDefaultEnabled parameter on the Set-OrganizationConfig cmdlet. + ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -579,7 +818,25 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreserveDeclinedMeetings +This parameter is available only in the cloud-based service. + +{{ Fill PreserveDeclinedMeetings Description }} + +```yaml +Type: Boolean +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -644,7 +901,7 @@ This parameter is meaningful only when the EventsFromEmailEnabled parameter is s ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -662,7 +919,25 @@ This parameter is available only in the cloud-based service. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShortenEventScopeDefault +This parameter is available only in the cloud-based service. + +{{ Fill ShortenEventScopeDefault Description }} + +```yaml +Type: ShortenEventScopeOption +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -746,30 +1021,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WeekStartDay -The WeekStartDay parameter specifies the first day of the week. Valid values are: - -- Sunday (This is the default value) -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday - -```yaml -Type: DayOfWeek -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WeatherEnabled This parameter is available only in the cloud-based service. @@ -781,7 +1032,7 @@ The WeatherEnabled specifies whether weather is displayed in the calendar in Out ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -801,7 +1052,7 @@ A valid value for this parameter depends on the number of weather locations that ```yaml Type: Int32 -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -829,7 +1080,7 @@ You can configure a maximum of 5 weather locations. ```yaml Type: MultiValuedProperty -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -851,7 +1102,7 @@ The WeatherUnit parameter specifies the temperature scale that's used to display ```yaml Type: WeatherTemperatureUnit -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -862,6 +1113,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WeekStartDay +The WeekStartDay parameter specifies the first day of the week. Valid values are: + +- Sunday (This is the default value) +- Monday +- Tuesday +- Wednesday +- Thursday +- Friday +- Saturday + +```yaml +Type: DayOfWeek +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -869,7 +1144,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -977,7 +1252,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: Identity, MailboxLocation Aliases: Applicable: Exchange Online @@ -993,12 +1268,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md index 92070545aa..7a30ee7341 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md +++ b/exchange/exchange-ps/exchange/Set-MailboxCalendarFolder.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxcalendarfolder -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxcalendarfolder +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxCalendarFolder schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxCalendarFolder cmdlet to configure calendar publishing or sharing settings on a mailbox for the visibility of calendar information to external users. To add or modify the permissions so internal users can access the calendar, use the Add-MailboxFolderPermission or Set-MailboxFolderPermission cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ The Set-MailboxCalendarFolder cmdlet configures calendar publishing information. - Level of detail to publish for the calendar - Whether the published URL of the calendar is enabled for search on the web -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,7 +87,7 @@ Example values for this parameter are `john@contoso.com:\Calendar` or `John:\Cal Type: MailboxFolderIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -106,7 +106,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -118,10 +118,9 @@ Accept wildcard characters: False ### -DetailLevel The DetailLevel parameter specifies the level of calendar detail that's published and available to anonymous users. Valid values are: -- AvailabilityOnly (This is the default value) +- AvailabilityOnly (default) - LimitedDetails - FullDetails -- Editor This parameter is meaningful only when the PublishEnabled parameter value is $true. @@ -285,17 +284,19 @@ This parameter is available only in the cloud-based service. **Note**: This parameter is supported only for shared calendars that have been upgraded as described in [Calendar sharing in Microsoft 365](https://support.microsoft.com/office/365-b576ecc3-0945-4d75-85f1-5efafb8a37b4), and is not applicable to any other type of calendar or mailbox folder. -The SharedCalendarSyncStartDate parameter specifies the limit for past events that are visible to users who have access to the specified shared calendar. A copy of the shared calendar with events that go back as far as the value specified by this parameter is stored in the user's mailbox. +The SharedCalendarSyncStartDate parameter specifies the limit for past events in the shared calendar that are visible to delegates. A copy of the shared calendar within the specified date range is stored in the delegate's mailbox. To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). **Notes**: +- You use this parameter on the shared calendar in the delegate's mailbox. For example, `Set-MailboxCalendarFolder -Identity delegate@contoso.onmicrosoft.com:DelegateSharedCalendarFolderId" -SharedCalendarSyncStartDate (Get-Date "5/6/2023 9:30 AM").ToUniversalTime()`. DelegateSharedCalendarFolderId is the FolderId of the shared calendar in the delegate's mailbox (for example, `Get-MailboxFolderStatistics -Identity delegate@contoso.onmicrosoft.com -FolderScope Calendar | Format-List Name,FolderId`). - Users need to have FullDetails, Editor, or Delegate access to the specified shared calendar. - Setting this parameter might cause events in the shared calendar to briefly disappear from view while the calendar is resynchronized. +- The value of this parameter is used when initializing the calendar folder sync. After that, every new, updated, and deleted item is processed and synced, regardless of the SharedCalendarSyncStartDate parameter value. ```yaml Type: DateTime @@ -313,7 +314,7 @@ Accept wildcard characters: False ### -UseHttps The UseHttps switch specifies whether to use HTTPS for the published URL of the calendar folder. You don't need to specify a value with this switch. -This parameter is meaningful only when the PublishEnabled parameter value is $true. +This switch is meaningful only when the PublishEnabled parameter value is $true. ```yaml Type: SwitchParameter @@ -335,7 +336,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -349,12 +350,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md b/exchange/exchange-ps/exchange/Set-MailboxDatabase.md index 2130639313..bf3cb3151f 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxDatabase.md +++ b/exchange/exchange-ps/exchange/Set-MailboxDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxdatabase applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-MailboxDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MailboxDatabase cmdlet to configure a variety of properties for a mailbox database. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,7 +62,7 @@ Set-MailboxDatabase [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -80,7 +80,7 @@ Set-MailboxDatabase -RpcClientAccessServer ## DESCRIPTION With this cmdlet, you can configure the replay lag time, truncation lag time, and activation preference value for a mailbox database copy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -224,12 +224,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md index 3565044e88..400403f687 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxExportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxexportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-MailboxExportRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MailboxExportRequest cmdlet to change export request options after the request has been created. You can use the Set-MailboxExportRequest cmdlet to recover from failed export requests. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -56,7 +56,7 @@ Set-MailboxExportRequest [-Identity] ## DESCRIPTION You can pipeline the Set-MailboxExportRequest cmdlet from the Get-MailboxExportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -213,8 +213,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -259,7 +259,9 @@ Accept wildcard characters: False ``` ### -RehomeRequest -The RehomeRequest parameter specifies to the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox that's being exported. This parameter is used primarily for debugging purposes. +The RehomeRequest switch tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox that's being exported. You don't need to specify a value with this switch. + +This switch is used primarily for debugging purposes. ```yaml Type: SwitchParameter @@ -366,12 +368,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md b/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md index e160c3f469..52df63f5f3 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md +++ b/exchange/exchange-ps/exchange/Set-MailboxFolderPermission.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxfolderpermission applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-MailboxFolderPermission schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxFolderPermission cmdlet to modify folder-level permissions for users in mailboxes. This cmdlet differs from the Add-MailboxFolderPermission cmdlet in that it modifies existing permission entries. To configure calendar publishing or sharing settings for a mailbox so calendar information is visible to external users, use the Set-MailboxCalendarFolder cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Set-MailboxFolderPermission [-Identity] -AccessRights ## DESCRIPTION In Exchange Online PowerShell, if you don't use the SendNotificationToUser or SharingPermissionFlags parameters, there are no changes to the functionality of the cmdlet. For example, if the user is an existing delegate, and you change their permissions to Editor without using the SendNotificationToUser or SharingPermissionFlags parameters, the user remains a delegate. But, if you use the SendNotificationToUser parameter ($true or $false), the SharingPermissionFlags parameter has the default value None, which can affect delegate access for existing users. For example, you change an existing delegate's permission to Editor, and you use SendNotificationToUser with the value $true. The user will no longer be a delegate and will only have Editor permissions to the folder. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -119,6 +119,7 @@ You can specify individual folder permissions or roles, which are combinations o The following individual permissions are available: +- None: The user has no access to view or interact with the folder or its contents. - CreateItems: The user can create items in the specified folder. - CreateSubfolders: The user can create subfolders in the specified folder. - DeleteAllItems: The user can delete all items in the specified folder. @@ -135,7 +136,6 @@ The roles that are available, along with the permissions that they assign, are d - Author: CreateItems, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems - Contributor: CreateItems, FolderVisible - Editor: CreateItems, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderVisible, ReadItems -- None: FolderVisible - NonEditingAuthor: CreateItems, DeleteOwnedItems, FolderVisible, ReadItems - Owner: CreateItems, CreateSubfolders, DeleteAllItems, DeleteOwnedItems, EditAllItems, EditOwnedItems, FolderContact, FolderOwner, FolderVisible, ReadItems - PublishingAuthor: CreateItems, CreateSubfolders, DeleteOwnedItems, EditOwnedItems, FolderVisible, ReadItems @@ -147,6 +147,8 @@ The following roles apply specifically to calendar folders: - AvailabilityOnly: View only availability data - LimitedDetails: View availability data with subject and location +When the Editor role is applied to calendar folders, delegates can accept or decline meetings by manually selecting the meeting request in the mailbox. In Exchange Online, to send meeting requests to delegates where they can accept or decline meetings, also use the SharingPermissionFlags parameter with the value Delegate. + ```yaml Type: MailboxFolderAccessRight[] Parameter Sets: (All) @@ -161,7 +163,14 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example: +The User parameter specifies the mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user or group. For example: - Name - Alias @@ -293,22 +302,22 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS -[Get-MailboxFolderPermission](Get-MailboxFolderPermission.md) +[Get-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission) -[Add-MailboxFolderPermission](Add-MailboxFolderPermission.md) +[Add-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/add-mailboxfolderpermission) -[Remove-MailboxFolderPermission](Remove-MailboxFolderPermission.md) +[Remove-MailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/remove-mailboxfolderpermission) -[Get-EXOMailboxFolderPermission](Get-EXOMailboxFolderPermission.md) +[Get-EXOMailboxFolderPermission](https://learn.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission) diff --git a/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md b/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md new file mode 100644 index 0000000000..aab760df38 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-MailboxIRMAccess.md @@ -0,0 +1,130 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxirmaccess +applicable: Exchange Online +title: Set-MailboxIRMAccess +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-MailboxIRMAccess + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-MailboxIRMAccess cmdlet to block delegate access to IRM-protected messages in other mailboxes (shared mailboxes or user mailboxes where delegates have Full Access permission). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-MailboxIRMAccess -AccessLevel [-Identity] -User [] +``` + +## DESCRIPTION +> [!NOTE] +> This cmdlet works only for delegates who already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-MailboxIRMAccess -Identity lynette@contoso.onmicrosoft.com -User chris@contoso.onmicrosoft.com -AccessLevel Block +``` + +This example prevents delegate Chris from reading IRM-protected messages in Lynette's mailbox. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: MailboxIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AccessLevel +The AccessLevel parameter specifies what delegates can do to IRM-protected messages in the mailbox that's specified by the Identity parameter. + +The only value for this parameter is Block, which means you can only use this cmdlet to block delegate access to IRM-protected messages in the mailbox. + +To allow access to IRM-protected messages in the mailbox, use the Remove-MailboxIRMAccess cmdlet. + +```yaml +Type: IRMAccessLevel +Parameter Sets: (All) +Aliases: +Accepted values: Block +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -User +**Note**: Delegates that you specify with this parameter must already have Full Access permission to the mailbox. For more information, see [Manage permissions for recipients in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-permissions-for-recipients). + +The User parameter specifies the delegate who is blocked from reading IRM-protected messages in the mailbox. The delegate must be a user mailbox or a mail user. You can use any value that uniquely identifies the delegate. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Domain\\Username +- Email address +- GUID +- LegacyExchangeDN +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: SecurityPrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md index bbc267d8c4..07b606b809 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxImportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboximportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-MailboxImportRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxImportRequest cmdlet to change import request options after the request has been created. You can use the Set-MailboxImportRequest cmdlet to recover from failed import requests. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -57,7 +57,7 @@ Set-MailboxImportRequest [-Identity] [-RehomeR ## DESCRIPTION You can pipeline the Set-MailboxImportRequest cmdlet from the Get-MailboxImportRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -245,8 +245,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -297,7 +297,9 @@ Accept wildcard characters: False ### -RehomeRequest This parameter is available only in on-premises Exchange. -The RehomeRequest parameter specifies to the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox being imported. This parameter is used primarily for debugging purposes. +The RehomeRequest parameter tells the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the mailbox being imported. You don't need to specify a value with this switch. + +This switch is used primarily for debugging purposes. ```yaml Type: SwitchParameter @@ -408,12 +410,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md index e985608667..7392f0f33e 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxJunkEmailConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxjunkemailconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxjunkemailconfiguration +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxJunkEmailConfiguration schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxJunkEmailConfiguration cmdlet to configure the junk email settings on mailboxes. -You can only use this cmdlet on a mailbox that's been opened in Outlook (in Cached Exchange mode) or Outlook on the web. If the mailbox hasn't been opened, you'll receive the error: The Junk Email configuration couldn't be set. The user needs to sign in to Outlook Web App before they can modify their Safe Senders and Recipients or Blocked Senders lists. If you want to suppress this error for bulk operations, you can add -ErrorAction SilentlyContinue to the end of the command. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +27,9 @@ Set-MailboxJunkEmailConfiguration [-Identity] [-ContactsTrusted ] [-DomainController ] [-Enabled ] + [-FailOnError ] [-IgnoreDefaultScope] + [-SenderScreeningEnabled ] [-TrustedListsOnly ] [-TrustedRecipientsAndDomains ] [-TrustedSendersAndDomains ] @@ -40,12 +40,17 @@ Set-MailboxJunkEmailConfiguration [-Identity] ## DESCRIPTION This cmdlet controls the following junk email settings on the mailbox: -- Enable or disable the junk email rule: The junk email rule (a hidden Inbox rule named Junk E-mail Rule) controls the delivery of messages to the Junk Email folder or the Inbox based on the SCL Junk Email Folder threshold (for the organization or the mailbox) and the safelist collection on the mailbox. Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. +- Enable or disable the junk email rule: In on-premises Exchange, the junk email rule (a hidden Inbox rule named Junk E-mail Rule) controls the delivery of messages to the Junk Email folder or the Inbox based on the SCL Junk Email Folder threshold (for the organization or the mailbox) and the safelist collection on the mailbox. + + In the cloud-based service, the junk email rule has no effect on mail flow. Exchange Online Protection delivers messages to the Junk Email folder based on the actions set in anti-spam policies. The junk email rule on the mailbox still controls what happens to messages after delivery based on the safelist collection of the mailbox. + + Users can enable or disable the junk email rule in their own mailbox by using Outlook on the web. + - Configure the safelist collection: The safelist collection is the Safe Senders list, the Safe Recipients list, and the Blocked Senders list. Users can configure the safelist collection on their own mailbox by using Microsoft Outlook or Outlook on the web. -For more information, see [Configure Exchange antispam settings on mailboxes](https://docs.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-antispam-settings). +For more information, see [Configure Exchange antispam settings on mailboxes](https://learn.microsoft.com/Exchange/antispam-and-antimalware/antispam-protection/configure-antispam-settings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -54,7 +59,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-MailboxJunkEmailConfiguration "David Pelton" -Enabled $false ``` -This example disables the junk email rule configuration for the user named David Pelton. +This example disables the junk email rule for the user named David Pelton. In on-premises Exchange, messages are no longer moved between the Inbox and the Junk Email folder based on the SCL Junk Email Folder threshold (organization or mailbox) or the safelist collection of the mailbox. In Exchange Online, the safelist collection of the mailbox is unable to move messages between the Inbox and the Junk Email folder. Messages are still delivered to the Junk Email folder based on the verdict and corresponding action of anti-spam policies. ### Example 2 ```powershell @@ -93,7 +98,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -132,7 +137,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -181,8 +186,17 @@ Accept wildcard characters: False ### -Enabled The Enabled parameter enables or disables the junk email rule on the mailbox (a hidden Inbox rule named Junk E-mail Rule). Valid values are: -- $true: The junk email rule is enabled in the mailbox. This value corresponds to the Outlook on the web setting: Automatically filter junk email. This is the default value. Exchange use the safelist collection of the mailbox (the Safe Senders list, Safe Recipients list, and Blocked Senders list), and the SCL Junk Email folder threshold (for the organization or the mailbox) to deliver messages to the Inbox or the Junk Email folder. -- $false: The junk email rule is disabled in the mailbox. This value corresponds to the Outlook on the web setting: Don't move email to my Junk Email folder. Exchange doesn't use the safelist collection of the mailbox or the SCL Junk Email folder threshold to deliver messages to the Inbox or the Junk Email folder. +- $true: The junk email rule is enabled in the mailbox. This value corresponds to the Outlook on the web setting: Automatically filter junk email. This is the default value. + + In on-premises Exchange, the safelist collection of the mailbox (the Safe Senders list, Safe Recipients list, and Blocked Senders list), and the SCL Junk Email folder threshold (for the organization or the mailbox) delivers messages to the Inbox or the Junk Email folder. + + In the cloud-based service, the safelist collection of the mailbox moves delivered messages between the Inbox or the Junk Email folder. Messages are delivered to the Junk Email folder based on the verdict and corresponding action of anti-spam policies only. + +- $false: The junk email rule is disabled in the mailbox. This value corresponds to the Outlook on the web setting: Don't move email to my Junk Email folder. + + In on-premises Exchange, the safelist collection of the mailbox or the SCL Junk Email folder threshold are unable to deliver messages to the Inbox or the Junk Email folder. + + In the cloud-based service, the safelist collection of the mailbox is unable to move delivered messages between the Inbox or the Junk Email folder. Messages are still delivered to the Junk Email folder based on the verdict and corresponding action of anti-spam policies. You can view the status of the junk email rule by running either of the following commands to find the Enabled property value: @@ -204,10 +218,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FailOnError +This parameter is available only in the cloud-based service. + +{{ Fill FailOnError Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -225,6 +257,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SenderScreeningEnabled +This parameter is available only in the cloud-based service. + +{{ Fill SenderScreeningEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TrustedListsOnly The TrustedListsOnly parameter specifies that only messages from senders in the Safe Senders list are delivered to the Inbox. All other messages are treated as junk email. This parameter corresponds to the Outlook on the web setting: Don't trust email unless it comes from someone in my Safe Senders and Recipients list. Valid values are: @@ -271,9 +321,9 @@ To empty the list of email addresses and domains, use the value $null. **Notes**: -- All email addresses in the global address list (GAL) are automatically considered as trusted senders, so you don't need to add them to the list. +- You can't add sender email addresses from the same domain as the recipient's email address. All mailboxes in the global address list (GAL) are automatically considered as trusted senders. - You can't directly modify the Safe Recipients list by using this cmdlet. You use this parameter to modify the Safe Senders list, and the email addresses and domains are synchronized to the Safe Recipients list. -- Safe domains aren't recognized in Exchange Online and Exchange Online Protection. For more information, see [KB3019657](https://support.microsoft.com/help/3019657). +- In standalone EOP with directory synchronization, domain entries aren't synchronized by default, but you can enable synchronization for domains. For more information, see [Configure Content Filtering to Use Safe Domain Data](/exchange/configure-content-filtering-to-use-safe-domain-data-exchange-2013-help). ```yaml Type: MultiValuedProperty @@ -295,7 +345,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -309,12 +359,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md index e54ec049cf..047f4af452 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxMessageConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxmessageconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxmessageconfiguration +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxMessageConfiguration schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxMessageConfiguration cmdlet to configure the Outlook on the web settings that are applied to specific mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,6 +29,7 @@ Set-MailboxMessageConfiguration [-Identity] [-AutoAddSignatureOnMobile ] [-AutoAddSignatureOnReply ] [-CheckForForgottenAttachments ] + [-CheckForReportJunkDialog ] [-Confirm] [-ConversationSortOrder ] [-DefaultFontColor ] @@ -36,42 +37,63 @@ Set-MailboxMessageConfiguration [-Identity] [-DefaultFontName ] [-DefaultFontSize ] [-DefaultFormat ] + [-DefaultSignature ] + [-DefaultSignatureOnReply ] + [-DeleteSignatureName ] + [-DisplayDensityMode ] [-DomainController ] [-EchoGroupMessageBackToSubscribedSender ] [-EmailComposeMode ] [-EmptyDeletedItemsOnLogoff ] + [-FavoritesBitFlags ] [-GlobalReadingPanePosition ] [-HideDeletedItems ] [-IgnoreDefaultScope] + [-IsDarkModeTheme ] [-IsFavoritesFolderTreeCollapsed ] + [-IsFocusedInboxEnabled ] [-IsMailRootFolderTreeCollapsed ] [-IsReplyAllTheDefaultResponse ] [-LinkPreviewEnabled ] [-MailFolderPaneExpanded ] + [-MailSendUndoInterval ] + [-ManuallyPickCertificate ] + [-NavigationBarWidth ] [-NavigationPaneViewOption ] + [-NewEnabledPonts ] [-NewItemNotification ] [-PreferAccessibleContent ] [-PreviewMarkAsReadBehavior ] [-PreviewMarkAsReadDelaytime ] [-ReadReceiptResponse ] + [-ReportJunkSelected ] [-SendAddressDefault ] [-ShowConversationAsTree ] + [-ShowInlinePreviews ] + [-ShowNotificationBar ] [-ShowPreviewTextInListView ] [-ShowReadingPaneOnFirstLoad ] [-ShowSenderOnTopInListView ] [-ShowUpNext ] [-SignatureHtml ] + [-SignatureHtmlBody ] + [-SignatureName ] [-SignatureText ] [-SignatureTextOnMobile ] + [-SigningCertificateId ] + [-SigningCertificateSubject ] + [-SmimeEncrypt ] + [-SmimeSign ] [-UseDefaultSignatureOnMobile ] + [-WebSuggestedRepliesEnabledForUser ] [-WhatIf] [] ``` ## DESCRIPTION -The Set-MailboxMessageConfiguration cmdlet configures Outlook on the web settings for the specified mailbox. These settings include email signature, message format, message options, read receipts, reading pane, and conversations. These settings are not used in Outlook, Exchange ActiveSync, or other email clients. These settings are applied in Outlook on the web only. Settings that contain the word Mobile are applied in Outlook on the web for devices only. +The Set-MailboxMessageConfiguration cmdlet configures Outlook on the web settings for the specified mailbox. These settings include email signature, message format, message options, read receipts, reading pane, and conversations. These settings are not used in Outlook, Exchange ActiveSync, or other email clients. These settings are applied in Outlook on the web only. Some settings also apply to the new Outlook client. Settings that contain the word Mobile are applied in Outlook on the web for devices only. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,7 +131,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -177,6 +199,8 @@ Accept wildcard characters: False ``` ### -AutoAddSignature +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + The AutoAddSignature parameter specifies whether to automatically add signatures to new email messages created in Outlook on the web. Valid values are: - $true: Email signatures are automatically added to new messages. @@ -198,6 +222,8 @@ Accept wildcard characters: False ``` ### -AutoAddSignatureOnMobile +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + The AutoAddSignatureOnMobile parameter automatically adds the signature specified by the SignatureTextOnMobile parameter to messages when the user creates messages in Outlook on the web for devices. Valid input for this parameter is $true or $false. The default value is $false. @@ -256,6 +282,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CheckForReportJunkDialog +This parameter is available only in the cloud-based service. + +{{ Fill CheckForReportJunkDialog Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -266,7 +310,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -395,6 +439,78 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultSignature +This parameter is available only in the cloud-based service. + +{{ Fill DefaultSignature Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultSignatureOnReply +This parameter is available only in the cloud-based service. + +{{ Fill DefaultSignatureOnReply Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeleteSignatureName +This parameter is available only in the cloud-based service. + +{{ Fill DeleteSignatureName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayDensityMode +This parameter is available only in the cloud-based service. + +{{ Fill DisplayDensityMode Description }} + +```yaml +Type: DisplayDensityMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController This parameter is available only in on-premises Exchange. @@ -416,7 +532,10 @@ Accept wildcard characters: False ### -EchoGroupMessageBackToSubscribedSender This parameter is available only in the cloud-based service. -{{ Fill EchoGroupMessageBackToSubscribedSender Description }} +The EchoGroupMessageBackToSubscribedSender parameter controls whether subscribed members of Microsoft 365 Groups receive copies of messages that they send to those Groups. Valid values are: + +- $true: If a subscribed member of a Microsoft 365 Group sends a message to that Group, they'll receive a copy of the message in their Inbox. +- $false: Subscribed members of a Microsoft 365 Group don't receive their own copies of messages that they send to the Group. This is the default value. ```yaml Type: Boolean @@ -432,7 +551,7 @@ Accept wildcard characters: False ``` ### -EmailComposeMode -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The EmailComposeMode parameter specifies how the user creates messages in Outlook on the web. You can use the following values: @@ -470,7 +589,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FavoritesBitFlags +This parameter is available only in the cloud-based service. + +{{ Fill FavoritesBitFlags Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GlobalReadingPanePosition +This parameter is functional only in Exchange 2016 or later. It doesn't work in Exchange Online. + The GlobalReadingPanePosition specifies the default location of the reading pane in Outlook on the web. Valid values are: - Off @@ -509,9 +648,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -529,6 +668,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsDarkModeTheme +This parameter is available only in the cloud-based service. + +{{ Fill IsDarkModeTheme Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IsFavoritesFolderTreeCollapsed The IsFavoritesFolderTreeCollapsed parameter specifies whether to collapse the Favorites folder tree by default in Outlook on the web. Valid values are: @@ -548,6 +705,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsFocusedInboxEnabled +This parameter is available only in the cloud-based service. + +{{ Fill IsFocusedInboxEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IsMailRootFolderTreeCollapsed The IsMailRootFolderTreeCollapsed parameter specifies whether to collapse the Mail root folder tree by default in Outlook on the web. Valid values are: @@ -626,6 +801,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailSendUndoInterval +This parameter is available only in the cloud-based service. + +{{ Fill MailSendUndoInterval Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManuallyPickCertificate +This parameter is available only in the cloud-based service. + +{{ Fill ManuallyPickCertificate Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NavigationBarWidth +This parameter is available only in the cloud-based service. + +{{ Fill NavigationBarWidth Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NavigationPaneViewOption The NavigationPaneViewOption parameter specifies the default navigation pane view in Outlook on the web. Valid values are: @@ -648,6 +877,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NewEnabledPonts +This parameter is available only in the cloud-based service. + +{{ Fill NewEnabledPonts Description }} + +```yaml +Type: PontType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NewItemNotification The NewItemNotification parameter specifies how to provide notification for the arrival of new items for the user in Outlook on the web. You can use the following values: @@ -756,6 +1003,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReportJunkSelected +This parameter is available only in the cloud-based service. + +{{ Fill ReportJunkSelected Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SendAddressDefault This parameter is available only in the cloud-based service. @@ -772,7 +1037,7 @@ By default, no default From address is specified on the mailbox. When no default - The primary email address on the mailbox is used for all new messages. - The To address of the incoming message is used as the From address for all replies or forwarded messages. -You can find the available values for SendAddressDefault on a mailbox by running the command `Get-SendAddress -Mailbox `. +You can find the available values for SendAddressDefault on a mailbox by running the command: `Get-MailboxMessageConfiguration -Mailbox | Format-List SendAddressDefault`. ```yaml Type: String @@ -805,6 +1070,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ShowInlinePreviews +This parameter is available only in the cloud-based service. + +{{ Fill ShowInlinePreviews Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowNotificationBar +This parameter is available only in the cloud-based service. + +{{ Fill ShowNotificationBar Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ShowPreviewTextInListView The ShowPreviewTextInListView parameter specifies whether to show preview text for messages in list view in Outlook on the web. Valid values are: @@ -882,6 +1183,8 @@ Accept wildcard characters: False ``` ### -SignatureHtml +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + The SignatureHtml parameter specifies the email signature that's available to the user in HTML-formatted messages in Outlook on the web. You can use plain text or text with HTML tags. However, any JavaScript code is removed. To automatically add this email signature to HTML-formatted messages created by the user in Outlook on the web, the AutoAddSignature parameter must be set to $true. @@ -899,7 +1202,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SignatureHtmlBody +This parameter is available only in the cloud-based service. + +{{ Fill SignatureHtmlBody Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SignatureName +This parameter is available only in the cloud-based service. + +{{ Fill SignatureName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SignatureText +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + The SignatureText parameter specifies the email signature that's available to the user in plain text messages in Outlook on the web. This parameter supports all Unicode characters. To automatically add the email signature to plain text messages created by the user in Outlook on the web, the AutoAddSignature parameter must be set to the value $true. @@ -918,6 +1259,8 @@ Accept wildcard characters: False ``` ### -SignatureTextOnMobile +**Note**: This parameter doesn't work if the Outlook roaming signatures feature is enabled in your cloud-based organization. Admins can now temporarily disable roaming signatures without opening a support ticket by using the PostponeRoamingSignaturesUntilLater parameter on the Set-OrganizationConfig cmdlet. + The SignatureTextOnMobile parameter specifies the email signature that's available in messages created by the user in Outlook on the web for devices. This parameter supports all Unicode characters. To automatically add the email signature to messages created by the user in Outlook on the web for devices, the AutoAddSignatureOnMobile parameter must be set to the value $true. @@ -935,6 +1278,78 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SigningCertificateId +This parameter is available only in the cloud-based service. + +{{ Fill SigningCertificateId Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SigningCertificateSubject +This parameter is available only in the cloud-based service. + +{{ Fill SigningCertificateSubject Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmimeEncrypt +This parameter is available only in the cloud-based service. + +{{ Fill SmimeEncrypt Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SmimeSign +This parameter is available only in the cloud-based service. + +{{ Fill SmimeSign Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UseDefaultSignatureOnMobile The UseDefaultSignatureOnMobile parameter specifies whether to add the default email signature to messages created by the user in Outlook on the web for devices. The user configures the default signature in Outlook. @@ -953,6 +1368,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -WebSuggestedRepliesEnabledForUser +This parameter is available only in the cloud-based service. + +{{ Fill WebSuggestedRepliesEnabledForUser Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -960,7 +1393,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -974,12 +1407,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxPlan.md b/exchange/exchange-ps/exchange/Set-MailboxPlan.md index cb2a364bfc..96b60c149b 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxPlan.md +++ b/exchange/exchange-ps/exchange/Set-MailboxPlan.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxplan -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxplan +applicable: Exchange Online, Exchange Online Protection title: Set-MailboxPlan schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-MailboxPlan cmdlet to modify the settings of mailbox plans in the cloud-based service. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +45,7 @@ Modifying the settings in a mailbox plan doesn't affect existing mailboxes that Each mailbox plan has a corresponding Client Access services (CAS) mailbox plan with the same name and display name value. You can use the Set-CasMailboxPlan cmdlet to enable or disable POP3, IMAP4 or Exchange ActiveSync (EAS) access to new or newly-enabled mailboxes, and you can specify the Outlook on the web (formerly known as Outlook Web App) mailbox policy for the mailboxes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -73,7 +71,7 @@ The Identity parameter specifies the mailbox plan that you want to modify. You c Type: MailboxPlanIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -92,7 +90,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -102,7 +100,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -314,7 +314,7 @@ The RetainDeletedItemsFor parameter specifies the length of time to keep soft-de These actions move the items to the Recoverable Items folder, into a subfolder named Deletions. -Before the deleted item retention period expires, users can recover soft-deleted items in Outlook and Outlook on the web by using the Recover Deleted Items feature. For more information, see [Recoverable Items folder in Exchange Online](https://docs.microsoft.com/Exchange/security-and-compliance/recoverable-items-folder/recoverable-items-folder). +Before the deleted item retention period expires, users can recover soft-deleted items in Outlook and Outlook on the web by using the Recover Deleted Items feature. For more information, see [Recoverable Items folder in Exchange Online](https://learn.microsoft.com/Exchange/security-and-compliance/recoverable-items-folder/recoverable-items-folder). To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -334,15 +334,25 @@ Accept wildcard characters: False ``` ### -RetentionPolicy -The RetentionPolicy parameter specifies the retention policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example: +The RetentionPolicy parameter specifies the retention policy that's applied to new mailboxes that you create. You can use any value that uniquely identifies the policy. For example: - Name - Distinguished Name (DN) - GUID -Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. The default value is Default MRM Policy. +Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained. Use the Get-RetentionPolicy cmdlet to see the available retention policies. + +By default, the value of this parameter is blank ($null), which means the default retention policy (the retention policy where the IsDefault property value is True) is assigned to new mailboxes. By default, the default retention policy is named Default MRM Policy. -Use the Get-RetentionPolicy cmdlet to see the available retention policies. +If you don't set a value for this parameter, existing mailboxes are also updated if you change which retention policy is the default by using the IsDefault switch on the New-RetentionPolicy or Set-RetentionPolicy cmdlets. + +**Note**: Specifying a value for this parameter has the following potential issues: + +- If the value of this parameter is not blank ($null), then the specified retention policy must be the default Exchange retention policy that's configured for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. +- If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. +- Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. + +For more information, see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). ```yaml Type: MailboxPolicyIdParameter @@ -388,7 +398,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -402,12 +412,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md index 5364e071e2..ef75fd3f02 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxRegionalConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxregionalconfiguration +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxRegionalConfiguration schema: 2.0.0 author: chrisda @@ -16,16 +16,41 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxRegionalConfiguration cmdlet to modify the regional settings of a mailbox. You can modify the date format, time format, time zone and language of the mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX +### Default ``` -Set-MailboxRegionalConfiguration [-Identity] - [-Archive] +Set-MailboxRegionalConfiguration [-Identity] [-DomainController ] + [-Confirm] + [-DateFormat ] + [-Language ] + [-LocalizeDefaultFolderName] + [-TimeFormat ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### Identity +``` +Set-MailboxRegionalConfiguration [-Identity] [-Archive] [-UseCustomRouting] + [-Confirm] + [-DateFormat ] + [-Language ] + [-LocalizeDefaultFolderName] + [-TimeFormat ] + [-TimeZone ] + [-WhatIf] + [] +``` + +### MailboxLocation +``` +Set-MailboxRegionalConfiguration [-MailboxLocation ] [-UseCustomRouting] [-Confirm] [-DateFormat ] - [-DomainController ] [-Language ] [-LocalizeDefaultFolderName] [-TimeFormat ] @@ -37,7 +62,7 @@ Set-MailboxRegionalConfiguration [-Identity] ## DESCRIPTION As shown in Example 5, you might need to set the DateFormat and TimeFormat parameter values to $null when you change the Language parameter value and you receive an error about invalid DateFormat values. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,7 +75,7 @@ This example sets Marcelo Teixeira's mailbox language to Brazilian Portuguese, a ### Example 2 ```powershell -Set-MailboxRegionalConfiguration -Identity "Ella Lack's" -DateFormat "d/m/yyyy" +Set-MailboxRegionalConfiguration -Identity "Ella Lack's" -DateFormat "d/M/yyyy" ``` This example sets the date format for Ella Lack's mailbox. @@ -67,7 +92,7 @@ This example sets Alice Jakobsen's mailbox language to Danish Denmark, sets the Get-Mailbox -RecipientTypeDetails UserMailbox -ResultSize Unlimited | Set-MailboxRegionalConfiguration -Language es-es -DateFormat "dd/MM/yyyy" -TimeFormat H:mm -LocalizeDefaultFolderName ``` -This example sets all User Mailboxes language to Spanish Spain, sets the date in the day/month/year format, sets the time in the H:mm format and localizes the default forder names in Spanish. +This example sets all User Mailboxes language to Spanish Spain, sets the date in the day/month/year format, sets the time in the H:mm format and localizes the default folder names in Spanish. ### Example 5 ```powershell @@ -94,9 +119,9 @@ The Identity parameter specifies the mailbox that you want to modify. You can us ```yaml Type: MailboxIdParameter -Parameter Sets: (All) +Parameter Sets: Default, Identity Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -112,7 +137,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Identity Aliases: Applicable: Exchange Online @@ -133,7 +158,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -153,7 +178,7 @@ The DateFormat parameter specifies a valid date format based on the current or s - yyyy-MM-dd - dd-MMM-yy -For more information about the date format strings, see [Standard Date and Time Format Strings](https://docs.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). +For more information about the date format strings, see [Standard Date and Time Format Strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). ```yaml Type: String @@ -175,7 +200,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: Default Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -189,7 +214,7 @@ Accept wildcard characters: False ### -Language The Language parameter specifies the language for the mailbox. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -204,6 +229,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxLocation +This parameter is available only in the cloud-based service. + +{{ Fill MailboxLocation Description }} + +```yaml +Type: MailboxLocationIdParameter +Parameter Sets: MailboxLocation +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocalizeDefaultFolderName The LocalizeDefaultFolderName switch localizes the default folder names of the mailbox in the current or specified language. You don't need to specify a value with this switch. @@ -228,7 +271,7 @@ The TimeFormat parameter specifies a valid time format based on the current or s - H:mm - HH:mm -For more information about the time format strings, see [Standard Date and Time Format Strings](https://docs.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). +For more information about the time format strings, see [Standard Date and Time Format Strings](https://learn.microsoft.com/dotnet/standard/base-types/standard-date-and-time-format-strings). ```yaml Type: String @@ -265,6 +308,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseCustomRouting +This parameter is available only in the cloud-based service. + +{{ Fill UseCustomRouting Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, MailboxLocation +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -272,7 +333,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -286,12 +347,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md index 6d23547ee0..a874cb3a60 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Set-MailboxRestoreRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxrestorerequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxrestorerequest +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxRestoreRequest schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxRestoreRequest cmdlet to change restore request options after the request has been created. You can use this cmdlet to recover from failed restore requests. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,6 +37,8 @@ Set-MailboxRestoreRequest [-Identity] [-SkipInitialConnectionValidation] [-SkipMerging ] [-SkippedItemApprovalTime ] + [-SourceWlmLevel ] + [-TargetWlmLevel ] [-WhatIf] [] ``` @@ -51,12 +53,14 @@ Set-MailboxRestoreRequest [-Identity] [-RequestExpiryInterval ] [-SkipInitialConnectionValidation] [-SkippedItemApprovalTime ] + [-SourceWlmLevel ] + [-TargetWlmLevel ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -85,7 +89,7 @@ If you didn't specify a name for the restore request when it was created, Exchan Type: MailboxRestoreRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -180,7 +184,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -190,7 +194,7 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -208,7 +212,7 @@ Accept wildcard characters: False ``` ### -InternalFlags -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes. @@ -230,8 +234,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -253,7 +257,7 @@ Accept wildcard characters: False ``` ### -Priority -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are: @@ -280,9 +284,11 @@ Accept wildcard characters: False ``` ### -RehomeRequest -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. + +The RehomeRequest switch moves the mailbox restore request to a different mailbox database. You don't need to specify a value with this switch. -The RehomeRequest switch specifies that the mailbox restore request be moved to a different mailbox database. Use this parameter to edit a mailbox restore request in the case where the source mailbox database from the original move request has to be removed. +Use this switch to edit a mailbox restore request in the case where the source mailbox database from the original move request has to be removed. ```yaml Type: SwitchParameter @@ -395,6 +401,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SourceWlmLevel +This parameter is available only in the cloud-based service. + +{{ Fill SourceWlmLevel Description }} + +```yaml +Type: WlmLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetWlmLevel +This parameter is available only in the cloud-based service. + +{{ Fill TargetWlmLevel Description }} + +```yaml +Type: WlmLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. @@ -402,7 +444,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -416,12 +458,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxSearch.md b/exchange/exchange-ps/exchange/Set-MailboxSearch.md index d000948964..ee2ec50572 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxsearch -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxsearch +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxSearch schema: 2.0.0 author: chrisda @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxSearch cmdlet to modify an existing mailbox search. -**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,15 +62,15 @@ By default, mailbox searches are performed across all Exchange 2013 or later Mai If the In-Place eDiscovery search you want to modify is running, stop it before using the Set-MailboxSearch cmdlet. When restarting a search, any previous search results are removed from the target mailbox. -For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/holds/holds). +For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and [In-Place Hold and Litigation Hold in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/holds/holds). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-MailboxSearch -Identity "Legal-ProjectX" -StartDate "01/01/2016" +Set-MailboxSearch -Identity "Legal-ProjectX" -StartDate "01/01/2017" ``` This example modifies the start date of a mailbox search. @@ -150,7 +150,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -196,7 +196,9 @@ Accept wildcard characters: False ### -DoNotIncludeArchive This parameter is available only in Exchange Server 2010. -The DoNotIncludeArchive parameter specifies whether items in the user's Archive mailbox are included in mailbox searches. By default, items in the user's Archive mailbox are included in mailbox searches. If set to $true, the DoNotIncludeArchive parameter instructs Multi-Mailbox Search to exclude archive mailboxes from the search. +The DoNotIncludeArchive switch excludes items in the user's Archive mailbox from mailbox searches. You don't need to specify a value with this switch. + +By default, items in the user's Archive mailbox are included in mailbox searches. ```yaml Type: SwitchParameter @@ -214,7 +216,7 @@ Accept wildcard characters: False ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". To clear the end date, use the value $null. @@ -232,10 +234,7 @@ Accept wildcard characters: False ``` ### -EstimateOnly -The EstimateOnly parameter specifies whether to provide only an estimate of the number of items that will be returned. Valid values are: - -- $true: Messages aren't copied to the target mailbox, and only an estimate of the number of items is returned. -- $false: Messages are copied to the target mailbox. +The EstimateOnly switch provides only an estimate of the number of items that will be returned without copying message to the target mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -270,9 +269,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. -Use this to switch suppress the confirmation prompt that indicates the previous search results will be removed from the target mailbox, and that the search will be restarted. +Use this to switch to hide the confirmation prompt that indicates the previous search results will be removed from the target mailbox, and that the search will be restarted. ```yaml Type: SwitchParameter @@ -338,7 +337,7 @@ If you attempt to place a hold but don't specify mailboxes using the SourceMailb Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -357,7 +356,7 @@ The ItemHoldPeriod parameter specifies the number of days for the In-Place Hold Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -369,7 +368,7 @@ Accept wildcard characters: False ### -Language The Language parameter specifies a locale for the mailbox search. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -492,7 +491,7 @@ Accept wildcard characters: False ``` ### -SearchQuery -The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +The SearchQuery parameter specifies keywords for the search query by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). If you use this parameter with other search query parameters, the query combines these parameters by using the AND operator. @@ -574,7 +573,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". To clear start date, use the value $null. @@ -666,7 +665,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -680,12 +679,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md index 844f00238c..fc78cfa732 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSentItemsConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxsentitemsconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxsentitemsconfiguration applicable: Exchange Server 2010 title: Set-MailboxSentItemsConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-MailboxSentItemsConfiguration cmdlet to modify the Sent Items settings for mailboxes in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Set-MailboxSentItemsConfiguration [-Confirm] ## DESCRIPTION By default, when you use Send As or Send On Behalf Of to send a message from another mailbox, the message is saved in your Sent Items folder (not in the Sent Items folder of the source mailbox). In Microsoft Exchange Server 2010 Service Pack 3 (SP3), you can save copies messages in the Sent Items folder of the sender and the source mailbox. For example, consider a shared mailbox that receives customer feedback and is monitored by multiple users. When someone responds to a message in the shared mailbox, you can save the message in the Sent Items folder of the shared mailbox and the sender's mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -167,12 +167,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MailboxServer.md b/exchange/exchange-ps/exchange/Set-MailboxServer.md index 08f9f6b8ac..1e8ce40d3a 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxServer.md +++ b/exchange/exchange-ps/exchange/Set-MailboxServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxserver +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-MailboxServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MailboxServer cmdlet to modify the mailbox configuration settings and attributes of Mailbox servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -130,7 +130,7 @@ Set-MailboxServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -251,7 +251,11 @@ Accept wildcard characters: False ``` ### -CalendarRepairIntervalEndWindow -The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendar items in mailboxes on the Mailbox server. The default value is 30. This means the Calendar Repair Assistant repairs meetings in calendars up to 30 days from now. Meetings that are scheduled to occur more than 30 days in the future aren't repaired. +The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendar items in mailboxes on the Mailbox server. + +The default value in Exchange 2016 and Exchange 2019 is 7. This value means the Calendar Repair Assistant repairs meetings in calendars up to 7 days from now. Meetings that are scheduled to occur more than 7 days in the future aren't repaired. + +The default value in Exchange 2013 and Exchange 2010 is 30. This value means the Calendar Repair Assistant repairs meetings in calendars up to 30 days from now. Meetings that are scheduled to occur more than 30 days in the future aren't repaired. ```yaml Type: Int32 @@ -1007,7 +1011,7 @@ The Locale parameter specifies the locale of the Mailbox server. A locale is a c - de-AT (German - Austria) - es-CL (Spanish - Chile) -For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -1185,7 +1189,7 @@ Accept wildcard characters: False ``` ### -ManagedFolderAssistantSchedule -**Note**: Although this parameter is available in Exchange 2016 and Exchange 2019, it's only used for coexistence with previous versions of Exchange. For more information, see [Configure and run the Managed Folder Assistant in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/mrm/configure-managed-folder-assistant). +**Note**: Although this parameter is available in Exchange 2016 and Exchange 2019, it's only used for coexistence with previous versions of Exchange. For more information, see [Configure and run the Managed Folder Assistant in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/configure-managed-folder-assistant). The ManagedFolderAssistantSchedule parameter specifies the intervals each week during which the Managed Folder Assistant applies messaging records management (MRM) settings to managed folders in mailboxes on the Mailbox server. @@ -1866,7 +1870,7 @@ This parameter is available only in Exchange Server 2010 or Exchange Server 2013 The SharingPolicyWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be scanned by the Sharing Policy Assistant. The default value is 1 day. -The Sharing Policy Assistant scans all mailboxes and enables or disables sharing polices according to the interval specified by the SharingPolicyWorkCycle. +The Sharing Policy Assistant scans all mailboxes and enables or disables sharing policies according to the interval specified by the SharingPolicyWorkCycle. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes and s = seconds. @@ -2352,12 +2356,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md b/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md index b69c6fa4d1..975a5bcb45 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md +++ b/exchange/exchange-ps/exchange/Set-MailboxSpellingConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxspellingconfiguration -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxspellingconfiguration +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MailboxSpellingConfiguration schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MailboxSpellingConfiguration cmdlet to modify Outlook on the web spelling checker options for a specified user. For example, you can set the dictionary language and configure the spelling checker to ignore mixed digits or words in all uppercase. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Set-MailboxSpellingConfiguration [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,7 +71,7 @@ The Identity parameter specifies the mailbox that you want to modify. You can us Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -106,7 +106,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,7 +212,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -226,12 +226,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MailboxTransportService.md b/exchange/exchange-ps/exchange/Set-MailboxTransportService.md index e5fa77d3ff..ae787b004f 100644 --- a/exchange/exchange-ps/exchange/Set-MailboxTransportService.md +++ b/exchange/exchange-ps/exchange/Set-MailboxTransportService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mailboxtransportservice +online version: https://learn.microsoft.com/powershell/module/exchange/set-mailboxtransportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-MailboxTransportService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MailboxTransportService cmdlet to modify the configuration of the Mailbox Transport service on Exchange 2013 or later Mailbox servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -71,7 +71,7 @@ Set-MailboxTransportService [-Identity] ## DESCRIPTION The Mailbox Transport service runs on all Mailbox servers and is responsible for delivering messages to and accepting messages from local mailbox databases using a remote procedure call (RPC). The Mailbox Transport service also uses SMTP to send messages to and from the Transport service that runs on all Mailbox servers for routing messages to their ultimate destinations. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -1027,12 +1027,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md index 986e826019..97910b18d9 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-malwarefilterpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilterpolicy applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MalwareFilterPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MalwareFilterPolicy cmdlet to modify malware filter policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,16 +42,19 @@ Set-MalwareFilterPolicy [-Identity] [-EnableInternalSenderAdminNotifications ] [-EnableInternalSenderNotifications ] [-ExternalSenderAdminAddress ] + [-FileTypeAction ] [-FileTypes ] [-InternalSenderAdminAddress ] + [-IsPolicyOverrideApplied ] [-MakeDefault] + [-QuarantineTag ] [-WhatIf] [-ZapEnabled ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,7 +63,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-MalwareFilterPolicy -Identity "Contoso Malware Filter Policy" -Action DeleteMessage -EnableInternalSenderAdminNotifications $true -InternalSenderAdminAddress admin@contoso.com ``` -This example modifies the malware filter policy named Contoso Malware Filter Policy with the following settings: +In on-premises Exchange, this example modifies the malware filter policy named Contoso Malware Filter Policy with the following settings: - Delete messages that contain malware. - Don't notify the message sender when malware is detected in the message. @@ -69,24 +72,30 @@ This example modifies the malware filter policy named Contoso Malware Filter Pol ### Example 2 ```powershell $FileTypesAdd = Get-MalwareFilterPolicy -Identity Default | select -Expand FileTypes -$FileTypesAdd += "com","bat" + +$FileTypesAdd += "dgz","mde" + Set-MalwareFilterPolicy -Identity Default -EnableFileFilter $true -FileTypes $FileTypesAdd ``` -This example enables common attachment blocking in the malware filter policy named Default and adds the file types "com" and "bat" without affecting the other file type entries. +This example enables the common attachments filter in the malware filter policy named Default and adds the file types "dgz" and "mde" without affecting the other file type entries. ### Example 3 ```powershell $ft = Get-MalwareFilterPolicy -Identity Default + $a = [System.Collections.ArrayList]($ft.FileTypes) + $a + $a.RemoveAt(6) + Set-MalwareFilterPolicy -Identity Default -FileTypes $a ``` -This example modifies the malware filter policy named Default by removing an existing file type from common attachment blocking without affecting other file types that are already defined. +This example modifies the malware filter policy named Default by removing an existing file type from the common attachments filter without affecting other file types that are already specified. -The first three commands return the existing list of file types. The first file type in the list has the index number 0, the second has the index number 1, and so on. You use the index number to specify the file type that you want to remove. +The first three commands return the existing list of file types. The first file type in the list has the index number 0, the second has the index number 1, and so on. Use the index number to specify the file type that you want to remove. The last two commands remove the seventh file type that's displayed in the list. @@ -113,17 +122,19 @@ Accept wildcard characters: False ``` ### -Action +This parameter is available only in on-premises Exchange. + The Action parameter specifies the action to take when malware is detected in a message. Valid values are: -- DeleteMessage: Handles the message without notifying the recipients. This is the default value. In Exchange Server, the message is deleted. In the cloud-based service, the message is quarantined. -- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. In the cloud-based service, the message with the original attachments is also quarantined. -- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. In the cloud-based service, the message with the original attachments is also quarantined. +- DeleteMessage: Handles the message without notifying the recipients. This is the default value. +- DeleteAttachmentAndUseDefaultAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the default alert text. +- DeleteAttachmentAndUseCustomAlert: Delivers the message, but replaces all attachments with a file named Malware Alert Text.txt that contains the custom alert text specified by the CustomAlertText parameter. ```yaml Type: MalwareFilteringAction Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,15 +221,17 @@ Accept wildcard characters: False ``` ### -CustomAlertText +This parameter is available only in on-premises Exchange. + The CustomAlertText parameter specifies the custom text to use in the replacement attachment named Malware Alert Text.txt. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the Action parameter value is ReplaceWithCustomAlert. +This parameter is meaningful only when the value of the Action parameter is DeleteAttachmentAndUseCustomAlert. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,9 +241,9 @@ Accept wildcard characters: False ``` ### -CustomExternalBody -The CustomExternalBody parameter specifies the body of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomExternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -249,9 +262,9 @@ Accept wildcard characters: False ``` ### -CustomExternalSubject -The CustomExternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomExternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -270,9 +283,9 @@ Accept wildcard characters: False ``` ### -CustomFromAddress -The CustomFromAddress parameter specifies the From address of the custom notification message for malware detections in messages from internal or external senders. +The CustomFromAddress parameter specifies the custom From address to use in notification messages for malware detections in messages from internal or external senders. -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -293,9 +306,9 @@ Accept wildcard characters: False ``` ### -CustomFromName -The CustomFromName parameter specifies the From name of the custom notification message for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomFromName parameter specifies the custom From name to use in notification messages for malware detections in messages from internal or external senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableExternalSenderAdminNotifications - EnableExternalSenderNotifications @@ -316,9 +329,9 @@ Accept wildcard characters: False ``` ### -CustomInternalBody -The CustomInternalBody parameter specifies the body of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomInternalBody parameter specifies the custom body to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableInternalSenderAdminNotifications - EnableInternalSenderNotifications @@ -337,9 +350,9 @@ Accept wildcard characters: False ``` ### -CustomInternalSubject -The CustomInternalSubject parameter specifies the subject of the custom notification message for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). +The CustomInternalSubject parameter specifies the custom subject to use in notification messages for malware detections in messages from internal senders. If the value contains spaces, enclose the value in quotation marks ("). -This parameter is only meaningful when the CustomNotifications parameter value is $true, and at least one of the following parameter values is also $true: +This parameter is meaningful only when the value of the CustomNotifications parameter is $true, and the value of at least one of the following parameters is also $true: - EnableInternalSenderAdminNotifications - EnableInternalSenderNotifications @@ -358,10 +371,17 @@ Accept wildcard characters: False ``` ### -CustomNotifications -The CustomNotifications parameter enables or disables custom notification messages for malware detections in messages from internal or external senders. Valid values are: +The CustomNotifications parameter enables or disables the customization of notification messages for malware detections. Valid values are: -- $true: When malware is detected in a message, a custom notification message is sent to the message sender. You specify the details of message using the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. -- $false: Custom notifications to the original message sender are disabled. This is the default value. Default notification messages are sent if the EnableExternalSenderNotifications and EnableInternalSenderNotifications parameters are set to $true. +- $true: Replace the default values used in notification messages with the values of the CustomFromAddress, CustomFromName, CustomExternalSubject, CustomExternalBody, CustomInternalSubject and CustomInternalBody parameters. +- $false: No customization is done to notification messages. The default values are used. + +This parameter is meaningful only when the value of at least one of the following parameters is also $true: + +- EnableExternalSenderAdminNotifications +- EnableExternalSenderNotifications +- EnableInternalSenderAdminNotifications +- EnableInternalSenderNotifications ```yaml Type: Boolean @@ -395,10 +415,12 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderAdminNotifications -The EnableExternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from external senders. Valid values are: +The EnableExternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: -- $true: When malware is detected in messages from external senders, send notification messages to the email address that's specified by the ExternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. -- $false: When malware is detected in messages from external senders, don't send administrator notifications. This is the default value. +- $true: When malware attachments are detected in messages from external senders, a notification messages is sent to the email address that's specified by the ExternalSenderAdminAddress parameter. +- $false: Notifications aren't sent for malware attachment detections in messages from external senders. This is the default value. + +**Note**: Admin notifications are sent only for _attachments_ that are classified as malware. ```yaml Type: Boolean @@ -414,16 +436,18 @@ Accept wildcard characters: False ``` ### -EnableExternalSenderNotifications -The EnableExternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from external senders. Valid values are: +This parameter is available only in on-premises Exchange. -- $true: When malware is detected in a message from an external sender, send them a notification message. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomExternalBody, and CustomExternalSubject parameters. +The EnableExternalSenderNotifications parameter enables or disables sending notification messages to external senders for malware detections in their messages. Valid values are: + +- $true: When malware is detected in a message from an external sender, send them a notification message. - $false: Don't send malware detection notification messages to external message senders. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -435,10 +459,14 @@ Accept wildcard characters: False ### -EnableFileFilter This parameter is available only in the cloud-based service. -The EnableFileFilter parameter enables or disables common attachment blocking (also known as the Common Attachment Types Filter). Valid values are: +The EnableFileFilter parameter enables or disables the common attachments filter (also known as common attachment blocking). Valid values are: -- $true: Common attachment blocking is enabled. The file types are defined by the FileTypes parameter. -- $false: Common attachment blocking is disabled. This is the default value. +- $true: The common attachments filter is enabled. This is the default value. +- $false: The common attachments filter is disabled. + +You specify the file types using the FileTypes parameter. + +You specify the action for detected files using the FileTypeAction parameter. ```yaml Type: Boolean @@ -454,10 +482,12 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderAdminNotifications -The EnableInternalSenderAdminNotifications parameter enables or disables sending malware detection notification messages to an administrator for messages from internal senders. Valid values are: +The EnableInternalSenderAdminNotifications parameter enables or disables sending notification messages to an administrator for malware detections in messages from internal senders. Valid values are: + +- $true: When malware attachments are detected in messages from internal senders, a notification messages is sent to the email address that's specified by the InternalSenderAdminAddress parameter. +- $false: Notifications aren't sent for malware attachment detections in messages from internal senders. This is the default value. -- $true: When malware is detected in messages from internal senders, send notification messages to the email address that's specified by the InternalSenderAdminAddress parameter. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. -- $false: When malware is detected in messages from internal senders, don't send administrator notifications. This is the default value. +**Note**: Admin notifications are sent only for _attachments_ that are classified as malware. ```yaml Type: Boolean @@ -473,16 +503,18 @@ Accept wildcard characters: False ``` ### -EnableInternalSenderNotifications -The EnableInternalSenderNotifications parameter enables or disables notification messages for malware detections in messages from internal senders. Valid values are: +This parameter is available only in on-premises Exchange. + +The EnableInternalSenderNotifications parameter enables or disables sending notification messages to internal senders for malware detections in their messages. Valid values are: -- $true: When malware is detected in a message from an internal sender, send them a notification message. You can customize the notification message using the CustomFromAddress, CustomFromName, CustomInternalBody, and CustomInternalSubject parameters. +- $true: When malware is detected in a message from an internal sender, send them a notification message. - $false: Don't send malware detection notification messages to internal message senders. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -492,9 +524,9 @@ Accept wildcard characters: False ``` ### -ExternalSenderAdminAddress -The ExternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from external senders. +The ExternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from external senders. -This parameter is only meaningful if the EnableExternalSenderAdminNotifications parameter is set to $true. +This parameter is meaningful only if the value of the EnableExternalSenderAdminNotifications parameter is $true. ```yaml Type: SmtpAddress @@ -509,29 +541,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FileTypeAction +This parameter is available only in the cloud-based service. + +The FileTypeAction parameter specifies what happens to messages that contain one or more attachments where the file extension is included in the FileTypes parameter (the common attachments filter). Valid values are: + +- Quarantine: Quarantine the message. Whether or not the recipient is notified depends on the quarantine notification settings in the quarantine policy that's selected for the malware filter policy by the QuarantineTag parameter. +- Reject: The message is rejected in a non-delivery report (also known as an NDR or bounce message) to the sender. The message is not available in quarantine. This is the default value. + +This parameter is meaningful only when the value of the EnableFileFilter parameter is $true. + +```yaml +Type: FileTypeFilteringAction +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FileTypes This parameter is available only in the cloud-based service. -The FileTypes parameter specifies the file types that are automatically blocked by common attachment blocking (also known as the Common Attachment Types Filter), regardless of content. The default values are: +The FileTypes parameter specifies the file types that are automatically blocked by the common attachments filter, regardless of content. The default values are: -- .ace -- .ani -- .app -- .docm -- .exe -- .jar -- .reg -- .scr -- .vbe -- .vbs +`ace, ani, apk, app, appx, arj, bat, cab, cmd, com, deb, dex, dll, docm, elf, exe, hta, img, iso, jar, jnlp, kext, lha, lib, library, lnk, lzh, macho, msc, msi, msix, msp, mst, pif, ppa, ppam, reg, rev, scf, scr, sct, sys, uif, vb, vbe, vbs, vxd, wsc, wsf, wsh, xll, xz, z` -You enable or disable common attachment blocking by using the EnableFileFilter parameter. +This parameter is meaningful only if the value of the EnableFileFilter parameter is $true. -Common attachment blocking uses best effort true-typing to detect the file type regardless of the file name extension. If true-typing fails or isn't supported for the specified file type, then extension matching is used. For example, .ps1 files are Windows PowerShell scripts, but their true type is text. +The common attachments filter uses best effort true-typing to detect the file type regardless of the file name extension. For example, an exe file renamed to txt is detected as an exe file. If true-typing fails or isn't supported for the specified file type, then extension matching is used. To replace the existing list of file types with the values you specify, use the syntax `FileType1,FileType2,...FileTypeN`. To preserve existing values, be sure to include the file types that you want to keep along with the new values that you want to add. -To add or remove file types without affecting the other file type entries, see the Examples section. +To add or remove file types without affecting the other file type entries, see the Examples section in this topic. ```yaml Type: String[] @@ -547,9 +593,9 @@ Accept wildcard characters: False ``` ### -InternalSenderAdminAddress -The InternalSenderAdminAddress parameter specifies the email address of the administrator who will receive notification messages for malware detections in messages from internal senders. +The InternalSenderAdminAddress parameter specifies the email address of the administrator who receives notifications messages for malware detections in messages from internal senders. -This parameter is only meaningful if the EnableInternalSenderAdminNotifications parameter value is $true. +This parameter is meaningful only if the value of the EnableInternalSenderAdminNotifications parameter is $true. ```yaml Type: SmtpAddress @@ -564,6 +610,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsPolicyOverrideApplied +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MakeDefault The MakeDefault switch makes this malware filter policy the default policy. You don't need to specify a value with this switch. @@ -582,6 +644,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -QuarantineTag +This parameter is available only in the cloud-based service. + +The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. @@ -624,12 +714,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md index e96570f9dc..9589a6fc72 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilterRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-malwarefilterrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilterrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MalwareFilterRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MalwareFilterRule cmdlet to modify malware filter rules in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,10 @@ Set-MalwareFilterRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Anti-malware policies](https://learn.microsoft.com/defender-office-365/anti-malware-protection-about#anti-malware-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,7 +125,7 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -163,7 +166,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -190,7 +193,7 @@ Accept wildcard characters: False ``` ### -MalwareFilterPolicy -The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule rule. +The MalwareFilterPolicy parameter specifies the malware filter policy that's associated with the malware filter rule. You can use any value that uniquely identifies the policy. For example: @@ -254,7 +257,7 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] @@ -295,7 +298,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -342,12 +345,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md b/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md index 9f04cebcdf..5766c7970f 100644 --- a/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md +++ b/exchange/exchange-ps/exchange/Set-MalwareFilteringServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-malwarefilteringserver +online version: https://learn.microsoft.com/powershell/module/exchange/set-malwarefilteringserver applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-MalwareFilteringServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MalwareFilteringServer cmdlet to configure the Malware agent settings in the Transport service on a Mailbox server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ Set-MalwareFilteringServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -321,12 +321,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md b/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md index bac9a2fa95..9606389193 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md +++ b/exchange/exchange-ps/exchange/Set-ManagedContentSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-managedcontentsettings +online version: https://learn.microsoft.com/powershell/module/exchange/set-managedcontentsettings applicable: Exchange Server 2010 title: Set-ManagedContentSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-ManagedContentSettings cmdlet to modify existing managed content settings for a managed folder. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,11 +39,11 @@ Set-ManagedContentSettings [-Identity] ``` ## DESCRIPTION -Managed content settings are settings that you apply to managed folders to control the lifespan of items in users' mailboxes. For more information about managed content settings, see [Messaging Records Management](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb123507(v=exchg.141)). +Managed content settings are settings that you apply to managed folders to control the lifespan of items in users' mailboxes. For more information about managed content settings, see [Messaging Records Management](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb123507(v=exchg.141)). -Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings cmdlet doesn't. If you want to change the message type to which content settings apply, you must delete and then re-create the content settings. For more information about the MessageClass parameter, see [New-ManagedContentSettings](https://docs.microsoft.com/powershell/module/exchange/new-managedcontentsettings). +Although the New-ManagedContentSettings cmdlet has the MessageClass parameter, the Set-ManagedContentSettings cmdlet doesn't. If you want to change the message type to which content settings apply, you must delete and then re-create the content settings. For more information about the MessageClass parameter, see [New-ManagedContentSettings](https://learn.microsoft.com/powershell/module/exchange/new-managedcontentsettings). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -315,12 +315,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ManagedFolder.md b/exchange/exchange-ps/exchange/Set-ManagedFolder.md index 1dcd3a6ca7..aef4960fcd 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedFolder.md +++ b/exchange/exchange-ps/exchange/Set-ManagedFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-managedfolder +online version: https://learn.microsoft.com/powershell/module/exchange/set-managedfolder applicable: Exchange Server 2010 title: Set-ManagedFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-ManagedFolder cmdlet to modify the settings of managed folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ The Set-ManagedFolder cmdlet modifies the specified parameters of a managed fold The Set-ManagedFolder cmdlet accepts a managed custom folder or an identity string as pipelined input. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -254,12 +254,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md index 8d291818e4..4e82b118b4 100644 --- a/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ManagedFolderMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-managedfoldermailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-managedfoldermailboxpolicy applicable: Exchange Server 2010 title: Set-ManagedFolderMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-ManagedFolderMailboxPolicy cmdlet to change the settings of a managed folder mailbox policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Set-ManagedFolderMailboxPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -42,7 +42,7 @@ Set-ManagedFolderMailboxPolicy "PM Storage Template1" -Name "PM Storage Template This example changes the name of the managed folder mailbox policy PM Storage Template1 to PM Storage Template2. -The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). +The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). ### Example 2 ```powershell @@ -157,12 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md index f9d8dbbf39..44d3d2ad77 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md +++ b/exchange/exchange-ps/exchange/Set-ManagementRoleAssignment.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-managementroleassignment +online version: https://learn.microsoft.com/powershell/module/exchange/set-managementroleassignment applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-ManagementRoleAssignment schema: 2.0.0 @@ -16,14 +16,13 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ManagementRoleAssignment cmdlet to modify existing management role assignments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### RelativeRecipientWriteScope ``` -Set-ManagementRoleAssignment [-Identity] - [-RecipientRelativeWriteScope ] +Set-ManagementRoleAssignment [-Identity] [-RecipientRelativeWriteScope ] [-Confirm] [-CustomConfigWriteScope ] [-DomainController ] @@ -35,8 +34,7 @@ Set-ManagementRoleAssignment [-Identity] ### CustomRecipientWriteScope ``` -Set-ManagementRoleAssignment [-Identity] - [-CustomConfigWriteScope ] +Set-ManagementRoleAssignment [-Identity] [-CustomConfigWriteScope ] [-Confirm] [-CustomRecipientWriteScope ] [-DomainController ] @@ -48,8 +46,7 @@ Set-ManagementRoleAssignment [-Identity] ### RecipientOrganizationalUnitScope ``` -Set-ManagementRoleAssignment [-Identity] - [-RecipientOrganizationalUnitScope ] +Set-ManagementRoleAssignment [-Identity] [-RecipientOrganizationalUnitScope ] [-Confirm] [-CustomConfigWriteScope ] [-DomainController ] @@ -61,9 +58,7 @@ Set-ManagementRoleAssignment [-Identity] ### ExclusiveScope ``` -Set-ManagementRoleAssignment [-Identity] - [-ExclusiveConfigWriteScope ] - [-ExclusiveRecipientWriteScope ] +Set-ManagementRoleAssignment [-Identity] [-ExclusiveConfigWriteScope ] [-ExclusiveRecipientWriteScope ] [-Confirm] [-DomainController ] [-Enabled ] @@ -83,14 +78,34 @@ Set-ManagementRoleAssignment [-Identity] -RecipientA [] ``` +### App +``` +Set-ManagementRoleAssignment [-Identity] [-CustomResourceScope ] + [-Confirm] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + +### RecipientGroupScope +``` +Set-ManagementRoleAssignment [-Identity] -RecipientGroupScope + [-Confirm] + [-Enabled ] + [-Force] + [-WhatIf] + [] +``` + ## DESCRIPTION When you modify a role assignment, you can specify a new predefined or custom management scope or provide an organizational unit (OU) to scope the existing role assignment. You can create custom management scopes using the New-ManagementScope cmdlet and can view a list of existing scopes using the Get-ManagementScope cmdlet. If you choose not to specify an OU, predefined scope, or custom scope, the implicit write scope of the role applies to the role assignment. -For more information about management role assignments, see [Understanding management role assignments](https://docs.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). +For more information about management role assignments, see [Understanding management role assignments](https://learn.microsoft.com/exchange/understanding-management-role-assignments-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -140,6 +155,46 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -RecipientAdministrativeUnitScope +This parameter is functional only in the cloud-based service. + +The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the role assignment to. + +Administrative units are Microsoft Entra containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. + +You can't use this parameter with any of the other scope parameters. + +```yaml +Type: AdministrativeUnitIdParameter +Parameter Sets: RecipientAdministrativeUnitScope +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecipientGroupScope +This parameter is available only in the cloud-based service. + +The RecipientGroupScope parameter specifies a group to consider for scoping the role assignment. Individual members of the specified group (not nested groups) are considered as in scope for the assignment. You can use any value that uniquely identifies the group: Name, DistinguishedName, GUID, or DisplayName. + +```yaml +Type: GroupIdParameter +Parameter Sets: RecipientGroupScope +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +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. @@ -201,6 +256,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CustomResourceScope +This parameter is available only in the cloud-based service. + +The CustomResourceScope parameter specifies the custom management scope to associate with this management role assignment. You can use any value that uniquely identifies the management scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +If the value contains spaces, enclose the value in quotation marks ("). + +You use this parameter with the App parameter to assign permissions to service principals. For more information, see For more information about service principals, see [Application and service principal objects in Microsoft Entra ID](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals). + +```yaml +Type: ManagementScopeIdParameter +Parameter Sets: App +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController This parameter is available only in on-premises Exchange. @@ -208,7 +289,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: (All) +Parameter Sets: RelativeRecipientWriteScope, CustomRecipientWriteScope, RecipientOrganizationalUnitScope, ExclusiveScope, RecipientAdministrativeUnitScope Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -280,7 +361,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -295,28 +378,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RecipientAdministrativeUnitScope -This parameter is available or functional only in the cloud-based service. - -The RecipientAdministrativeUnitScope parameter specifies the administrative unit to scope the role assignment to. - -Administrative units are Azure Active Directory containers of resources. You can view the available administrative units by using the Get-AdministrativeUnit cmdlet. - -You can't use this parameter with any of the other scope parameters. - -```yaml -Type: AdministrativeUnitIdParameter -Parameter Sets: RecipientAdministrativeUnitScope -Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -RecipientOrganizationalUnitScope The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If the OU name contains spaces, enclose the domain and OU in quotation marks ("). @@ -380,12 +441,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md b/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md index c6c2e63554..ee811f9b5f 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md +++ b/exchange/exchange-ps/exchange/Set-ManagementRoleEntry.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-managementroleentry +online version: https://learn.microsoft.com/powershell/module/exchange/set-managementroleentry applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-ManagementRoleEntry schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ManagementRoleEntry cmdlet to change the available parameters on an existing management role entry. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,9 +36,9 @@ Set-ManagementRoleEntry [-Identity] ## DESCRIPTION The Set-ManagementRoleEntry cmdlet changes the available parameters on an existing role entry. If you want to add parameters to a role entry, the parameters must exist in the role entry in the parent management role. If you want to remove parameters from a role entry, there can be no role entries in child roles that inherit those parameters from the role entry you want to change. You can't change role entries associated with built-in roles. -For more information about management role entries, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about management role entries, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -75,7 +75,7 @@ In on-premises Exchange, this example adds the Location parameter to the Mailbox ### -Identity The Identity parameter specifies the role entry that you want to modify. This parameter uses the syntax: `\` (for example, `CustomRole\Set-Mailbox`). -For more information about how management role entries work, see [Understanding management roles](https://docs.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). +For more information about how management role entries work, see [Understanding management roles](https://learn.microsoft.com/exchange/understanding-management-roles-exchange-2013-help). If the role entry name contains spaces, enclose it in quotation marks ("). @@ -93,7 +93,11 @@ Accept wildcard characters: False ``` ### -AddParameter -The AddParameter parameter adds the specified parameters to the specified role entry. Use the Parameters parameter to specify the parameters to add. You can't use the AddParameter parameter in the same command as the RemoveParameter parameter. +The AddParameter switch specifies that you're adding parameters to the specified role entry. You don't need to specify a value with this switch. + +Use the Parameters parameter to specify the parameters to add. + +You can't use the AddParameter switch and the RemoveParameter switch together in the same command. ```yaml Type: SwitchParameter @@ -148,7 +152,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -188,7 +194,11 @@ Accept wildcard characters: False ``` ### -RemoveParameter -The RemoveParameter parameter removes the specified parameters from the specified role entry. Use the Parameters parameter to specify the parameters to remove. You can't use the RemoveParameter parameter in the same command as the AddParameter parameter. +The RemoveParameter switch specifies that you're removing parameters to the specified role entry. You don't need to specify a value with this switch. + +Use the Parameters parameter to specify the parameters to remove. + +You can't use the AddParameter switch and the RemoveParameter switch together in the same command. ```yaml Type: SwitchParameter @@ -204,15 +214,13 @@ Accept wildcard characters: False ``` ### -UnScopedTopLevel -This parameter is available on in on-premises Exchange. +This parameter is available only in on-premises Exchange. -By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +By default, this parameter is available only in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). The UnScopedTopLevel switch specifies the role entry that you want to modify is on an unscoped top-level role. You don't need to specify a value with this switch. -Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://docs.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). - -You must use this switch to modify role entries on unscoped top level roles. +Unscoped top-level management roles can only contain custom scripts or non-Exchange cmdlets. For more information, see [Create an unscoped role](https://learn.microsoft.com/exchange/create-an-unscoped-role-exchange-2013-help). ```yaml Type: SwitchParameter @@ -248,12 +256,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ManagementScope.md b/exchange/exchange-ps/exchange/Set-ManagementScope.md index dc33e706a6..7d84c230ae 100644 --- a/exchange/exchange-ps/exchange/Set-ManagementScope.md +++ b/exchange/exchange-ps/exchange/Set-ManagementScope.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-managementscope +online version: https://learn.microsoft.com/powershell/module/exchange/set-managementscope applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-ManagementScope schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ManagementScope cmdlet to change an existing management scope. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -56,11 +56,11 @@ Set-ManagementScope [-Identity] ``` ## DESCRIPTION -If you change a scope that has been associated with management role assignments using the New-ManagementRoleAssignment cmdlet, the updated scope applies to all the associated role assignments. For more information about changing scopes, see [Change a role scope](https://docs.microsoft.com/exchange/change-a-role-scope-exchange-2013-help). +If you change a scope that has been associated with management role assignments using the New-ManagementRoleAssignment cmdlet, the updated scope applies to all the associated role assignments. For more information about changing scopes, see [Change a role scope](https://learn.microsoft.com/exchange/change-a-role-scope-exchange-2013-help). -For more information about regular and exclusive scopes, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +For more information about regular and exclusive scopes, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -106,16 +106,16 @@ Accept wildcard characters: False ### -DatabaseRestrictionFilter This parameter is available only in on-premises Exchange. -The DatabaseRestrictionFilter parameter uses OPath filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. +The DatabaseRestrictionFilter parameter uses OPATH filter syntax to specify the databases that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For a list of filterable database properties, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For a list of filterable database properties, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter with the RecipientRestrictionFilter, ServerRestrictionFilter, RecipientRoot, DatabaseList, or ServerList parameters. @@ -135,16 +135,16 @@ Accept wildcard characters: False ### -ServerRestrictionFilter This parameter is available only in on-premises Exchange. -The ServerRestrictionFilter parameter uses OPath filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. +The ServerRestrictionFilter parameter uses OPATH filter syntax to specify the servers that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For a list of filterable server properties, see [Understanding management role scopes](https://docs.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For a list of filterable server properties, see [Understanding management role scopes](https://learn.microsoft.com/exchange/understanding-management-role-scopes-exchange-2013-help). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter wit the RecipientRestrictionFilter, RecipientRoot, DatabaseRestrictionFilter, DatabaseList, or ServerList parameters. @@ -201,7 +201,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -233,16 +235,16 @@ Accept wildcard characters: False ``` ### -RecipientRestrictionFilter -The RecipientRestrictionFilter parameter uses OPath filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. +The RecipientRestrictionFilter parameter uses OPATH filter syntax to specify the recipients that are included in the scope. The syntax is `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable recipient property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://docs.microsoft.com/powershell/exchange/recipientfilter-properties). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable recipient property. For filterable recipient properties, see [Filterable properties for the RecipientFilter parameter](https://learn.microsoft.com/powershell/exchange/recipientfilter-properties). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`. -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). You can't use this parameter with the DatabaseRestrictionFilter, DatabaseList, ServerList, or ServerRestrictionFilter parameters. @@ -260,7 +262,7 @@ Accept wildcard characters: False ``` ### -RecipientRoot -The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. Valid input for this parameter is an OU or domain that's visibor domain that's returned bylUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: +The RecipientRoot parameter specifies the organizational unit (OU) under which the filter specified with the RecipientRestrictionFilter parameter should be applied. Valid input for this parameter is an OU or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: - Name - Canonical name @@ -303,14 +305,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES +Use two-letter country codes (ISO 3166-1 alpha-2) instead of the full country name in filters. For example, use `-RecipientRestrictionFilter "UsageLocation -eq 'FR'"` for France. ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md index 86e380bbb3..ec322afd70 100644 --- a/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-MapiVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mapivirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/set-mapivirtualdirectory applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-MapiVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-MapiVirtualDirectory cmdlet to modify Messaging Application Programming Interface (MAPI) virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. A MAPI virtual directory is used by supported versions of Microsoft Outlook to connect to mailboxes by using the MAPIHTTP protocol. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Set-MapiVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -128,8 +128,6 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionFlags -This parameter is available only in Exchange Server 2013. - The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: - None: This is the default setting. @@ -142,7 +140,7 @@ The ExtendedProtectionFlags parameter specifies custom settings for Extended Pro Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -152,8 +150,6 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionSPNList -This parameter is available only in Exchange Server 2013. - The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: - $null: This is the default value. @@ -163,7 +159,7 @@ The ExtendedProtectionSPNList parameter specifies a list of valid Service Princi Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -173,8 +169,6 @@ Accept wildcard characters: False ``` ### -ExtendedProtectionTokenChecking -This parameter is available only in Exchange Server 2013. - The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: - None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. @@ -187,7 +181,7 @@ The ExtendedProtectionTokenChecking parameter defines how you want to use Extend Type: ExtendedProtectionTokenCheckingMode Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,7 +222,7 @@ You can specify multiple values separated by commas. The default values are NTLM, OAuth, and Negotiate. We recommend that you always have the virtual directory configured for OAuth. -For more information about the different authentication methods, see [Understanding HTTP Authentication](https://docs.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication) and [What is OAuth authentication?](https://docs.microsoft.com/exchange/using-oauth-authentication-to-support-ediscovery-in-an-exchange-hybrid-deployment-exchange-2013-help#what-is-oauth-authentication). +For more information about the different authentication methods, see [Understanding HTTP Authentication](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication) and [What is OAuth authentication?](https://learn.microsoft.com/exchange/using-oauth-authentication-to-support-ediscovery-in-an-exchange-hybrid-deployment-exchange-2013-help#what-is-oauth-authentication). ```yaml Type: MultiValuedProperty @@ -284,12 +278,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MessageClassification.md b/exchange/exchange-ps/exchange/Set-MessageClassification.md index dc24ce3713..4c48abce78 100644 --- a/exchange/exchange-ps/exchange/Set-MessageClassification.md +++ b/exchange/exchange-ps/exchange/Set-MessageClassification.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-messageclassification -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-messageclassification +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MessageClassification schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MessageClassification cmdlet to configure an existing message classification instance in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Set-MessageClassification [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -64,7 +64,7 @@ The Identity parameter specifies the message classification that you want to mod Type: MessageClassificationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -101,7 +101,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -212,7 +212,7 @@ Accept wildcard characters: False ``` ### -RecipientDescription -The RecipientDescription parameter specifies the the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). +The RecipientDescription parameter specifies the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String @@ -246,7 +246,7 @@ Accept wildcard characters: False ``` ### -SenderDescription -The SenderDescription parameter specifies the the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). +The SenderDescription parameter specifies the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml Type: String @@ -268,7 +268,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -282,12 +282,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MigrationBatch.md b/exchange/exchange-ps/exchange/Set-MigrationBatch.md index e890114f13..17981b8c20 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Set-MigrationBatch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-migrationbatch +online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-MigrationBatch schema: 2.0.0 @@ -14,14 +14,15 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see [New-MigrationBatch](https://docs.microsoft.com/powershell/module/exchange/new-migrationbatch). +Use the Set-MigrationBatch cmdlet to update a migration request for a batch of users. For more information, see [New-MigrationBatch](https://learn.microsoft.com/powershell/module/exchange/new-migrationbatch). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-MigrationBatch [-Identity] + [-AddUsers] [-AllowIncrementalSyncs ] [-AllowUnknownColumnsInCsv ] [-ApproveSkippedItems] @@ -60,7 +61,7 @@ The Set-MigrationBatch cmdlet configures your existing migration batches to migr Some settings can be applied both to the batch as well as to individual users within the batch. It is important to note that when a setting is applied to a user it will override any corresponding setting on the batch. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -92,6 +93,24 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AddUsers +This parameter is available only in the cloud-based service. + +{{ Fill AddUsers Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowIncrementalSyncs This parameter is available only in on-premises Exchange. @@ -135,11 +154,11 @@ Accept wildcard characters: False ### -ApproveSkippedItems This parameter is available only in the cloud-based service. -The ApproveSkippedItems switch marks all of the skipped items discovered prior to the current time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. +The ApproveSkippedItems switch marks all of the skipped items that were discovered prior to the current time as approved. You don't need to specify a value with this switch. -For more information about maximum message size values, see the following topic [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). +If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. -You don't need to specify a value with this switch. +For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). ```yaml Type: SwitchParameter @@ -193,9 +212,11 @@ Accept wildcard characters: False ``` ### -CompleteAfter +This parameter is functional only in the cloud-based service. + The CompleteAfter parameter specifies a delay before the batch is completed. Data migration for the batch will start, but completion won't start until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a value, use either of the following options: @@ -235,9 +256,9 @@ Accept wildcard characters: False ``` ### -CSVData -This parameter is available only in on-premises Exchange. +The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. -The CSVData parameter specifies the CSV file that contains information about the user mailboxes to be moved or migrated. The required attributes in the header row of the CSV file vary depending on the type of migration. Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes())`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\MigrationBatch\_1.csv"))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). **Note**: This parameter doesn't validate the availability of the mailboxes based on RBAC scope. All mailboxes that are specified in the CSV file will be migrated, even if they are outside of the RBAC scope (for example, an OU) that gives the admin permissions to migrate mailboxes. @@ -245,7 +266,7 @@ The CSVData parameter specifies the CSV file that contains information about the Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -277,8 +298,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. @@ -448,7 +469,7 @@ Accept wildcard characters: False ### -StartAfter The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The migration will be prepared, but the actual data migration for users within the batch won't start until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a value, use either of the following options: @@ -525,12 +546,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MigrationConfig.md b/exchange/exchange-ps/exchange/Set-MigrationConfig.md index 7a906cbb5c..99bb6f912b 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationConfig.md +++ b/exchange/exchange-ps/exchange/Set-MigrationConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-migrationconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-MigrationConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MigrationConfig cmdlet to edit migration configurations on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Set-MigrationConfig ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -188,12 +188,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md b/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md index 3ce15fbfeb..cade570874 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md +++ b/exchange/exchange-ps/exchange/Set-MigrationEndpoint.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-migrationendpoint +online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationendpoint applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-MigrationEndpoint schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MigrationEndpoint cmdlet to edit settings for cutover or staged Exchange migrations, IMAP migrations, Google Workspace (formerly G Suite) migrations, and remote moves. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -61,12 +61,12 @@ Use the Set-MigrationEndpoint cmdlet to configure settings for different types o For more information about the different move and migration scenarios, see: -- [Mailbox moves in Exchange Server](https://docs.microsoft.com/Exchange/recipients/mailbox-moves) -- [Manage on-premises mailbox moves in Exchange Server](https://docs.microsoft.com/Exchange/architecture/mailbox-servers/manage-mailbox-moves) +- [Mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/recipients/mailbox-moves) +- [Manage on-premises mailbox moves in Exchange Server](https://learn.microsoft.com/Exchange/architecture/mailbox-servers/manage-mailbox-moves) Changes made to an endpoint that affect the individual users within the batch are applied starting at the next time that the batch is processed. If you are running this cmdlet in the cloud-based service and wish to speed up the application of these settings, consider running the Set-MigrationBatch cmdlet with the -Update parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -196,7 +196,7 @@ Accept wildcard characters: False ### -Credentials The Credentials parameter specifies the username and password for connecting to the remote endpoint. Credentials should be used when creating either a staged or cutover Exchange endpoint or a RemoteMove endpoint. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -434,7 +434,7 @@ This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. -Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes(path of the JSON file>))`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json")`) +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -450,7 +450,7 @@ Accept wildcard characters: False ``` ### -SkipVerification -The SkipVerification switch specifies whether to skip verifying that the remote server is reachable when creating a migration endpoint. The default value is $false. +The SkipVerification switch skips verifying that the remote server is reachable when creating a migration endpoint. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -522,12 +522,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MigrationUser.md b/exchange/exchange-ps/exchange/Set-MigrationUser.md index 6cde72f52f..9a4d3dc9f8 100644 --- a/exchange/exchange-ps/exchange/Set-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Set-MigrationUser.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-migrationuser -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-migrationuser +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-MigrationUser schema: 2.0.0 author: chrisda @@ -12,13 +12,11 @@ ms.reviewer: # Set-MigrationUser ## SYNOPSIS -This cmdlet is available only in the cloud-based service. +This cmdlet is functional only in the cloud-based service. Use the Set-MigrationUser cmdlet to modify the migration settings of a user in an existing migration batch. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,6 +26,7 @@ Set-MigrationUser [-Identity] [-BadItemLimit ] [-CompleteAfter ] [-Confirm] + [-DomainController ] [-LargeItemLimit ] [-Partition ] [-StartAfter ] @@ -39,7 +38,7 @@ Set-MigrationUser [-Identity] ## DESCRIPTION Some settings can be applied both to the batch as well as to individual users within the batch. It is important to note that when a setting is applied to a user it will override any corresponding setting on the batch. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,7 +67,7 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: True Position: 1 @@ -80,9 +79,11 @@ Accept wildcard characters: False ### -ApproveSkippedItems This parameter is available only in the cloud-based service. -The ApproveSkippedItems switch marks all of the skipped items discovered prior to the current time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. +The ApproveSkippedItems switch marks all of the skipped items that were discovered prior to the current time as approved. You don't need to specify a value with this switch. -For more information about maximum message size values, see the following topic [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). +If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. + +For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). You don't need to specify a value with this switch. @@ -110,7 +111,7 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -120,16 +121,18 @@ Accept wildcard characters: False ``` ### -CompleteAfter +This parameter is available only in the cloud-based service. + The CompleteAfter parameter specifies a delay before the user is completed. Data migration for the user will start, but won't complete until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime @@ -154,7 +157,25 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -168,8 +189,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the migration request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the migration request can proceed. @@ -179,7 +200,7 @@ Valid input for this parameter is an integer or the value unlimited. The default Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -189,6 +210,8 @@ Accept wildcard characters: False ``` ### -Partition +This parameter is available only in the cloud-based service. + This parameter is reserved for internal Microsoft use. ```yaml @@ -205,16 +228,18 @@ Accept wildcard characters: False ``` ### -StartAfter +This parameter is available only in the cloud-based service. + The StartAfter parameter specifies a delay before the data migration for the user is started. The migration will be prepared, but the actual data migration for the user won't start until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime @@ -238,7 +263,7 @@ An incremental sync copies any recent changes from the source mailbox to the tar Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -254,7 +279,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -268,12 +293,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md index 4f7993cab0..1a4006943c 100644 --- a/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-MobileDeviceMailboxPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-mobiledevicemailboxpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MobileDeviceMailboxPolicy schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MobileDeviceMailboxPolicy cmdlet to modify mobile device mailbox policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -88,7 +88,9 @@ Mobile device mailbox policies define settings for mobile devices that are used Some mobile device mailbox policy settings require the mobile device to have specific built-in features that enforce these security and device management settings. If your organization allows all devices, you must set the AllowNonProvisionableDevices parameter to $true. This applies to devices that can't enforce all policy settings. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +Some settings in this cmdlet are supported by Outlook for iOS and Android. For more information, see [Leveraging Exchange Online mobile device policies](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/secure-outlook-for-ios-and-android#leveraging-exchange-online-mobile-device-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -156,7 +158,15 @@ Accept wildcard characters: False ``` ### -AllowBluetooth -The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow. +The AllowBluetooth parameter specifies whether the Bluetooth capabilities are allowed on the mobile device. Valid values are: + +- Allow (this is the default value). +- Disable +- HandsfreeOnly + +The values Allow or HandsfreeOnly allow synchronization between Outlook for Android and the Outlook for Android wearable app for the associated Microsoft account. + +The value Disable disables synchronization between Outlook for Android and the Outlook for Android wearable app for the associated Microsoft account. Any previously synchronized data is deleted. This value does not disable Bluetooth on the Android device or the wearable device, nor does it affect other Android wearable apps. ```yaml Type: BluetoothType @@ -260,7 +270,7 @@ The AllowGooglePushNotifications parameter controls whether the user can receive Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -326,7 +336,7 @@ The AllowMicrosoftPushNotifications parameter specifies whether push notificatio Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -595,7 +605,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -605,6 +615,8 @@ Accept wildcard characters: False ``` ### -DeviceEncryptionEnabled +**Note**: This setting is supported by Outlook for iOS and Android. + The DeviceEncryptionEnabled parameter specifies whether encryption is enabled on the mobile device. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, device encryption is enabled on the mobile device. @@ -873,6 +885,8 @@ Accept wildcard characters: False ``` ### -MinPasswordLength +**Note**: This setting is supported by Outlook for Android. + The MinPasswordLength parameter specifies the minimum number of characters in the mobile device password. You can enter any number from 1 through 16 or the value $null. The default value is blank. The maximum password length is 16 characters. @@ -1142,7 +1156,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1172,12 +1186,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MoveRequest.md b/exchange/exchange-ps/exchange/Set-MoveRequest.md index 3078227182..1d1ecd41fb 100644 --- a/exchange/exchange-ps/exchange/Set-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Set-MoveRequest.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-moverequest -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-moverequest +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-MoveRequest schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-MoveRequest cmdlet to change move request options after the move request has been created. You can use the Set-MoveRequest cmdlet to recover from failed move requests. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,6 +45,7 @@ Set-MoveRequest [-Identity] [-RequestExpiryInterval ] [-SkipMoving ] [-SkippedItemApprovalTime ] + [-SourceEndpoint ] [-StartAfter ] [-SuspendWhenReadyToComplete ] [-TargetDatabase ] @@ -55,7 +56,7 @@ Set-MoveRequest [-Identity] ## DESCRIPTION You can pipeline the Set-MoveRequest cmdlet from the Get-MoveRequestStatistics, Get-MoveRequest, or Get-Mailbox cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -90,7 +91,7 @@ The Identity parameter specifies the identity of the mailbox or mail user. You c Type: MoveRequestIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -184,14 +185,14 @@ Accept wildcard characters: False ### -CompleteAfter The CompleteAfter parameter specifies a delay before the request is completed. The request is started, but not completed until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime @@ -232,7 +233,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -318,8 +319,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -454,7 +455,7 @@ Accept wildcard characters: False ### -RemoteCredential The RemoteCredential parameter specifies the username and password an administrator who has permission to perform the mailbox move. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -542,17 +543,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SourceEndpoint +This parameter is available only in the cloud-based service. + +{{ Fill SourceEndpoint Description }} + +```yaml +Type: MigrationEndpointIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StartAfter The StartAfter parameter specifies a delay before the request is started. The request isn't started until the date/time you specify with this parameter. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". In Exchange Online PowerShell, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC). To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime @@ -572,12 +591,12 @@ This parameter is available only in the cloud-based service. The SkippedItemApprovalTime parameter marks all of the skipped items discovered prior to the specified time as approved. If the data loss that was detected during this migration is significant, the migration will not be able to complete without approving skipped items. Items may have been skipped because they are corrupted in the source mailbox and can't be copied to the target mailbox, they are larger than the max allowable message size configured for the tenant, or they were detected as missing from the target mailbox when the migration is ready to complete. -For more information about maximum message size values, see the following topic [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). +For more information about maximum message size values, see the following topic [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits). To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). ```yaml Type: DateTime @@ -639,7 +658,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -653,12 +672,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md index 3582f931de..68c9290d33 100644 --- a/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md +++ b/exchange/exchange-ps/exchange/Set-MyAnalyticsFeatureConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig applicable: Exchange Online title: Set-MyAnalyticsFeatureConfig schema: 2.0.0 @@ -12,13 +12,13 @@ ms.author: chrisda # Set-MyAnalyticsFeatureConfig ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). Use the Set-MyAnalyticsFeatureConfig cmdlet to configure the availability and features of MyAnalytics for the specified user. **Note**: This cmdlet replaces the Set-UserAnalyticsConfig cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,13 +32,18 @@ Set-MyAnalyticsFeatureConfig -Identity ``` ## DESCRIPTION -This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator - Exchange Administrator - Insights Administrator -To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. ## EXAMPLES @@ -165,12 +170,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-Notification.md b/exchange/exchange-ps/exchange/Set-Notification.md index 22dc3bce52..4d7ef423b7 100644 --- a/exchange/exchange-ps/exchange/Set-Notification.md +++ b/exchange/exchange-ps/exchange/Set-Notification.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-notification +online version: https://learn.microsoft.com/powershell/module/exchange/set-notification applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-Notification schema: 2.0.0 @@ -14,7 +14,10 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Set-Notification cmdlet to modify notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notification events are related to: +> [!NOTE] +> This cmdlet will be deprecated in the cloud-based service. The classic Exchange admin center was deprecated in the cloud-based service in 2023. + +Use the Set-Notification cmdlet to modify notification events that are shown in the notification viewer in the Exchange admin center (EAC). These notifications are related to the following events: - Mailbox moves and migrations. - Expiring and expired certificates. @@ -22,7 +25,7 @@ Use the Set-Notification cmdlet to modify notification events that are shown in - Importing mailbox content from .pst files. - Restoring deleted mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +48,7 @@ Set-Notification -NotificationEmails -ProcessType ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-OMEConfiguration -Identity "OME Configuration" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image (Get-Content "C:\Temp\OME Logo.gif" -Encoding byte) +Set-OMEConfiguration -Identity "OME Configuration" -EmailText "Encrypted message enclosed." -PortalText "This portal is encrypted." -DisclaimerText "Encryption security disclaimer." -Image ([System.IO.File]::ReadAllBytes('C:\Temp\OME Logo.gif')) ``` -This example configures the specified values for the default OME configuration named "OME Configuration". Note the use of the Get-Content command to provide the input for the Image parameter. +This example configures the specified values for the default OME configuration named "OME Configuration". ## PARAMETERS @@ -61,7 +59,7 @@ The Identity parameter specifies the OME configuration that you want to modify. Type: OMEConfigurationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -74,14 +72,14 @@ Accept wildcard characters: False The BackgroundColor parameter specifies the background color. Valid values are: - An HTML hexadecimal color code value (#RRGGBB) enclosed in quotation marks. For example, `"#FFFFFF"` is white. -- A valid color name value. For example, `yellow` is #ffff00. For a list of the valid color names, see [Background color reference](https://docs.microsoft.com/microsoft-365/compliance/add-your-organization-brand-to-encrypted-messages#background-color-reference). +- A valid color name value. For example, `yellow` is #ffff00. For a list of the valid color names, see [Background color reference](https://learn.microsoft.com/purview/add-your-organization-brand-to-encrypted-messages#background-color-reference). - $null (blank). This is the default value. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -100,7 +98,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -118,7 +116,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -136,7 +134,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -146,7 +144,7 @@ Accept wildcard characters: False ``` ### -ExternalMailExpiryInDays -This parameter is only available with a Microsoft 365 Advanced Message Encryption subscription. +This parameter is available only with a Microsoft 365 Advanced Message Encryption subscription. The ExternalMailExpiryInDays parameter specifies the number of days that the encrypted message is available to external recipients in the Microsoft 365 portal. A valid value is an integer from 0 to 730. The value 0 means the messages will never expire. The default value is 0. @@ -170,7 +168,7 @@ Accept wildcard characters: False ### -Image The Image parameter identifies and uploads an image that will be displayed in the email message and in the Microsoft 365 admin center. -You need to read the file to a byte-encoded object using the Get-Content cmdlet, for example, -Image (Get-Content "C:\\Temp\\OME Logo.gif" -Encoding byte) +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). - Supported file formats: .png, .jpg, .bmp, or .tiff - Optimal size of logo file: less than 40 KB @@ -182,7 +180,7 @@ To remove an existing image and use the default image, use the value $null for t Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -200,7 +198,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -219,7 +217,7 @@ The OTPEnabled parameter specifies whether to allow recipients to use a one-time Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -237,7 +235,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -255,7 +253,7 @@ If you don't use this parameter, the Privacy Statement link goes to the default Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -273,7 +271,7 @@ To remove existing text and use the default value, use the value $null for this Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -283,7 +281,7 @@ Accept wildcard characters: False ``` ### -SocialIdSignIn -The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, etc). Valid values are: +The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, and Microsoft account). Valid values are: - $true: Social network ID sign in is allowed. This is the default value. - $false: Social network ID sign in is not allowed. Whether the recipient can use a one-time passcode or their Microsoft 365 work or school account is controlled by the OTPEnabled parameter. @@ -292,7 +290,7 @@ The SocialIdSignIn parameter specifies whether a user is allowed to view an encr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -308,7 +306,7 @@ This parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -322,12 +320,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md b/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md index 322ce03ccd..d08012a2ab 100644 --- a/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md +++ b/exchange/exchange-ps/exchange/Set-OMEMessageRevocation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-omemessagerevocation +online version: https://learn.microsoft.com/powershell/module/exchange/set-omemessagerevocation applicable: Exchange Online title: Set-OMEMessageRevocation schema: 2.0.0 @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-OMEMessageRevocation cmdlet to revoke Microsoft 365 Message Encryption (OME) for a message. Revoking encryption prevents the recipient from viewing the message in the Office 365 Message Encryption portal. +Use the Set-OMEMessageRevocation cmdlet to revoke Microsoft Purview Message Encryption for a message. Revoking encryption prevents the recipient from viewing the message in the OME portal. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,11 +26,11 @@ Set-OMEMessageRevocation -MessageId -Revoke ``` ## DESCRIPTION -When an email has been revoked, the recipient will get the following error when they try to view the encrypted message in the Office 365 Message Encryption portal: "The message has been revoked by the sender". +When an email has been revoked, the recipient will get the following error when they try to view the encrypted message in the OME portal: "The message has been revoked by the sender". You can revoke encrypted messages if the recipient received a link-based, branded encrypted email message. If the recipient received a native inline experience in a supported Outlook client, then you can't revoke encryption for the message. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -48,7 +46,7 @@ This example revokes encryption for the specified message. ### -MessageId The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, ""). -You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft 365 compliance center. +You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal. ```yaml Type: String @@ -66,7 +64,7 @@ Accept wildcard characters: False ### -Revoke The Revoke parameter specifies whether to revoke encryption for the message. Valid values are: -- $true: Encryption for the specified message is revoked. The recipient will get an error when they try to view the encrypted message in the Office 365 Message Encryption portal +- $true: Encryption for the specified message is revoked. The recipient will get an error when they try to view the encrypted message in the OME portal - $false: Encryption for the specified message isn't revoked. This is the default value. ```yaml @@ -87,12 +85,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md index aae3acd07b..23e45c17c1 100644 --- a/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-OabVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-oabvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/set-oabvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-OabVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-OABVirtualDirectory cmdlet to modify offline address book (OAB) virtual directories that are used in Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Set-OabVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -242,7 +242,7 @@ Accept wildcard characters: False ``` ### -PollInterval -This parameter is available or functional only in Exchange 2010. +This parameter is functional only in Exchange 2010. The PollInterval parameter specifies the time interval in minutes that the distribution service should poll the offline address book generation server for updates. @@ -320,12 +320,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md index b519d1f550..b6bd614d26 100644 --- a/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Set-OfflineAddressBook.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-offlineaddressbook +online version: https://learn.microsoft.com/powershell/module/exchange/set-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-OfflineAddressBook schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-OfflineAddressBook cmdlet to modify offline address book (OAB) settings. -In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +In Exchange Online, this cmdlet is available only in the Address Lists role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Address Lists role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,7 +52,7 @@ Set-OfflineAddressBook [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -403,9 +403,9 @@ Accept wildcard characters: False ``` ### -Schedule -This parameter is available or functional only in Exchange 2010. +This parameter is functional only in Exchange 2010. -In Exchange 2013 or later, this parameter is no longer responsible for the OAB generation schedule. For more information, see [Change the offline address book generation schedule in Exchange](https://docs.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/change-oab-generation-schedule). +In Exchange 2013 or later, this parameter is no longer responsible for the OAB generation schedule. For more information, see [Change the offline address book generation schedule in Exchange](https://learn.microsoft.com/Exchange/plan-and-deploy/post-installation-tasks/change-oab-generation-schedule). The Schedule parameter specifies the interval for generating the OAB in Exchange 2010 or earlier. @@ -502,7 +502,11 @@ Accept wildcard characters: False ``` ### -Versions -The Versions parameter specifies the OAB versions that are generated for client download. In Exchange 2013 or later, the default and only supported value is Version4 (Version3 and Version2 require public folder distribution). +The Versions parameter specifies the OAB versions that are generated for client download. Valid values are: + +- Version2 (requires public folder distribution) +- Version3 (requires public folder distribution) +- Version4 (default value in Exchange 2010 or later; the only available value in Exchange 2013 or later) ```yaml Type: MultiValuedProperty @@ -589,12 +593,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md b/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md index e54d211639..666358469d 100644 --- a/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md +++ b/exchange/exchange-ps/exchange/Set-OnPremisesOrganization.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-onpremisesorganization -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-onpremisesorganization +applicable: Exchange Online, Exchange Online Protection title: Set-OnPremisesOrganization schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-OnPremisesOrganization cmdlet to modify the parameters of the OnPremisesOrganization object on the Microsoft 365 tenant. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +36,7 @@ Set-OnPremisesOrganization [-Identity] ## DESCRIPTION The OnPremisesOrganization object represents an on-premises Exchange organization configured for hybrid deployment with a Microsoft 365 organization. Typically, this object is only modified and updated by the Hybrid Configuration wizard. Manual modification of this object may result in hybrid deployment misconfiguration; therefore, we strongly recommend that you use the Hybrid Configuration wizard to update this object in the Microsoft 365 organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,7 +60,7 @@ The Identity parameter specifies the identity of the on-premises organization ob Type: OnPremisesOrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -97,7 +95,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -193,7 +191,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -207,12 +205,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md index 580758d889..738f268b0b 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationConfig.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-organizationconfig -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationconfig +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-OrganizationConfig schema: 2.0.0 author: chrisda @@ -16,32 +16,43 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-OrganizationConfig cmdlet to configure various settings of an Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ### ShortenEventScopeParameter ``` Set-OrganizationConfig -ShortenEventScopeDefault + [-AcceptedDomainApprovedSendersEnabled ] + [-ActionableMessagesExtenalAccessTokenEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] - [-AllowPlusAddressInRecipients ] [-AppsForOfficeEnabled ] [-AsyncSendEnabled ] [-AuditDisabled ] [-AutodiscoverPartialDirSync ] [-AutoEnableArchiveMailbox ] [-AutoExpandingArchive] + [-AutomaticForcedReadReceiptEnabled ] + [-BlockMoveMessagesForGroupFolders ] [-BookingsAddressEntryRestricted ] [-BookingsAuthEnabled ] + [-BookingsBlockedWordsEnabled ] [-BookingsCreationOfCustomQuestionsRestricted ] [-BookingsEnabled ] [-BookingsExposureOfStaffDetailsRestricted ] [-BookingsMembershipApprovalRequired ] + [-BookingsNamingPolicyEnabled ] + [-BookingsNamingPolicyPrefix ] + [-BookingsNamingPolicyPrefixEnabled ] + [-BookingsNamingPolicySuffix ] + [-BookingsNamingPolicySuffixEnabled ] [-BookingsNotesEntryRestricted ] [-BookingsPaymentsEnabled ] [-BookingsPhoneNumberEntryRestricted ] + [-BookingsSearchEngineIndexDisabled ] + [-BookingsSmsMicrosoftEnabled ] [-BookingsSocialSharingRestricted ] [-ByteEncoderTypeFor7BitCharsets ] [-CalendarVersionStoreEnabled ] @@ -65,11 +76,13 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-DefaultPublicFolderMovedItemRetention ] [-DefaultPublicFolderProhibitPostQuota ] [-DirectReportsGroupAutoCreationEnabled ] + [-DisablePlusAddressInRecipients ] [-DistributionGroupDefaultOU ] [-DistributionGroupNameBlockedWordsList ] [-DistributionGroupNamingPolicy ] [-ElcProcessingDisabled ] [-EnableForwardingAddressSyncForMailboxes ] + [-EnableOutlookEvents ] [-EndUserDLUpgradeFlowsDisabled ] [-EwsAllowEntourage ] [-EwsAllowList ] @@ -80,15 +93,17 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-EwsEnabled ] [-ExchangeNotificationEnabled ] [-ExchangeNotificationRecipients ] - [-ExternalInOutlookEnabled ] [-FindTimeAttendeeAuthenticationEnabled ] [-FindTimeAutoScheduleDisabled ] [-FindTimeLockPollForAttendeesEnabled ] [-FindTimeOnlineMeetingOptionDisabled ] [-FocusedInboxOn ] [-HierarchicalAddressBookRoot ] + [-HybridRSVPEnabled ] [-IPListBlocked ] [-IsAgendaMailEnabled ] + [-IsGroupFoldersAndRulesEnabled ] + [-IsGroupMemberAllowedToEditContent ] [-LeanPopoutEnabled ] [-LinkPreviewEnabled ] [-MailTipsAllTipsEnabled ] @@ -98,6 +113,11 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-MailTipsMailboxSourcedTipsEnabled ] [-MaskClientIpInReceivedHeadersEnabled ] [-MatchSenderOrganizerProperties ] + [-MessageHighlightsEnabled ] + [-MessageRecallAlertRecipientsEnabled ] + [-MessageRecallAlertRecipientsReadMessagesOnlyEnabled ] + [-MessageRecallEnabled ] + [-MessageRecallMaxRecallableAge ] [-MessageRemindersEnabled ] [-MobileAppEducationEnabled ] [-OAuth2ClientProfileEnabled ] @@ -109,17 +129,22 @@ Set-OrganizationConfig -ShortenEventScopeDefault [-OutlookPayEnabled ] [-OutlookTextPredictionDisabled ] [-PerTenantSwitchToESTSEnabled ] + [-PostponeRoamingSignaturesUntilLater ] [-PreferredInternetCodePageForShiftJis ] [-PublicComputersDetectionEnabled ] [-PublicFoldersEnabled ] [-PublicFolderShowClientControl ] [-ReadTrackingEnabled ] + [-RecallReadMessagesEnabled ] [-RefreshSessionEnabled ] + [-RejectDirectSend ] [-RemotePublicFolderMailboxes ] [-RequiredCharsetCoverage ] [-SendFromAliasEnabled ] + [-SharedDomainEmailAddressFlowEnabled ] [-SiteMailboxCreationURL ] [-SmtpActionableMessagesEnabled ] + [-TwoClickMailPreviewEnabled ] [-UnblockUnsafeSenderPromptEnabled ] [-VisibleMeetingUpdateProperties ] [-WebPushNotificationsDisabled ] @@ -131,10 +156,7 @@ Set-OrganizationConfig -ShortenEventScopeDefault ### AdfsAuthenticationParameter ``` -Set-OrganizationConfig [-AdfsAudienceUris ] - [-AdfsEncryptCertificateThumbprint ] - [-AdfsIssuer ] - [-AdfsSignCertificateThumbprints ] +Set-OrganizationConfig [-AdfsAudienceUris ] [-AdfsEncryptCertificateThumbprint ] [-AdfsIssuer ] [-AdfsSignCertificateThumbprints ] [-ACLableSyncedObjectEnabled ] [-ActivityBasedAuthenticationTimeoutEnabled ] [-ActivityBasedAuthenticationTimeoutInterval ] @@ -190,6 +212,8 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] + [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] [-PreferredInternetCodePageForShiftJis ] @@ -197,9 +221,9 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-PublicFolderMailboxesLockedForNewConnections ] [-PublicFolderMailboxesMigrationComplete ] [-PublicFolderMigrationComplete ] + [-PublicFolderShowClientControl ] [-PublicFoldersEnabled ] [-PublicFoldersLockedForMigration ] - [-PublicFolderShowClientControl ] [-ReadTrackingEnabled ] [-RefreshSessionEnabled ] [-RemotePublicFolderMailboxes ] @@ -209,6 +233,7 @@ Set-OrganizationConfig [-AdfsAudienceUris ] [-SmtpActionableMessagesEnabled ] [-UMAvailableLanguages ] [-UnblockUnsafeSenderPromptEnabled ] + [-UseIcsSyncStateStreaming] [-WACDiscoveryEndpoint ] [-WhatIf] [] @@ -272,11 +297,12 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] + [-MitigationsEnabled ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OAuth2ClientProfileEnabled ] [-OrganizationSummary ] [-PreferredInternetCodePageForShiftJis ] [-PublicComputersDetectionEnabled ] - [-PublicFolderContentReplicationDisabled ] [-PublicFolderMailboxesLockedForNewConnections ] [-PublicFolderMailboxesMigrationComplete ] [-PublicFolderMigrationComplete ] @@ -292,11 +318,139 @@ Set-OrganizationConfig [-AdfsAuthenticationConfiguration ] [-SmtpActionableMessagesEnabled ] [-UMAvailableLanguages ] [-UnblockUnsafeSenderPromptEnabled ] + [-UseIcsSyncStateStreaming] [-WACDiscoveryEndpoint ] [-WhatIf] [] ``` +### DelayedDelicensingParameterSet +``` +Set-OrganizationConfig [-DelayedDelicensingEnabled ] [-EndUserMailNotificationForDelayedDelicensingEnabled ] [-TenantAdminNotificationForDelayedDelicensingEnabled ] + [-AcceptedDomainApprovedSendersEnabled ] + [-ActionableMessagesExtenalAccessTokenEnabled ] + [-ActivityBasedAuthenticationTimeoutEnabled ] + [-ActivityBasedAuthenticationTimeoutInterval ] + [-ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled ] + [-AppsForOfficeEnabled ] + [-AsyncSendEnabled ] + [-AuditDisabled ] + [-AutodiscoverPartialDirSync ] + [-AutoEnableArchiveMailbox ] + [-AutoExpandingArchive] + [-AutomaticForcedReadReceiptEnabled ] + [-BlockMoveMessagesForGroupFolders ] + [-BookingsAddressEntryRestricted ] + [-BookingsAuthEnabled ] + [-BookingsBlockedWordsEnabled ] + [-BookingsCreationOfCustomQuestionsRestricted ] + [-BookingsEnabled ] + [-BookingsExposureOfStaffDetailsRestricted ] + [-BookingsMembershipApprovalRequired ] + [-BookingsNamingPolicyEnabled ] + [-BookingsNamingPolicyPrefix ] + [-BookingsNamingPolicyPrefixEnabled ] + [-BookingsNamingPolicySuffix ] + [-BookingsNamingPolicySuffixEnabled ] + [-BookingsNotesEntryRestricted ] + [-BookingsPaymentsEnabled ] + [-BookingsPhoneNumberEntryRestricted ] + [-BookingsSearchEngineIndexDisabled ] + [-BookingsSmsMicrosoftEnabled ] + [-BookingsSocialSharingRestricted ] + [-ByteEncoderTypeFor7BitCharsets ] + [-CalendarVersionStoreEnabled ] + [-ComplianceMLBgdCrawlEnabled ] + [-Confirm] + [-ConnectorsActionableMessagesEnabled ] + [-ConnectorsEnabled ] + [-ConnectorsEnabledForOutlook ] + [-ConnectorsEnabledForSharepoint ] + [-ConnectorsEnabledForTeams ] + [-ConnectorsEnabledForYammer ] + [-CustomerLockboxEnabled ] + [-DefaultAuthenticationPolicy ] + [-DefaultGroupAccessType ] + [-DefaultPublicFolderAgeLimit ] + [-DefaultPublicFolderDeletedItemRetention ] + [-DefaultPublicFolderIssueWarningQuota ] + [-DefaultPublicFolderMaxItemSize ] + [-DefaultPublicFolderMovedItemRetention ] + [-DefaultPublicFolderProhibitPostQuota ] + [-DirectReportsGroupAutoCreationEnabled ] + [-DisablePlusAddressInRecipients ] + [-DistributionGroupDefaultOU ] + [-DistributionGroupNameBlockedWordsList ] + [-DistributionGroupNamingPolicy ] + [-ElcProcessingDisabled ] + [-EnableForwardingAddressSyncForMailboxes ] + [-EnableOutlookEvents ] + [-EndUserDLUpgradeFlowsDisabled ] + [-EwsAllowEntourage ] + [-EwsAllowList ] + [-EwsAllowMacOutlook ] + [-EwsAllowOutlook ] + [-EwsApplicationAccessPolicy ] + [-EwsBlockList ] + [-EwsEnabled ] + [-ExchangeNotificationEnabled ] + [-ExchangeNotificationRecipients ] + [-FindTimeAttendeeAuthenticationEnabled ] + [-FindTimeAutoScheduleDisabled ] + [-FindTimeLockPollForAttendeesEnabled ] + [-FindTimeOnlineMeetingOptionDisabled ] + [-FocusedInboxOn ] + [-HierarchicalAddressBookRoot ] + [-HybridRSVPEnabled ] + [-IPListBlocked ] + [-IsAgendaMailEnabled ] + [-IsGroupFoldersAndRulesEnabled ] + [-IsGroupMemberAllowedToEditContent ] + [-LeanPopoutEnabled ] + [-LinkPreviewEnabled ] + [-MailTipsAllTipsEnabled ] + [-MailTipsExternalRecipientsTipsEnabled ] + [-MailTipsGroupMetricsEnabled ] + [-MailTipsLargeAudienceThreshold ] + [-MailTipsMailboxSourcedTipsEnabled ] + [-MaskClientIpInReceivedHeadersEnabled ] + [-MatchSenderOrganizerProperties ] + [-MessageHighlightsEnabled ] + [-MessageRecallEnabled ] + [-MessageRemindersEnabled ] + [-MobileAppEducationEnabled ] + [-OAuth2ClientProfileEnabled ] + [-OnlineMeetingsByDefaultEnabled ] + [-OutlookGifPickerDisabled ] + [-OutlookMobileGCCRestrictionsEnabled ] + [-OutlookMobileHelpShiftEnabled ] + [-OutlookMobileSingleAccountEnabled ] + [-OutlookPayEnabled ] + [-OutlookTextPredictionDisabled ] + [-PerTenantSwitchToESTSEnabled ] + [-PostponeRoamingSignaturesUntilLater ] + [-PreferredInternetCodePageForShiftJis ] + [-PublicComputersDetectionEnabled ] + [-PublicFoldersEnabled ] + [-PublicFolderShowClientControl ] + [-ReadTrackingEnabled ] + [-RefreshSessionEnabled ] + [-RemotePublicFolderMailboxes ] + [-RequiredCharsetCoverage ] + [-SendFromAliasEnabled ] + [-SharedDomainEmailAddressFlowEnabled ] + [-SiteMailboxCreationURL ] + [-SmtpActionableMessagesEnabled ] + [-TwoClickMailPreviewEnabled ] + [-UnblockUnsafeSenderPromptEnabled ] + [-VisibleMeetingUpdateProperties ] + [-WebPushNotificationsDisabled ] + [-WebSuggestedRepliesDisabled ] + [-WhatIf] + [-WorkspaceTenantEnabled ] + [] +``` + ### Identity ``` Set-OrganizationConfig @@ -306,6 +460,7 @@ Set-OrganizationConfig [-ByteEncoderTypeFor7BitCharsets ] [-Confirm] [-CustomerFeedbackEnabled ] + [-DefaultAuthenticationPolicy ] [-DistributionGroupDefaultOU ] [-DistributionGroupNameBlockedWordsList ] [-DistributionGroupNamingPolicy ] @@ -330,6 +485,7 @@ Set-OrganizationConfig [-MicrosoftExchangeRecipientEmailAddressPolicyEnabled ] [-MicrosoftExchangeRecipientPrimarySmtpAddress ] [-MicrosoftExchangeRecipientReplyRecipient ] + [-OabShadowDistributionOldestFileAgeLimit ] [-OrganizationSummary ] [-PermanentlyDeleteDisabled ] [-PreferredInternetCodePageForShiftJis ] @@ -344,7 +500,11 @@ Set-OrganizationConfig ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +> [!TIP] +> The output of the **Get-OrganizationConfig** cmdlet often shows curly braces or `{}` around properties values that accept multiple comma-separated values. Don't use those extra characters in values for the corresponding parameters on this cmdlet. Use the syntax as explained in the parameter descriptions. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -420,6 +580,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AcceptedDomainApprovedSendersEnabled +This parameter is available only in the cloud-based service. + +{{ Fill AcceptedDomainApprovedSendersEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ACLableSyncedObjectEnabled This parameter is available only in on-premises Exchange. @@ -438,13 +616,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ActionableMessagesExtenalAccessTokenEnabled +This parameter is available only in the cloud-based service. + +{{ Fill ActionableMessagesExtenalAccessTokenEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ActivityBasedAuthenticationTimeoutEnabled The ActivityBasedAuthenticationTimeoutEnabled parameter enables or disables the inactivity interval for automatic logoff in Outlook on the web (formerly known as Outlook Web App). Valid values are: - $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity that causes logoff in Outlook on the web. This is the default value. - $false: Automatic logoff based on a period of inactivity in Outlook on the web is disabled. -If you're using single sign-on, use the ActivityBasedAuthenticationTimeoutInterval parameter. +If you're using single sign-on, use the ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter. ```yaml Type: Boolean @@ -484,8 +680,6 @@ Accept wildcard characters: False ``` ### -ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled -This parameter is available or functional only in on-premises Exchange. - The ActivityBasedAuthenticationTimeoutWithSingleSignOnEnabled parameter enables or disables the inactivity interval for automatic logoff for single sign-on in Outlook on the Web. Valid values are: - $true: The ActivityBasedAuthenticationTimeoutInterval parameter specifies the period of inactivity in Outlook on the web that causes logoff for single sign-on. This is the default value. @@ -515,7 +709,7 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -For more information about configuring AD FS claims based authentication in Exchange, see [Use AD FS claims-based authentication with Outlook on the web](https://docs.microsoft.com/Exchange/clients/outlook-on-the-web/ad-fs-claims-based-auth). +For more information about configuring AD FS claims based authentication in Exchange, see [Use AD FS claims-based authentication with Outlook on the web](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/ad-fs-claims-based-auth). ```yaml Type: MultiValuedProperty @@ -591,7 +785,7 @@ This parameter is available only in on-premises Exchange. The AdfsSignCertificateThumbprints parameter specifies one or more X.509 token-signing certificates that are used for AD FS claims-based authentication. This parameter uses certificate thumbprint values (GUIDs) to identify the certificates. -To get the thumbprint values of the primary and secondary token-signing certificates, open Windows PowerShell on the AD FS server and run the command Get-ADFSCertificate -CertificateType "Token-signing". For more information, see [Get-ADFSCertificate](https://docs.microsoft.com/powershell/module/adfs/get-adfscertificate). +To get the thumbprint values of the primary and secondary token-signing certificates, open Windows PowerShell on the AD FS server and run the command Get-ADFSCertificate -CertificateType "Token-signing". For more information, see [Get-ADFSCertificate](https://learn.microsoft.com/powershell/module/adfs/get-adfscertificate). To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -610,33 +804,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPlusAddressInRecipients -This parameter is available only in the cloud-based service. - -The AllowPlusAddressInRecipients parameter enables or disables dynamic, disposable subaddressing as defined in RFC 5233. Valid values are: - -- $true: The plus sign in an email address indicates subaddressing. For example, mail sent to `jane+exampletag@contoso.com` is delivered to `jane@contoso.com`. If your Exchange Online organization was created after September 2020, this is the default value. -- $false: The plus sign in an email address is treated as a literal character. For example, mail sent to `jane+exampletag@contoso.com` is delivered only if `jane+exampletag@contoso.com` is configured as the primary address or a proxy address on an existing recipient. If your Exchange Online organization was created before before September 2020, this is the default value. - -```yaml -Type: Boolean -Parameter Sets: ShortenEventScopeParameter -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AppsForOfficeEnabled The AppsForOfficeEnabled parameter specifies whether to enable apps for Outlook features. By default, the parameter is set to $true. If the flag is set to $false, no new apps can be activated for any user in the organization. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -655,7 +828,7 @@ The AsyncSendEnabled parameter specifies whether to enable or disable async send ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -676,7 +849,7 @@ The AuditDisabled parameter specifies whether to disable or enable mailbox audit ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -696,7 +869,7 @@ After you enable AutodiscoverPartialDirSync, it will take approximately 3 hours ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -710,11 +883,14 @@ Accept wildcard characters: False ### -AutoEnableArchiveMailbox This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +The AutoEnableArchiveMailbox specifies whether an archive mailbox is automatically provisioned when the primary mailbox reaches 90% of the size quota (if licenses include archiving). Valid values are: + +- $true: An archive mailbox is automatically provisioned. +- $false: An archive mailbox isn't automatically provisioned. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -728,13 +904,13 @@ Accept wildcard characters: False ### -AutoExpandingArchive This parameter is available only in the cloud-based service. -The AutoExpandingArchive switch enables the unlimited archiving feature (called auto-expanding archiving) in an Exchange Online organization. You don't need to specify a value with this switch. +The AutoExpandingArchive switch enables the auto-expanding archiving feature in an Exchange Online organization. You don't need to specify a value with this switch. After you enable auto-expanding archiving, additional storage space is automatically added to a user's archive mailbox when it approaches the storage limit. Note that a user's archive mailbox has to be enabled before auto-expanding archiving can take effect. Also note that after you enable auto-expanding archiving for your organization, it can't be disabled. ```yaml Type: SwitchParameter -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -745,6 +921,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutomaticForcedReadReceiptEnabled +This parameter is available only in the cloud-based service. + +{{ Fill AutomaticForcedReadReceiptEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BlockMoveMessagesForGroupFolders +This parameter is available only in the cloud-based service. + +The BlockMoveMessagesForGroupFolders parameter specifies whether to prevent group owners or group members from moving messages between folders in Microsoft 365 Groups. Valid values are: + +- $true: Group owners or group members can't move messages between folders in Microsoft 365 groups (manually or vial Inbox rules). +- $false: Group owners or group members can move messages between folders in Microsoft 365 groups. This is the default value. + +The value of this parameter is meaningful only when the value of the IsGroupFoldersAndRulesEnabled parameter is $true. + +Whether group members (not just group owners) are allowed to move messages between folders in Microsoft 365 Groups also depends on the following settings: + +- The value of the IsGroupMemberAllowedToEditContent parameter is $true. +- The group owner selected **All members will be able to create, edit, move, copy, and delete mail folders and rules within the group** in the properties of the group in Outlook on the web. + +For more information, see [Manage Folders and Rules feature in Microsoft 365 Groups](https://learn.microsoft.com/microsoft-365/enterprise/manage-folders-and-rules-feature). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BookingsAddressEntryRestricted This parameter is available only in the cloud-based service. @@ -755,7 +979,7 @@ The BookingsAddressEntryRestricted parameter specifies whether addresses can be ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -769,11 +993,32 @@ Accept wildcard characters: False ### -BookingsAuthEnabled This parameter is available only in the cloud-based service. -{{ Fill BookingsAuthEnabled Description }} +The BookingsAuthEnabled parameter specifies whether to enforce authentication to access all published Bookings pages. Valid values are: + +- $true: All new and existing Bookings pages are forced to authenticate users before they can book the appointment. +- $false: All bookings pages are not forced to authenticate users. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsBlockedWordsEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsBlockedWordsEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -794,7 +1039,7 @@ The BookingsCreationOfCustomQuestionsRestricted parameter specifies whether Book ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -817,7 +1062,7 @@ Microsoft Bookings is an online and mobile app for small businesses who provide ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -838,7 +1083,7 @@ The BookingsExposureOfStaffDetailsRestricted parameter specifies whether the att ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -852,11 +1097,104 @@ Accept wildcard characters: False ### -BookingsMembershipApprovalRequired This parameter is available only in the cloud-based service. -{{ Fill BookingsMembershipApprovalRequired Description }} +The BookingsMembershipApprovalRequired parameter enables a membership approval requirement when new staff members are added to Bookings calendars. Valid values are: + +- $true: Newly added staff members need to accept membership in Bookings calendars before the resources are bookable. +- $false: Newly added staff members do not need to accept membership in Bookings calendars to make the resources bookable. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicyEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicyEnabled Description }} ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicyPrefix +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicyPrefix Description }} + +```yaml +Type: String +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicyPrefixEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicyPrefixEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicySuffix +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicySuffix Description }} + +```yaml +Type: String +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsNamingPolicySuffixEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsNamingPolicySuffixEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -877,7 +1215,7 @@ The BookingsNotesEntryRestricted parameter specifies whether appointment notes c ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -898,7 +1236,7 @@ The BookingsPaymentsEnabled parameter specifies whether to enable the online pay ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -919,7 +1257,43 @@ The BookingsPhoneNumberEntryRestricted parameter specifies whether phone numbers ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsSearchEngineIndexDisabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsSearchEngineIndexDisabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BookingsSmsMicrosoftEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BookingsSmsMicrosoftEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -940,7 +1314,7 @@ The BookingsSocialSharingRestricted parameter specifies whether users can see th ```yaml Type: Boolean -Parameter Sets: (All) +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -984,7 +1358,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1002,7 +1376,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1023,7 +1397,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1042,7 +1416,7 @@ For more information about actionable messages in connected apps, see [Connect a ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1059,11 +1433,11 @@ The ConnectorsEnabled parameter specifies whether to enable or disable all conne - $true: Connectors are enabled. This is the default value. - $false: Connectors are disabled. -The workloads that are affected by this parameter are Outlook, SharePoint, Teams, and Yammer. +The workloads that are affected by this parameter are Outlook, SharePoint, Teams, and Viva Engage. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1088,7 +1462,7 @@ For more information about connectors for Outlook on the web, see [Connect apps ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1109,7 +1483,7 @@ The ConnectorsEnabledForSharepoint parameter specifies whether to enable or disa ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1130,7 +1504,7 @@ The ConnectorsEnabledForTeams parameter specifies whether to enable or disable c ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1144,14 +1518,14 @@ Accept wildcard characters: False ### -ConnectorsEnabledForYammer This parameter is available only in the cloud-based service. -The ConnectorsEnabledForYammer parameter specifies whether to enable or disable connected apps on Yammer. Valid values are: +The ConnectorsEnabledForYammer parameter specifies whether to enable or disable connected apps on Viva Engage. Valid values are: - $true: Connectors are enabled. This is the default value. - $false: Connectors are disabled. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1187,7 +1561,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1229,9 +1603,9 @@ You create authentication policies with the New-AuthenticationPolicy cmdlet to b ```yaml Type: AuthPolicyIdParameter -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1250,7 +1624,7 @@ The DefaultGroupAccessType parameter specifies the default access type for Micro ```yaml Type: ModernGroupObjectType -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1310,7 +1684,7 @@ To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hou ```yaml Type: EnhancedTimeSpan -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1326,7 +1700,7 @@ The DefaultPublicFolderDeletedItemRetention parameter specifies the default valu ```yaml Type: EnhancedTimeSpan -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1354,7 +1728,7 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes(2 ```yaml Type: Unlimited -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1382,7 +1756,7 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes ( ```yaml Type: Unlimited -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1396,11 +1770,11 @@ Accept wildcard characters: False ### -DefaultPublicFolderMovedItemRetention The DefaultPublicFolderMovedItemRetention parameter specifies how long items that have been moved between mailboxes are kept in the source mailbox for recovery purposes before being removed by the Public Folder Assistant. -When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see [Set-PublicFolder](https://docs.microsoft.com/powershell/module/exchange/set-publicfolder). +When you move folder contents between mailboxes, a copy of the original data is left on the source mailbox, inaccessible for users but available for recovery by system administrators. If the move process fails and you want to roll it back, use the Set-PublicFolder -OverrideContentMailbox command to recover data. For more information, see [Set-PublicFolder](https://learn.microsoft.com/powershell/module/exchange/set-publicfolder). ```yaml Type: EnhancedTimeSpan -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1428,7 +1802,7 @@ The valid input range for this parameter is from 0 through 2199023254529 bytes ( ```yaml Type: Unlimited -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -1439,6 +1813,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DelayedDelicensingEnabled +This parameter is available only in the cloud-based service. + +The DelayedDelicensingEnabled parameter enables or disables a 30 day grace period for Exchange Online license removals from mailboxes. Valid values are: + +- $true: Exchange Online license removals from mailboxes are delayed by 30 days. Admins can use the delay to identify potential mistakes and avoid disruptions for affected users. +- $false: Exchange Online license removals from mailboxes aren't delayed. This is the default value. + +Use the TenantAdminNotificationForDelayedDelicensingEnabled parameter to turn on weekly Service Health advisory notifications for admins about the number of Exchange Online delicensed users who are in the 30 day grace period during the specified 8 day interval. For more information about Service Health, see [How to check Microsoft 365 service health](https://learn.microsoft.com/microsoft-365/enterprise/view-service-health). + +Use the EndUserMailNotificationForDelayedDelicensingEnabled to send affected users periodic email notifications that they're going to lose access to their mailbox. + +Use the Get-PendingDelicenseUser cmdlet to view mailboxes with pending mailbox license removal requests. + +Use the Expedite-Delicensing cmdlet to end the delay for removing the Exchange Online license from the mailbox. + +When you set the value of the DelayedDelicensingEnabled parameter to $true, the TenantAdminNotificationForDelayedDelicensingEnabled and EndUserMailNotificationForDelayedDelicensingEnabled parameters are set to $true by default. + +When you set the value of the DelayedDelicensingEnabled parameter to $false, the TenantAdminNotificationForDelayedDelicensingEnabled and EndUserMailNotificationForDelayedDelicensingEnabled parameters are set to $false by default. + +```yaml +Type: Boolean +Parameter Sets: DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DirectReportsGroupAutoCreationEnabled This parameter is available only in the cloud-based service. @@ -1449,7 +1856,30 @@ The DirectReportsGroupAutoCreationEnabled parameter specifies whether to enable ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisablePlusAddressInRecipients +This parameter is available only in the cloud-based service. + +The DisablePlusAddressInRecipients parameter specifies whether to enable or disable plus addressing (also known as subaddressing) for Exchange Online mailboxes. Valid values are: + +- $true: Plus addressing is disabled. You can no longer use the plus sign in regular email addresses. The plus sign is available only for plus addressing. +- $false: Plus addressing is enabled. You can use the plus sign in regular email addresses. + +For more information about plus addressing, see [Plus addressing in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/plus-addressing-in-exchange-online). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1502,7 +1932,7 @@ You can use the following user attributes. The actual values are determined by t - `` - `` - `` -- ` +- `` - `` to `` - `` - `` to `` @@ -1555,7 +1985,7 @@ The ElcProcessingDisabled parameter specifies whether to enable or disable the p ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1605,7 +2035,12 @@ Accept wildcard characters: False ### -EnableDownloadDomains This parameter is available only in on-premises Exchange. -{{ Fill EnableDownloadDomains Description }} +The EnableDownloadDomains parameter specifies that Outlook on the web downloads inline images from a different domain than the rest of Outlook on the web. Valid values are: + +- $true: Outlook on the web uses a different download domain for inline images (for example, downloads.contoso.com). Before you enable this setting, you need to create a CNAME record and certificate for this domain, and add the domain to the ExternalDownloadHostName and InternalDownloadHostName parameters on the Set-OwaVirtualDirectory cmdlet. +- $false: The setting is disabled. This is the default value. + +For more information about the security vulnerability that's addressed by this parameter, and for detailed configuration instructions, see [CVE 2021 1730](https://msrc.microsoft.com/update-guide/vulnerability/CVE-2021-1730). ```yaml Type: Boolean @@ -1623,11 +2058,11 @@ Accept wildcard characters: False ### -EnableForwardingAddressSyncForMailboxes This parameter is available only in the cloud-based service. -{{ Fill EnableForwardingAddressSyncForMailboxes Description }} +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1656,6 +2091,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableOutlookEvents +This parameter is available only in the cloud-based service. + +The EnableOutlookEvents parameter specifies whether Outlook or Outlook on the web (formerly known as Outlook Web App) automatically discovers events from email messages and adds them to user calendars. Valid values are: + +- $true: Discovery of events from email messages is enabled. +- $false: Discovery of events from email messages is disabled. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndUserDLUpgradeFlowsDisabled This parameter is available only in the cloud-based service. @@ -1666,7 +2122,7 @@ The EndUserDLUpgradeFlowsDisabled parameter specifies whether to prevent users f ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1677,6 +2133,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EndUserMailNotificationForDelayedDelicensingEnabled +This parameter is available only in the cloud-based service. + +The EndUserMailNotificationForDelayedDelicensingEnabled parameter enables or disables periodic email warnings to affected users that have pending Exchange Online license removal requests on their mailboxes. Valid values are: + +- $true: Affected users receive periodic email notifications about losing access to their mailbox starting ~18 days after the Exchange Online license was removed. +- $false: Affected users don't receive periodic email notifications about losing access to their mailbox. This is the default value. + +The value of this parameter is meaningful on when the value of the DelayedDelicensingEnabled parameter is $true. + +Use the TenantAdminNotificationForDelayedDelicensingEnabled parameter to turn on weekly Service Health advisory notifications for admins about the number of Exchange Online delicensed users who are in the 30 day grace period during the specified 8 day interval. For more information about Service Health, see [How to check Microsoft 365 service health](https://learn.microsoft.com/microsoft-365/enterprise/view-service-health). + +```yaml +Type: Boolean +Parameter Sets: DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EwsAllowEntourage The EwsAllowEntourage parameter specifies whether to enable or disable Entourage 2008 to access Exchange Web Services (EWS) for the entire organization. The default value is $true. @@ -1700,6 +2181,8 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +**Note**: If users receive an error when they try to run "Play My Emails" in Outlook Mobile, use this parameter to add the value "Cortana" to the list of allowed applications. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -1815,7 +2298,7 @@ The ExchangeNotificationEnabled parameter enables or disables Exchange notificat ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1833,25 +2316,7 @@ The ExchangeNotificationRecipients parameter specifies the recipients for Exchan ```yaml Type: MultiValuedProperty -Parameter Sets: ShortenEventScopeParameter -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalInOutlookEnabled -This parameter is available only in the cloud-based service. - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1870,11 +2335,13 @@ The FindTimeAttendeeAuthenticationEnabled parameter controls whether attendees a - $true: Attendees are required to validate their identity and the meeting organizer can't turn off this setting (Always On). - $false: By default, attendees are required to verify their identity, but the meeting organizer is allowed to turn this setting off. +This setting overrides individual user settings. + For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1890,14 +2357,16 @@ This parameter is available only in the cloud-based service. The FindTimeAutoScheduleDisabled parameter controls automatically scheduling the meeting once a consensus is reached in meeting polls using the FindTime Outlook add-in. Valid values are: -- $true: Reaching a consensus for the meeting time doesn't automatically schedule the meeting, and the meeting organizer can't change this setting (Off). +- $true: Reaching a consensus for the meeting time doesn't automatically schedule the meeting, and the meeting organizer can't change this setting (Off). - $false: By default, reaching a consensus for the meeting time doesn't automatically schedule the meeting, but meeting organizer is allowed to turn on this setting. +This setting overrides individual user settings. + For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1916,11 +2385,13 @@ The FindTimeLockPollForAttendeesEnabled controls whether the **Lock poll for att - $true: **Lock poll for attendees** is on. Attendees will not be able to suggest new times or edit other attendees. The meeting organizer can't turn off this setting (always on). - $false: By default, **Lock poll for attendees** is off (initial default) or on (the user saved settings from last poll), but the meeting organizer is allowed to turn the setting off or on to allow or prevent attendees from suggesting new times or editing attendees. +This setting overrides individual user settings. + For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1939,11 +2410,13 @@ The FindTimeOnlineMeetingOptionDisabled parameter controls the availability of t - $true: The **Online meeting** checkbox is not available in the meeting poll in FindTime, and the meeting organizer can't change this setting. If your organization uses a third-party online meeting provider, the meeting organizer can make the meeting online using the third-party provider while creating the meeting based on the FindTime poll results. - $false: The **Online meeting** checkbox is available in the meeting poll in FindTime, so the meeting organizer can choose to select or not select this setting. +This setting overrides individual user settings. + For more information about FindTime, see [How to create a FindTime poll](https://support.microsoft.com/office/4dc806ed-fde3-4ea7-8c5e-b5d1fddab4a6). ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1968,7 +2441,7 @@ Focused Inbox is a replacement for Clutter that separates the Inbox into the Foc ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -1982,7 +2455,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in Exchange Server 2010. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -2022,6 +2497,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HybridRSVPEnabled +This parameter is available only in the cloud-based service. + +The HybridRSVPEnabled parameter enables or disables Hybrid RSVP for your organization. Hybrid RSVP allows users the option to indicate if they will attend a meeting in-person or virtually when responding to a meeting invitation on Outlook. Valid values are: + +- $true: Hybrid RSVP is enabled (this is the default value). +- $false: Hybrid RSVP is disabled. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Industry This parameter is available only in on-premises Exchange. @@ -2043,7 +2539,9 @@ Accept wildcard characters: False ### -IPListBlocked This parameter is available only in the cloud-based service. -The IPListBlocked parameter specifies the blocked IP addresses that aren't allowed to connect to Exchange Online organization. These settings affect client connections that use Basic authentication where on-premises Active Directory Federation Services (ADFS) servers federate authentication with Azure Active Directory. Valid values are: +This parameter only affects Basic authentication connections. + +The IPListBlocked parameter specifies the blocked IP addresses that aren't allowed to connect to Exchange Online organization. Valid values are: - Single IP address: For example, 192.168.1.1 or fe80::39bd:88f7:6969:d223%11. - IP address range: For example, 192.168.0.1-192.168.0.254 or 192.168.8.2(255.255.255.0). @@ -2059,7 +2557,7 @@ Changes to this parameter might take up to 4 hours to fully propagate across the ```yaml Type: MultiValuedProperty -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2075,7 +2573,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2122,20 +2620,79 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsFfoMigrationInProgress -This parameter is available only in on-premises Exchange. +### -IsFfoMigrationInProgress +This parameter is available only in on-premises Exchange. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsGroupFoldersAndRulesEnabled +This parameter is available only in the cloud-based service. + +The IsGroupFoldersAndRulesEnabled specifies whether group owners (by default) can create folders and move messages (manually or by using Inbox rules) in Microsoft 365 Groups. Valid values are: + +- $true: Group owners can create folders and move messages between folders in Microsoft 365 Groups. +- $false: Group owners can't create folders or move messages between folders in Microsoft 365 Groups. This is the default value. + +To allow group owners to allow group users to create folders and moved messages in Microsoft 365 Groups, use the IsGroupMemberAllowedToEditContent parameter. + +For more information, see [Manage Folders and Rules feature in Microsoft 365 Groups](https://learn.microsoft.com/microsoft-365/enterprise/manage-folders-and-rules-feature). + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsGroupMemberAllowedToEditContent +This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +The IsGroupMemberAllowedToEditContent parameter specifies whether group owners can allow group members to manage folders and messages in Microsoft 365 Groups. Valid values are: + +- $true: Group owners can use the **All members will be able to create, edit, move, copy, and delete mail folders and rules within the group** setting in the group properties in Outlook on the web to allow group members to do the following tasks in Microsoft 365 Groups: + + • Create, rename, move, copy, and delete folders. + + • Move, copy, and delete messages manually or via Inbox rules. + + • Create, edit, copy, and delete Inbox rules. + +- $false: Group owners can't use the **All members will be able to create, edit, move, copy, and delete mail folders and rules within the group** setting in the group properties in Outlook on the web to allow group members to manage folders and messages in Microsoft 365 Groups. Only group owners can manage folders and messages in Microsoft 365 Groups. This is the default value. + +The value of this parameter is meaningful only when the value of the IsGroupFoldersAndRulesEnabled parameter is $true. + +To prevent group owners or group members from moving messages between folders manually or vial Inbox rules in Microsoft 365 Groups, use the BlockMoveMessagesForGroupFolders parameter. + +For more information, see [Manage Folders and Rules feature in Microsoft 365 Groups](https://learn.microsoft.com/microsoft-365/enterprise/manage-folders-and-rules-feature). ```yaml Type: Boolean -Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -2153,7 +2710,7 @@ The LeanPopoutEnabled parameter specifies whether to enable faster loading of po ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2172,7 +2729,7 @@ The LinkPreviewEnabled parameter specifies whether link preview of URLs in email ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2329,7 +2886,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2347,7 +2904,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2376,6 +2933,94 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessageHighlightsEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageHighlightsEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallAlertRecipientsEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallAlertRecipientsEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallAlertRecipientsReadMessagesOnlyEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallAlertRecipientsReadMessagesOnlyEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MessageRecallEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageRecallMaxRecallableAge +{{ Fill MessageRecallMaxRecallableAge Description }} + +```yaml +Type: Microsoft.Exchange.Data.EnhancedTimeSpan +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MessageRemindersEnabled This parameter is available only in the cloud-based service. @@ -2386,7 +3031,7 @@ The MessageRemindersEnabled parameter enables or disables the message reminders ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2484,6 +3129,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MitigationsEnabled +This parameter is available only in on-premises Exchange. + +The MitigationsEnabled parameter specifies whether the Exchange Emergency Mitigation service (EM service) is enabled in the organization. Valid values are: + +- $true: The EM Service automatically applies mitigations on Exchange servers where the value of the _MitigationsEnabled_ parameter is $true on the **Set-ExchangeServer**. +- $false: Mitigations are not automatically applied on Exchange servers. + +For more information, see [Exchange Emergency Mitigation (EM) service](https://learn.microsoft.com/exchange/exchange-emergency-mitigation-service). + +```yaml +Type: Boolean +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MobileAppEducationEnabled This parameter is available only in the cloud-based service. @@ -2496,7 +3164,7 @@ This setting will affect Outlook desktop at some point in the future. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2507,6 +3175,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OabShadowDistributionOldestFileAgeLimit +This parameter is available only in on-premises Exchange. + +{{ Fill OabShadowDistributionOldestFileAgeLimit Description }} + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, Identity +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OAuth2ClientProfileEnabled The OAuth2ClientProfileEnabled parameter enables or disables modern authentication in the Exchange organization. Valid values are: @@ -2519,7 +3205,7 @@ When you enable modern authentication in Exchange Online, we recommend that you ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2539,11 +3225,11 @@ The OnlineMeetingsByDefaultEnabled parameter specifies whether to set all meetin - $false: All meetings are not online by default. - $null: If the organization value has not been specified, the default behavior is for meetings to be online. -You can override this setting on individual mailboxes by using the OnlineMeetingsByDefaultEnabled parameter on the Set-MailboxCalendarConfiguration cmdlet. +If a user has already directly interacted with this setting in Outlook or Outlook on the web (formerly known as Outlook Web App or OWA), the value of this parameter is ignored. Eventually, this parameter will override the Outlook-configured setting. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2582,7 +3268,7 @@ The OutlookGifPickerDisabled parameter disables the GIF Search (powered by Bing) ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2608,11 +3294,11 @@ The Outlook for iOS and Android feature and services that are not FedRAMP compli - HelpShift and in-app support - Any Microsoft services that are outside the Microsoft 365 US Government Community Cloud (for example, Bing and Cortana). - For a full list of Features and services that are not FedRAMP compliant for GCC customers, see [Services and features of Outlook for iOS and Android that aren't available for Government Community Cloud users](https://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/outlook-for-ios-and-android-in-the-government-cloud#services-and-features-not-available). + For a full list of Features and services that are not FedRAMP compliant for GCC customers, see [Services and features of Outlook for iOS and Android that aren't available for Government Community Cloud users](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-for-ios-and-android/outlook-for-ios-and-android-in-the-government-cloud#services-and-features-not-available). ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2630,7 +3316,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2648,7 +3334,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2669,7 +3355,7 @@ The OutlookPayEnabled parameter enables or disables Microsoft Pay in the Microso ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2687,7 +3373,7 @@ This parameter is available only in the cloud-based service. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2703,7 +3389,7 @@ This parameter is available only in Exchange Server 2010. The PermanentlyDeleteDisabled parameter specifies whether to disable the PermanentlyDelete retention action for messaging records management (MRM). Valid values are: -- $true The PermanentlyDelete retention action is disabled. This setting only prevents items from being permanently deleted. It doesn't modify existing polices, block the creation of policies with the PermanentlyDelete action or notify users that thePermanentlyDelete action won't actually take effect. +- $true The PermanentlyDelete retention action is disabled. This setting only prevents items from being permanently deleted. It doesn't modify existing policies, block the creation of policies with the PermanentlyDelete action or notify users that thePermanentlyDelete action won't actually take effect. - $false The PermanentlyDelete retention action is enabled. This is the default value. A message that's permanently deleted can't be recovered by using the Recoverable Items folder. Additionally, permanently deleted messages aren't returned by a Discovery search, unless litigation hold or single item recovery is enabled for the mailbox. @@ -2728,7 +3414,7 @@ This parameter has been deprecated and is no longer used. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -2739,6 +3425,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PostponeRoamingSignaturesUntilLater +This parameter is available only in the cloud-based service. + +The PostponeRoamingSignaturesUntilLater parameter controls whether roaming signatures are enabled or disabled in Outlook on the web (formerly known as Outlook Web App or OWA) and the new Outlook for Windows. Valid values are: + +- $true: Roaming signatures are disabled for Outlook on the web and the new Outlook for Windows. For Windows clients, the registry setting to disable roaming signatures still works. For more information, see [Outlook roaming signatures](https://support.microsoft.com/office/420c2995-1f57-4291-9004-8f6f97c54d15). When roaming signatures are disabled, admins can use the signature-related parameters on the Set-MailboxMessageConfiguration cmdlet (for example, AutoAddSignature, AutoAddSignatureOnReply, and SignatureHtml) to configure email signatures. + + Previously, the only way to disable roaming signatures in Outlook on the web was to open a support ticket. With the introduction of this parameter and value, admins can disable roaming signatures themselves. + +- $false: Roaming signatures are enabled for Outlook on the web and the new Outlook for Windows. This is the default value. + +We recommend that independent software vendors (ISVs) onboard to the [signature API](https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-setsignatureasync-member(1)) based on [event-based hooks +](https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch). + +We have no plans to support roaming signature management in the Microsoft Graph API. + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PreferredInternetCodePageForShiftJis This parameter is reserved for internal Microsoft use. @@ -2850,7 +3565,7 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled -The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. This parameter uses one of the following values. +The PublicFoldersEnabled parameter specifies how public folders are deployed in your organization. Valid values are: - Local: The public folders are deployed locally in your organization. - Remote: The public folders are deployed in the remote forest. @@ -2858,7 +3573,7 @@ The PublicFoldersEnabled parameter specifies how public folders are deployed in ```yaml Type: PublicFoldersDeployment -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2870,14 +3585,14 @@ Accept wildcard characters: False ``` ### -PublicFolderShowClientControl -The PublicFolderShowClientControl parameter enables or disables access to public folders in Microsoft Outlook. Valid values are: +The PublicFolderShowClientControl parameter enables or disables the control access feature for public folders in Microsoft Outlook. Valid values are: -- $true: Users can access public folders in Outlook if the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet is set to the value $true (the default value is $false). -- $false: User can't access public folders in Outlook. This is the default value. +- $true: User access to public folders in Outlook is controlled by the value of the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet (the default value is $false). +- $false: This is the default value. User access to public folders in Outlook is enabled (the control access feature is disabled). The value of the PublicFolderClientAccess parameter on the Set-CASMailbox cmdlet is meaningless. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2922,12 +3637,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RecallReadMessagesEnabled +This parameter is available only in the cloud-based service. + +{{ Fill RecallReadMessagesEnabled Description }} + +```yaml +Type: System.Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RefreshSessionEnabled This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2938,12 +3671,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RejectDirectSend +This parameter is available only in the cloud-based service. + +{{ Fill RejectDirectSend Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RemotePublicFolderMailboxes The RemotePublicFolderMailboxes parameter specifies the identities of the public folder objects (represented as mail user objects locally) corresponding to the public folder mailboxes created in the remote forest. The public folder values set here are used only if the public folder deployment is a remote deployment. ```yaml Type: MultiValuedProperty -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -2989,21 +3740,36 @@ Accept wildcard characters: False ``` ### -SendFromAliasEnabled -This parameter is available only in the cloud-based service. - -Note: This feature is in Preview and has not yet been officially released. Do not enable it if you are not willing to lose certain functionality or have a degraded experience. -An official announcement will be released via the EHLO blog and Message Center in due time. +This parameter is available only in the cloud-based service. -The SendFromAliasEnabled parameter allows mailbox users to send messages using aliases (proxy addresses). It does this by disabling the rewriting of aliases to their primary SMTP address. This change is implemented in the Exchange Online service. At the same time, Outlook clients are making changes to natively support aliases for sending and receiving messages. Even without an updated client, changes in behavior may be seen for users using any email client as the setting affects all messages sent and received by a mailbox. Valid values are: +The SendFromAliasEnabled parameter allows mailbox users to send messages using aliases (proxy addresses). Valid values are: -- $true: Aliases on messages will no longer be rewritten to their primary SMTP addresses. Compatible Outlook clients will allow sending from aliases and replying to aliases. +- $true: Aliases on messages will no longer be rewritten to their primary SMTP addresses. Compatible Outlook clients will allow sending from aliases and replying to aliases. Even without an updated Outlook client, users might see changes in behavior because the setting affects all messages sent and received by a mailbox. - $false: Aliases on messages sent or received will be rewritten to their primary email address. This is the default value. -For more information about the availability of the Outlook for the web changes, see the [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Exchange&searchterms=59437). For Outlook for Windows, see this [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Exchange&searchterms=64123). +For more information about the availability of the feature in Outlook on the web, see the [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Exchange&searchterms=59437). For Outlook for Windows, see this [Microsoft 365 roadmap item](https://www.microsoft.com/microsoft-365/roadmap?filters=Outlook&searchterms=64123). ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SharedDomainEmailAddressFlowEnabled +This parameter is available only in the cloud-based service. + +{{ Fill SharedDomainEmailAddressFlowEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3019,7 +3785,7 @@ The SiteMailboxCreationURL parameter specifies the URL that's used to create sit ```yaml Type: Uri -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -3038,7 +3804,7 @@ The SmtpActionableMessagesEnabled parameter specifies whether to enable or disab ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -3049,6 +3815,51 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TenantAdminNotificationForDelayedDelicensingEnabled +This parameter is available only in the cloud-based service. + +The TenantAdminNotificationForDelayedDelicensingEnabled parameter enables or disables weekly admin Service Health advisory notifications that are sent to admins. Valid values are: + +- $true: Weekly Service Health advisory notifications are sent to admins about the number of Exchange Online delicensed users who are in the 30 day grace period during the specified 8 day interval. +- $false: Disable weekly Service Health advisory notifications about the number of Exchange Online delicensed users. This is the default value. + +For more information about Service Health, see [How to check Microsoft 365 service health](https://learn.microsoft.com/microsoft-365/enterprise/view-service-health). + +The value of this parameter is meaningful on when the value of the DelayedDelicensingEnabled parameter is $true. + +Use the EndUserMailNotificationForDelayedDelicensingEnabled to send affected users periodic email notifications that they're going to lose access to their mailbox. + +```yaml +Type: Boolean +Parameter Sets: DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TwoClickMailPreviewEnabled +This parameter is available only in the cloud-based service. + +{{ Fill TwoClickMailPreviewEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UMAvailableLanguages This parameter is available only in on-premises Exchange. @@ -3072,7 +3883,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Parameter Sets: ShortenEventScopeParameter, AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -3083,6 +3894,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseIcsSyncStateStreaming +This parameter is available only in on-premises Exchange. + +{{ Fill UseIcsSyncStateStreaming Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: AdfsAuthenticationParameter, AdfsAuthenticationRawConfiguration +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VisibleMeetingUpdateProperties This parameter is available only in the cloud-based service. @@ -3108,7 +3937,7 @@ If you don't specify a MeetingStartTimeWithinXMinutes value for the meeting prop The default value is `"Location,AllProperties:15"`: changes to the meeting location at any time, or changes to other meeting properties within 15 minutes of the meeting start time results in visible meeting update messages. -There are three scenarios where meeting update messages are not auto-processed regardless of the values specified in this parameter (in these scenarios, attendees will always see meeting update messages in their Inbox): +In the following scenarios, meeting update messages are not auto-processed, regardless of the values specified in this parameter. In these scenarios, attendees will always see meeting update messages in their Inbox: - The update contains a change to the meeting date, time, or recurrence pattern. - The meeting message is received for a delegated shared calendar. @@ -3117,7 +3946,7 @@ There are three scenarios where meeting update messages are not auto-processed r ```yaml Type: String -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3158,7 +3987,7 @@ The WebPushNotificationsDisabled parameter specifies whether to enable or disabl ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3179,7 +4008,7 @@ The WebSuggestedRepliesDisabled parameter specifies whether to enable or disable ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3197,7 +4026,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -3216,7 +4045,7 @@ The WorkspaceTenantEnabled parameter enables or disables workspace booking in th ```yaml Type: Boolean -Parameter Sets: ShortenEventScopeParameter +Parameter Sets: ShortenEventScopeParameter, DelayedDelicensingParameterSet Aliases: Applicable: Exchange Online @@ -3232,12 +4061,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md index 5c3d0844b3..f21e2920e4 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationrelationship +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-OrganizationRelationship cmdlet to modify existing organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -51,7 +51,7 @@ Set-OrganizationRelationship [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -82,7 +82,7 @@ The Identity parameter specifies the organization relationship that you want to Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -101,7 +101,7 @@ The ArchiveAccessEnabled parameter specifies whether the organization relationsh Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -120,7 +120,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -141,7 +141,7 @@ For message tracking to work in a cross-premises Exchange scenario, this paramet Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -175,7 +175,7 @@ The DomainNames parameter specifies the SMTP domains of the external organizatio Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -194,7 +194,7 @@ The Enabled parameter specifies whether to enable the organization relationship. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -204,13 +204,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -231,7 +233,7 @@ You control the free/busy access level and scope by using the FreeBusyAccessLeve Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -253,7 +255,7 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: FreeBusyAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -276,7 +278,7 @@ This parameter is only meaningful when the FreeBusyAccessEnabled parameter value Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -288,13 +290,20 @@ Accept wildcard characters: False ### -MailboxMoveCapability This parameter is available only in the cloud-based service. -{{ Fill MailboxMoveCapability Description }} +The MailboxMoveCapability parameter is used in cross-tenant mailbox migrations. Valid values are: + +- Inbound +- Outbound +- RemoteInbound +- RemoteOutbound + +For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). ```yaml Type: MailboxMoveCapability Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -313,7 +322,7 @@ The MailboxMoveEnabled parameter specifies whether the organization relationship Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -325,13 +334,24 @@ Accept wildcard characters: False ### -MailboxMovePublishedScopes This parameter is available only in the cloud-based service. -{{ Fill MailboxMovePublishedScopes Description }} +The MailboxMovePublishedScopes parameter is used in cross-tenant mailbox migrations to specify the mail-enabled security groups whose members are allowed to migrate. You can use any value that uniquely identifies the group. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. + +For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -352,7 +372,7 @@ You control the MailTips access level by using the MailTipsAccessLevel parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -374,7 +394,7 @@ This parameter is only meaningful when the MailTipsAccessEnabled parameter value Type: MailTipsAccessLevel Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -407,7 +427,7 @@ This restriction only applies to mailboxes, mail users, and mail contacts. It do Type: GroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -423,7 +443,7 @@ The Name parameter specifies the unique name of the organization relationship. T Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -435,13 +455,13 @@ Accept wildcard characters: False ### -OAuthApplicationId This parameter is available only in the cloud-based service. -{{ Fill OAuthApplicationId Description }} +The OAuthApplicationId is used in cross-tenant mailbox migrations to specify the application ID of the mailbox migration app that you consented to. For more information, see [Cross-tenant mailbox migration](https://learn.microsoft.com/microsoft-365/enterprise/cross-tenant-mailbox-migration). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -457,7 +477,7 @@ The OrganizationContact parameter specifies the email address that can be used t Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -476,7 +496,7 @@ The PhotosEnabled parameter specifies whether photos for users in the internal o Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -492,7 +512,7 @@ The TargetApplicationUri parameter specifies the target Uniform Resource Identif Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -508,7 +528,7 @@ The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange W Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -524,7 +544,7 @@ The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook We Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -542,7 +562,7 @@ If you use this parameter, this URL is always used to reach the external Exchang Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -558,7 +578,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -572,12 +592,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md b/exchange/exchange-ps/exchange/Set-OrganizationSegment.md index c182a73e20..49cf493921 100644 --- a/exchange/exchange-ps/exchange/Set-OrganizationSegment.md +++ b/exchange/exchange-ps/exchange/Set-OrganizationSegment.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-organizationsegment -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-organizationsegment +applicable: Security & Compliance title: Set-OrganizationSegment schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-OrganizationSegment ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-OrganizationSegment cmdlet to modify organization segments in the Microsoft 365 compliance center. Organization Segments are not in effect until you [apply information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies#part-3-apply-information-barrier-policies). +Use the Set-OrganizationSegment cmdlet to modify organization segments in the Microsoft Purview compliance portal. Organization Segments are not in effect until you [apply information barrier policies](https://learn.microsoft.com/purview/information-barriers-policies#step-4-apply-ib-policies). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,9 +27,9 @@ Set-OrganizationSegment [-Identity] ``` ## DESCRIPTION -Segments are defined by using certain [attributes](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes) in Azure Active Directory. +Segments are defined by using certain [attributes](https://learn.microsoft.com/purview/information-barriers-attributes) in Microsoft Entra ID. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -53,7 +53,7 @@ The Identity parameter specifies the organization segment that you want to modif Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -63,12 +63,12 @@ Accept wildcard characters: False ``` ### -UserGroupFilter -The UserGroupFilter parameter uses OPath filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). +The UserGroupFilter parameter uses OPATH filter syntax to specify the members of the organization segment. The syntax is `"Property -ComparisonOperator 'Value'"` (for example, `"MemberOf -eq 'Engineering Department'"` or `"ExtensionAttribute1 -eq 'DayTrader'"`). -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. -- Property is a filterable property. For more information, see [Attributes for information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes). -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Property is a filterable property. For more information, see [Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). Use the same property for all of your segments, and verify that your segments don't overlap (a user must be assigned to only one segment). @@ -76,7 +76,7 @@ Use the same property for all of your segments, and verify that your segments do Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -90,18 +90,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Attributes for information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-attributes) +[Attributes for information barrier policies](https://learn.microsoft.com/purview/information-barriers-attributes) -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Set-OutboundConnector.md b/exchange/exchange-ps/exchange/Set-OutboundConnector.md index 7ff3333e97..a73f8dfcd5 100644 --- a/exchange/exchange-ps/exchange/Set-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/Set-OutboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-outboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/set-outboundconnector applicable: Exchange Online, Exchange Online Protection title: Set-OutboundConnector schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-OutboundConnector cmdlet to modify an existing Outbound connector in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,6 +35,7 @@ Set-OutboundConnector [-Identity] [-Name ] [-RecipientDomains ] [-RouteAllMessagesViaOnPremises ] + [-SenderRewritingEnabled ] [-SmartHosts ] [-TestMode ] [-TlsDomain ] @@ -50,7 +49,7 @@ Set-OutboundConnector [-Identity] ## DESCRIPTION Outbound connectors send email messages to remote domains that require specific configuration options. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,9 +85,11 @@ Accept wildcard characters: False ### -AllAcceptedDomains The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: -- $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. You can only use this value when the ConnectorType parameter value is OnPremises. +- $true: The Outbound connector is used in hybrid organizations when message recipients are in an accepted domain of the cloud-based organization. This setting requires OnPremises for the ConnectorType value. - $false: The Outbound connector isn't used in hybrid organizations. This is the default value. +This parameter is effective only for OnPremises connectors. + ```yaml Type: Boolean Parameter Sets: (All) @@ -103,7 +104,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -245,6 +246,8 @@ The IsValidated parameter specifies whether the Outbound connector has been vali - $true: The connector has been validated, - $false: The connector hasn't been validated. This is the default value. +Use the Validate-OutboundConnector cmdlet to validate the connector. + ```yaml Type: Boolean Parameter Sets: (All) @@ -264,7 +267,9 @@ The LastValidationTimestamp parameter specifies the date/time that the Outbound To specify a date/time value for this parameter, use either of the following options: - Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z". -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +Use the Validate-OutboundConnector cmdlet to validate the connector. ```yaml Type: DateTime @@ -314,10 +319,33 @@ Accept wildcard characters: False ``` ### -RouteAllMessagesViaOnPremises -The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises messaging system. Valid values are: +The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises email system. Valid values are: + +- $true: Messages are routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. +- $false: Messages aren't routed through the on-premises email system. This is the default value. -- $true: Messages are routed through the on-premises messaging system. This setting requires you to set the ConnectorType parameter to the value OnPremises in the same command. -- $false: Messages aren't routed through the on-premises messaging system. This is the default value. +This parameter is effective only for OnPremises connectors. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SenderRewritingEnabled +The SenderRewritingEnabled parameter specifies that all messages that normally qualify for SRS rewriting are rewritten for routing through the on-premises email system. Valid values are: + +- $true: Messages are rewritten by SRS as needed before being routed through the on-premises email system. This setting requires OnPremises for the ConnectorType value. +- $false: Messages aren't rewritten by SRS before being routed through the on-premises email system. This is the default value. + +This parameter is effective only for OnPremises connectors. ```yaml Type: Boolean @@ -336,7 +364,7 @@ Accept wildcard characters: False The SmartHosts parameter specifies the smart host that the Outbound connector uses to route mail. Valid values are: - FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record: For example, mail.contoso.com. -- Single IP address: For example, 10.10.1.1 +- Single IP address: For example, 10.10.1.1. - Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. You can specify multiple value separated by commas: `"Value1","Value2",..."ValueN"`. @@ -376,7 +404,11 @@ Accept wildcard characters: False ``` ### -TlsDomain -The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is only used if the TlsSettings parameter is set to DomainValidation. Valid input for the TlsDomain parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: \*.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.\*.contoso.com +The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. A valid value for this parameter is an SMTP domain. + +Wildcards are supported to specify all subdomains of a domain (for example, \*.contoso.com), but you can't embed the wildcard character within the domain (for example, domain.\*.contoso.com). + +This parameter meaningful only when the TlsSettings value is DomainValidation. ```yaml Type: SmtpDomainWithSubdomains @@ -416,7 +448,7 @@ Accept wildcard characters: False The UseMXRecord parameter enables or disables DNS routing for the connector. Valid values are: - $true: The connector uses DNS routing (MX records in DNS) to deliver email. This is the default value. -- $false: The connector delivers email to one or more smart hosts. When you use this value, you also need to specify the smart hosts by using the SmartHosts parameter in the same command. +- $false: The connector delivers email to one or more smart hosts. This setting requires one or more smart hosts for the SmartHosts value. ```yaml Type: Boolean @@ -468,12 +500,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md b/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md index e333fcb34f..bdc199f0c5 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md +++ b/exchange/exchange-ps/exchange/Set-OutlookAnywhere.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-outlookanywhere +online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookanywhere applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-OutlookAnywhere schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-OutlookAnywhere cmdlet to modify Outlook Anywhere virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. Outlook Anywhere uses virtual directories that contain "rpc" in the name. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,9 +43,9 @@ Set-OutlookAnywhere [-Identity] ``` ## DESCRIPTION -For more information about the different authentication methods that you can see in this article, see [Understanding HTTP Authentication](https://docs.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication). +For more information about the different authentication methods that you can see in this article, see [Understanding HTTP Authentication](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/understanding-http-authentication). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -455,12 +455,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md b/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md index 8684864731..9e222994d5 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md +++ b/exchange/exchange-ps/exchange/Set-OutlookProtectionRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-outlookprotectionrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookprotectionrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-OutlookProtectionRule schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-OutlookProtectionRule cmdlet to modify an existing Microsoft Outlook protection rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,11 +39,11 @@ Set-OutlookProtectionRule [-Identity] ``` ## DESCRIPTION -Outlook protection rules are used to automatically rights-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://docs.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). +Outlook protection rules are used to automatically rights-protect email messages using a Rights Management Services (RMS) template before the message is sent. However, Outlook protection rules don't inspect message content. To rights-protect messages based on message content, use transport protection rules. For more information, see [Outlook protection rules](https://learn.microsoft.com/exchange/outlook-protection-rules-exchange-2013-help). Not specifying any conditions results in an Outlook protection rule being applied to all messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -133,7 +133,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress the confirmation prompt produced by the cmdlet when modifying a rule with no conditions, resulting in such rules being applied to all messages. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to suppress the confirmation prompt that appears when you modify a rule with no conditions (the rule applies to all messages). ```yaml Type: SwitchParameter @@ -284,12 +286,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OutlookProvider.md b/exchange/exchange-ps/exchange/Set-OutlookProvider.md index bd589a22de..3d9413c338 100644 --- a/exchange/exchange-ps/exchange/Set-OutlookProvider.md +++ b/exchange/exchange-ps/exchange/Set-OutlookProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-outlookprovider +online version: https://learn.microsoft.com/powershell/module/exchange/set-outlookprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-OutlookProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-OutlookProvider cmdlet to set specific global settings using the msExchOutlookProvider attribute on the msExchAutoDiscoverConfig object in Active Directory. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Set-OutlookProvider [-Identity] ## DESCRIPTION The Set-OutlookProvider cmdlet creates the global settings for the Autodiscover service. It sets the AutoDiscoverConfig object under the Global Settings object in Active Directory and sets the attributes specified in the parameters listed in the Parameters section. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -152,11 +152,11 @@ Accept wildcard characters: False ``` ### -RequiredClientVersions -The RequiredClientVersions parameter specifies the minimum version of Microsoft Outlook that's allowed to connect to the Exchange server. This information is in the Autodiscover response to the client connection request. This parameter uses the syntax `"MinimumVersion, ExpirationDate"`. +The RequiredClientVersions parameter specifies the minimum version of Microsoft Outlook that's allowed to connect to the Exchange server. This information is in the Autodiscover response to the client connection request. This parameter uses the syntax `"MinimumVersion, ExpirationDate"`. MinimumVersion is the version of Outlook in the format xx.x.xxxx.xxxx. For example, to specify Outlook 2010 Service Pack 2 (SP2), use the value 14.0.7012.1000. -ExpirationDate is the UTC date-time when connections by older versions of Outlook will be blocked. The UTC date-time is represented in the ISO 8601 date-time format: yyyy-mm-ddThh:mm:ss.fffZ, where yyyy = year, mm = month, dd = day, T indicates the beginning of the time component, hh = hour, mm = minute, ss = second, fff = fractions of a second and Z signifies Zulu, which is another way to denote UTC. +ExpirationDate is the UTC date-time when connections by older versions of Outlook will be blocked. The UTC date-time is represented in the ISO 8601 date-time format: yyyy-MM-ddThh:mm:ss.fffZ, where yyyy = year, MM = month, dd = day, T indicates the beginning of the time component, hh = hour, mm = minute, ss = second, fff = fractions of a second and Z signifies Zulu, which is another way to denote UTC. An example of a valid value for this parameter is `"14.0.7012.1000, 2020-01-01T12:00:00Z"`. @@ -228,12 +228,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md index 4cfb001a79..ffb11aae40 100644 --- a/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-OwaMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-owamailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-owamailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-OwaMailboxPolicy schema: 2.0.0 @@ -16,26 +16,32 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-OwaMailboxPolicy cmdlet to configure existing Outlook on the web mailbox policies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-OwaMailboxPolicy [-Identity] + [-AccountTransferEnabled ] [-ActionForUnknownFileAndMIMETypes ] [-ActiveSyncIntegrationEnabled ] + [-AdditionalAccountsEnabled ] [-AdditionalStorageProvidersAvailable ] [-AllAddressListsEnabled ] [-AllowCopyContactsToDeviceAddressBook ] [-AllowedFileTypes ] [-AllowedMimeTypes ] + [-AllowedOrganizationAccountDomains ] [-AllowOfflineOn ] + [-BizBarEnabled ] [-BlockedFileTypes ] [-BlockedMimeTypes ] [-BookingsMailboxCreationEnabled ] + [-BookingsMailboxDomain ] [-BoxAttachmentsEnabled ] [-CalendarEnabled ] [-ChangePasswordEnabled ] + [-ChangeSettingsAccountEnabled ] [-ClassicAttachmentsEnabled ] [-ConditionalAccessPolicy ] [-Confirm] @@ -49,6 +55,7 @@ Set-OwaMailboxPolicy [-Identity] [-DisplayPhotosEnabled ] [-DomainController ] [-DropboxAttachmentsEnabled ] + [-EmptyStateEnabled ] [-ExplicitLogonEnabled ] [-ExternalImageProxyEnabled ] [-ExternalSPMySiteHostURL ] @@ -64,30 +71,40 @@ Set-OwaMailboxPolicy [-Identity] [-GlobalAddressListEnabled ] [-GoogleDriveAttachmentsEnabled ] [-GroupCreationEnabled ] + [-HideClassicOutlookToggleOut ] [-InstantMessagingEnabled ] [-InstantMessagingType ] [-InterestingCalendarsEnabled ] [-InternalSPMySiteHostURL ] [-IRMEnabled ] [-IsDefault] + [-ItemsToOtherAccountsEnabled ] [-JournalEnabled ] [-JunkEmailEnabled ] [-LinkedInEnabled ] [-LocalEventsEnabled ] [-LogonAndErrorLanguage ] [-MessagePreviewsDisabled ] + [-MonthlyUpdatesEnabled ] [-Name ] [-NotesEnabled ] [-NpsSurveysEnabled ] - [-OrganizationEnabled ] + [-OfflineEnabledWeb ] + [-OfflineEnabledWin ] [-OneDriveAttachmentsEnabled ] + [-OneWinNativeOutlookEnabled ] [-OnSendAddinsEnabled ] + [-OrganizationEnabled ] [-OutboundCharset ] [-OutlookBetaToggleEnabled ] - [] + [-OutlookDataFile ] + [-OutlookNewslettersAccessLevel ] + [-OutlookNewslettersReactions ] + [-OutlookNewslettersShowMore ] [-OWALightEnabled ] [-OWAMiniEnabled ] [-PersonalAccountCalendarsEnabled ] + [-PersonalAccountsEnabled ] [-PhoneticSupportEnabled ] [-PlacesEnabled ] [-PremiumClientEnabled ] @@ -109,6 +126,7 @@ Set-OwaMailboxPolicy [-Identity] [-SilverlightEnabled ] [-SkipCreateUnifiedGroupCustomSharepointClassification ] [-SMimeEnabled ] + [-SMimeSuppressNameChecksEnabled ] [-SpellCheckerEnabled ] [-TasksEnabled ] [-TeamSnapCalendarsEnabled ] @@ -144,9 +162,9 @@ Set-OwaMailboxPolicy [-Identity] ## DESCRIPTION In on-premises Exchange, the default Outlook on the web mailbox policy is named Default. In Exchange Online, the default Outlook on the web mailbox policy is named OwaMailboxPolicy-Default. -Changes to Outlook on the web mailbox polices may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (Stop-Service WAS -Force and Start-Service W3SVC). +Changes to Outlook on the web mailbox policies may take up to 60 minutes to take effect. In on-premises Exchange, you can force an update by restarting IIS (`Stop-Service WAS -Force` and `Start-Service W3SVC`). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -200,6 +218,24 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AccountTransferEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ActionForUnknownFileAndMIMETypes The ActionForUnknownFileAndMIMETypes parameter specifies how to handle file types that aren't specified in the Allow, Block, and Force Save lists for file types and MIME types. Valid values are: @@ -260,6 +296,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AdditionalAccountsEnabled +This parameter is available only in the cloud-based service. + +This parameter has been deprecated and is no longer used. + +To enable or disable personal accounts in the new Outlook for Windows, use the PersonalAccountsEnabled parameter. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllAddressListsEnabled The AllAddressListsEnabled parameter specifies which address lists are available in Outlook on the web. Valid values are: @@ -355,8 +411,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowedOrganizationAccountDomains +This parameter is available only in the cloud-based service. + +The AllowedOrganizationAccountDomains parameter specifies domains where users can add work or school email accounts in the new Outlook for Windows. The default value is blank ($null), which allows work or school accounts from any domain. Setting this parameter to an empty list ([]) prevents any work or school accounts from being added. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AllowOfflineOn -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The AllowOfflineOn parameter specifies when Outlook Web App in offline mode is available for supported web browsers. Valid values are: @@ -379,6 +453,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BizBarEnabled +This parameter is available only in the cloud-based service. + +{{ Fill BizBarEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BlockedFileTypes The BlockedFileTypes parameter specifies a list of attachment file types (file extensions) that can't be saved locally or viewed from Outlook on the web. The default values are: @@ -458,6 +550,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -BookingsMailboxDomain +This parameter is available only in the cloud-based service. + +{{ Fill BookingsMailboxDomain Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BoxAttachmentsEnabled This parameter is available only in on-premises Exchange. @@ -477,7 +587,7 @@ Accept wildcard characters: False ``` ### -CalendarEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The CalendarEnabled parameter specifies whether to enable or disable the calendar in Outlook Web App. Valid values are: @@ -498,7 +608,7 @@ Accept wildcard characters: False ``` ### -ChangePasswordEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The ChangePasswordEnabled parameter specifies whether users can change their passwords from inside Outlook on the web. Valid values are: @@ -518,6 +628,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ChangeSettingsAccountEnabled +This parameter is available only in the cloud-based service. + +The ChangeSettingsAccountEnabled parameter specifies whether users can change the email account where app-wide settings (for example, theme and privacy settings) are associated in the new Outlook for Windows. Valid values are: + +- $true: Users can change their settings account in the new Outlook for Windows. This is the default value. +- $false: Users can't change their settings account in the new Outlook for Windows. + +**Note**: The settings account is referred to as the primary account in the new Outlook for Windows setting at Settings \> Accounts \> Email accounts \> Manage. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClassicAttachmentsEnabled The ClassicAttachmentsEnabled parameter specifies whether users can attach local files as regular email attachments in Outlook on the web. Valid values are: @@ -540,15 +673,15 @@ Accept wildcard characters: False ### -ConditionalAccessPolicy This parameter is available only in the cloud-based service. -The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to work properly, you also need to configure a Conditional Access policy in the Azure Active Directory Portal. +The ConditionalAccessPolicy parameter specifies the Outlook on the Web Policy for limited access. For this feature to work properly, you also need to configure a Conditional Access policy in the Microsoft Entra admin center. **Note**: When you enable a Conditional Access policy, users will no longer be able to access the light version of Outlook on the web. An error message will direct them to use the default premium experience. Valid values are: - Off: No conditional access policy is applied to Outlook on the web. This is the default value. -- ReadOnly: Users can't download attachments to their local computer, and can't enable Offline Mode on non-compliant computers. They can still view attachments in the browser. -- ReadOnlyPlusAttachmentsBlocked: All restrictions from ReadOnly apply, but users can't view attachments in the browser. +- ReadOnly: Users can't download attachments to their local computer, and can't enable Offline Mode on non-compliant computers. They can still view attachments in the browser. This doesn't apply to in-line images. +- ReadOnlyPlusAttachmentsBlocked: All restrictions from ReadOnly apply, but users can't view attachments in the browser. This doesn't apply to in-line images. ```yaml Type: PolicyEnum @@ -583,7 +716,7 @@ Accept wildcard characters: False ``` ### -ContactsEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The ContactsEnabled parameter specifies whether to enable or disable Contacts in Outlook Web App. Valid values are: @@ -620,7 +753,7 @@ Accept wildcard characters: False ``` ### -DefaultTheme -The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://docs.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). +The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). Note that this parameter is a text string, and the value you specify isn't validated against the list of available themes. @@ -638,7 +771,7 @@ Accept wildcard characters: False ``` ### -DelegateAccessEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The DelegateAccessEnabled parameter specifies whether delegates can use Outlook on the web or Outlook Web App to open folders that they have delegate access to. Valid values are: @@ -680,7 +813,7 @@ Accept wildcard characters: False ``` ### -DirectFileAccessOnPublicComputersEnabled -The DirectFileAccessOnPrivateComputersEnabled parameter specifies the left-click options for attachments in Outlook on the web for public computer sessions. Valid values are: +The DirectFileAccessOnPublicComputersEnabled parameter specifies the left-click options for attachments in Outlook on the web for public computer sessions. Valid values are: - $true: Open is available for attachments in Outlook on the web for public computer sessions. This is the default value. - $false: Open isn't available for attachments in Outlook on the web for public computer sessions. Note that Office and .pdf documents can still be previewed in Outlook on the web. @@ -703,14 +836,14 @@ Accept wildcard characters: False ### -DisableFacebook This parameter is available only in the cloud-based service. -Facebook integration is no longer available. For more information, see [Facebook Connect is no longer available](https://support.microsoft.com/office/facebook-connect-is-no-longer-available-f31c8107-7b5a-4e3d-8a22-e506dacb6db6). +**Note**: Facebook integration is no longer available. For more information, see [Facebook Connect is no longer available](https://support.microsoft.com/office/facebook-connect-is-no-longer-available-f31c8107-7b5a-4e3d-8a22-e506dacb6db6). The DisableFacebook switch specifies whether users can synchronize their Facebook contacts to their Contacts folder in Outlook on the web. By default, Facebook integration is enabled. - To disable Facebook integration, use this switch without a value. -- To enable Facebook integration after it's been disabled, use this exact syntax: -DisableFacebook:$false. +- To enable Facebook integration after it's been disabled, use this exact syntax: `-DisableFacebook:$false`. -Note that the value of this parameter is stored in the FacebookEnabled property in the output of the Get-OwaMailboxPolicy cmdlet. +The value of this switch is stored in the FacebookEnabled property in the output of the Get-OwaMailboxPolicy cmdlet. ```yaml Type: SwitchParameter @@ -780,8 +913,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EmptyStateEnabled +This parameter is available only in the cloud-based service. + +{{ Fill EmptyStateEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExplicitLogonEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The ExplicitLogonEnabled parameter specifies whether to allow a user to open someone else's mailbox in Outlook on the web (provided that user has permissions to the mailbox). Valid values are: @@ -825,7 +976,7 @@ Accept wildcard characters: False ### -ExternalSPMySiteHostURL The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, `https://sp01.contoso.com`). -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. +This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. ```yaml Type: String @@ -1029,7 +1180,7 @@ Accept wildcard characters: False ``` ### -FreCardsEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. This parameter is reserved for internal Microsoft use. @@ -1084,7 +1235,7 @@ Accept wildcard characters: False ``` ### -GroupCreationEnabled -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The GroupCreationEnabled parameter specifies whether Microsoft 365 Group creation is available in Outlook and Outlook on the web. Valid values are: @@ -1104,6 +1255,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HideClassicOutlookToggleOut +This parameter is available only in the cloud-based service. + +The HideClassicOutlookToggleOut parameter specifies whether to enable or disable hiding the toggle in new Outlook that allows users to switch back to classic Outlook. Valid values are: + +- $true: The toggle to switch back to classic Outlook is hidden in new Outlook for Windows. +- $false: The toggle to switch back to classic Outlook isn't hidden in new Outlook for Windows. This is the default value. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InstantMessagingEnabled The InstantMessagingEnabled parameter specifies whether instant messaging is available in Outlook on the web. This does not affect chat capabilities provided by Skype for Business or Teams. Valid values are: @@ -1166,7 +1338,7 @@ Accept wildcard characters: False ### -InternalSPMySiteHostURL The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, `https://sp01.contoso.com`). -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. +This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. ```yaml Type: String @@ -1205,7 +1377,7 @@ The IsDefault switch specifies whether the Outlook on the web policy is the defa If another policy is currently set as the default, this switch replaces the old default policy with this policy. -**Note**: In Exchange Online - and excluding resource mailboxes - this value will be superseded by the **OwaMailboxPolicy** parameter in each organization's [CASMailboxPlan](https://docs.microsoft.com/powershell/module/exchange/set-casmailboxplan). That value will instead be applied per each mailbox's SKU. +**Note**: In Exchange Online - and excluding resource mailboxes - this value will be superseded by the **OwaMailboxPolicy** parameter in each organization's [CASMailboxPlan](https://learn.microsoft.com/powershell/module/exchange/set-casmailboxplan). That value will instead be applied per each mailbox's SKU. ```yaml Type: SwitchParameter @@ -1220,6 +1392,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ItemsToOtherAccountsEnabled +This parameter is available only in the cloud-based service. + +The ItemsToOtherAccountsEnabled parameter specifies whether users can move or copy email messages between accounts. Valid values are: + +- $true: Users can move and copy messages to and from external accounts. +- $false: Users can't move or copy messages to and from external accounts. This is the default value. + +**Note:** This policy doesn't affect moving or copying messages between Microsoft 365 Groups and shared mailboxes within the organization. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -JournalEnabled The JournalEnabled parameter specifies whether the Journal folder is available in Outlook on the web. Valid values are: @@ -1337,6 +1532,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MonthlyUpdatesEnabled +This parameter is available only in the cloud-based service. + +{{ Fill MonthlyUpdatesEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The Name parameter specifies the unique name for the policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. @@ -1393,6 +1606,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OfflineEnabledWeb +This parameter is available only in the cloud-based service. + +The OfflineEnabledWeb parameter specifies whether offline capabilities are available in Outlook on the web, including saving items to the local device (view items without an internet connection). Valid values are: + +- $true: Users can manage offline capabilities in Outlook on the web. This is the default value. +- $false: Users can't manage offline capabilities in Outlook on the web. No items are saved to the user's device. Previously save items are deleted. + +When offline capabilities are available, users can turn offline capabilities on or off themselves in Outlook on the web at Settings \> General \> Offline. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OfflineEnabledWin +This parameter is available only in the cloud-based service. + +The OfflineEnabledWin parameter specifies whether offline capabilities are available in the new Outlook for Windows, including saving items to the local device (view items without an internet connection). Valid values are: + +- $true: Users can manage offline capabilities in the new Outlook for Windows. This is the default value. +- $false: Users can't manage offline capabilities in the new Outlook for Windows. No items are saved to the user's device. Previously save items are deleted. + +When offline capabilities are available, users can turn offline capabilities on or off themselves in the New Outlook for Windows at Settings \> General \> Offline. By default, offline capabilities are turned on. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OneDriveAttachmentsEnabled This parameter has been deprecated and is no longer used. @@ -1411,6 +1670,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OneWinNativeOutlookEnabled +This parameter is available only in the cloud-based service. + +The OneWinNativeOutlookEnabled parameter controls the availability of the new Outlook for Windows App. Valid values are: + +- $true: The New Outlook for Windows App is available. This is the default value. +- $false: The new Outlook for Windows App isn't available. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OnSendAddinsEnabled The OnSendAddinsEnabled parameter specifies whether to enable or disable on send add-ins in Outlook on the web (add-ins that support events when a user clicks Send). Valid values are: @@ -1487,11 +1766,107 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OutlookNewslettersAccessLevel +This parameter is available only in the cloud-based service. + +The OutlookNewslettersAccessLevelAccess parameter specifies the access level in Outlook Newsletters. Valid values are: + +- NoAccess: No access to Outlook Newsletters in the New Outlook for Windows or Outlook on the web. Users can still read email messages sent or forwarded to them. +- ReadOnly: Read newsletters and browse pages in Outlook Newsletters. +- ReadWrite: Full authoring permissions to create pages and newsletters in Outlook Newsletters. +- Undefined: This is the default value. Currently, this value is equivalent to NoAccess. + +```yaml +Type: OutlookNewslettersAccessLevel +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookDataFile +This parameter is available only in the cloud-based service. + +The OutlookDataFile parameter specifies what users can do with .pst files in the new Outlook for Windows. Valid values are: + +- Allow: The default value. Users can open .pst files, import from a .pst file to a mailbox, export from a mailbox to a .pst file, and copy items to and from .pst files. +- NoExport: Users can't export from a mailbox to a .pst file. +- NoExportNoGrow: Users can't export from a mailbox to a .pst file, or copy items from a mailbox to a .pst file. +- NoExportNoOpen: Users can't export from a mailbox to a .pst file, or open new .pst files. +- NoExportNoOpenNoGrow: Users can't export from a mailbox to a .pst file, copy items from a mailbox to a .pst file, or open new .pst files. +- Deny: Users can't open new .pst files, import from a .pst file to a mailbox, export from a mailbox to a .pst file, or copy items to and from .pst files. + +```yaml +Type: OutlookDataFileFeatureState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: Allow +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookNewslettersReactions +This parameter is available only in the cloud-based service. + +The OutlookNewslettersReactions parameter specifies whether reactions are enabled in Outlook Newsletters. Readers can react to individual sections or the entire newsletter. They can also comment using integrated controls at the end of the newsletter. Valid values are: + +- DefaultOff: The controls are turned off. +- DefaultOn: The controls are turned on. +- Disabled: The controls are disabled for users. +- Undefined: This is the default value. + +```yaml +Type: OutlookNewslettersFeatureState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutlookNewslettersShowMore +This parameter is available only in the cloud-based service. + +The OutlookNewslettersShowMore parameter specifies whether recommendations to other Outlook Newsletters are included in the footer of published newsletter editions. Valid values are: + +- DefaultOff: Recommendations are turned off. +- DefaultOn: Recommendations are turned on. +- Disabled: Recommendations are disabled for users. +- Undefined: This is the default value. + +Authors can disable these recommendations for each individual newsletter edition, or admins can use this parameter to globally disable these recommendations. + +```yaml +Type: OutlookNewslettersFeatureState +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OWALightEnabled The OWALightEnabled parameter controls the availability of the light version of Outlook on the web. Valid values are: - $true: The light version of Outlook on the web is available. This is the default value. -- $false: The light version of Outlook on the web is isn't available. This setting prevents access to Outlook on the web for unsupported browsers that can only use the light version of Outlook on the web. +- $false: The light version of Outlook on the web isn't available. This setting prevents access to Outlook on the web for unsupported browsers that can only use the light version of Outlook on the web. ```yaml Type: Boolean @@ -1548,6 +1923,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PersonalAccountsEnabled +This parameter is available only in the cloud-based service. + +The PersonalAccountsEnabled parameter specifies whether to allow users to add their personal accounts (for example, Outlook.com, Gmail, or Yahoo!) in the new Outlook for Windows. Valid values are: + +- $true: Users can add their personal accounts in the new Outlook for Windows. This is the default value. +- $false: Users can't add their personal accounts in the new Outlook for Windows. + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PhoneticSupportEnabled The PhoneticSupportEnabled parameter specifies phonetically spelled entries in the address book. This parameter is available for use in Japan. @@ -1649,7 +2045,7 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The PublicFoldersEnabled parameter specifies whether a user can browse or read items in public folders in Outlook Web App. Valid values are: @@ -1670,7 +2066,7 @@ Accept wildcard characters: False ``` ### -RecoverDeletedItemsEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outlook Web App to view, recover, or delete permanently items that have been deleted from the Deleted Items folder. Valid values are: @@ -1731,6 +2127,8 @@ Accept wildcard characters: False ``` ### -ReportJunkEmailEnabled +**Note**: In Exchange Online, this parameter does not affect the ability of users to report messages. Whether a user is able to report messages and where is controlled in the Microsoft Defender portal as described in [User reported message settings](https://learn.microsoft.com/defender-office-365/submissions-user-reported-messages-custom-mailbox). + The ReportJunkEmailEnabled parameter specifies whether users can report messages as junk or not junk to Microsoft in Outlook on the web. Valid values are: - $true: This is the default value. Selecting a message in the Junk Email folder and clicking **Not junk** \> **Not junk** moves the message back into the Inbox and gives users the option to report the message to Microsoft. Selecting a message in any other email folder and clicking **Junk** \> **Junk folder** moves the message to the Junk Email folder and gives users the option to report the message to Microsoft. Selecting a message and clicking **Not junk** \> **Phishing** (in the Junk Email folder) and **Junk** \> **Phishing** (everywhere else) are available to report phishing messages to Microsoft. @@ -1833,6 +2231,8 @@ The SetPhotoEnabled parameter specifies whether users can add, change, and remov - $true: Users can manage their photos in Outlook on the web. This is the default value. - $false: Users can't manage their user photo in Outlook on the web. +**Note**: To control whether users can update photos for Exchange Online, see [Configure User Administrator support for profile photo updates](https://learn.microsoft.com/graph/profilephoto-configure-settings#configure-user-administrator-support-for-profile-photo-updates). + ```yaml Type: Boolean Parameter Sets: (All) @@ -1900,7 +2300,7 @@ Accept wildcard characters: False ``` ### -SilverlightEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SilverlightEnabled parameter specifies whether a user can use Microsoft Silverlight features in Outlook Web App. Valid values are: @@ -1921,7 +2321,7 @@ Accept wildcard characters: False ``` ### -SkipCreateUnifiedGroupCustomSharepointClassification -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The SkipCreateUnifiedGroupCustomSharepointClassification parameter specifies whether to skip a custom SharePoint page during the creation of Microsoft 365 Groups in Outlook on the web. Valid values are: @@ -1942,14 +2342,14 @@ Accept wildcard characters: False ``` ### -SMimeEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: - $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This is the default value. - $false: Users can't read or compose messages in Outlook Web App that are opaque-signed or encrypted by using S/MIME. Messages that are clear-signed can be read but not composed, and their signatures aren't validated. -**Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see [S/MIME for message signing and encryption](https://docs.microsoft.com/Exchange/policy-and-compliance/smime). +**Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see [S/MIME for message signing and encryption](https://learn.microsoft.com/Exchange/policy-and-compliance/smime). ```yaml Type: Boolean @@ -1964,8 +2364,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SMimeSuppressNameChecksEnabled +This parameter is available only in the cloud-based service. + +The SMimeSuppressNameChecksEnabled switch specifies whether to suppress name check in S/MIME messages. You don't need to specify a value with this switch. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SpellCheckerEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SpellCheckerEnabled parameter specifies whether to enable or disable the built-in Outlook Web App spell checker in the full version of Outlook Web App. Valid values are: @@ -1988,7 +2406,7 @@ Accept wildcard characters: False ``` ### -TasksEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The TasksEnabled parameter specifies whether Tasks folder is available in Outlook Web App. Valid values are: @@ -2187,7 +2605,7 @@ Accept wildcard characters: False ``` ### -UserVoiceEnabled -This parameter is available or functional only in the cloud-based service. +This parameter is functional only in the cloud-based service. The UserVoiceEnabled parameter specifies whether to enable or disable Outlook UserVoice in Outlook on the web. Outlook UserVoice is a customer feedback area that's available in Microsoft 365. Valid values are: @@ -2576,22 +2994,22 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS -[New-OwaMailboxPolicy](https://docs.microsoft.com/powershell/module/exchange/new-owamailboxpolicy) +[New-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchange/new-owamailboxpolicy) -[Get-OwaMailboxPolicy](https://docs.microsoft.com/powershell/module/exchange/get-owamailboxpolicy) +[Get-OwaMailboxPolicy](https://learn.microsoft.com/powershell/module/exchange/get-owamailboxpolicy) -[Set-CASMailbox](https://docs.microsoft.com/powershell/module/exchange/set-casmailbox) +[Set-CASMailbox](https://learn.microsoft.com/powershell/module/exchange/set-casmailbox) -[Outlook on the web mailbox policy procedures in Exchange Online](https://docs.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-on-the-web/outlook-web-app-mailbox-policy-procedures) +[Outlook on the web mailbox policy procedures in Exchange Online](https://learn.microsoft.com/exchange/clients-and-mobile-in-exchange-online/outlook-on-the-web/outlook-web-app-mailbox-policy-procedures) diff --git a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md index 7e311f69b9..14358aa512 100644 --- a/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-OwaVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-owavirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/set-owavirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-OwaVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-OwaVirtualDirectory cmdlet to modify existing Outlook on the web virtual directories that are used in Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -157,11 +157,11 @@ Before you run the Set-OwaVirtualDirectory cmdlet, consider the following items: - You must have Write access to virtual directory objects in the metabase for some properties, such as Authentication and GZip. If you don't have the necessary permissions to run the Set-OwaVirtualDirectory cmdlet on a metabase virtual directory object or on a parameter that writes to the metabase, the cmdlet fails. - Verify that the data source can be read. Depending on the properties that you want to set on an Outlook on the web virtual directory, you may want to run the cmdlet in a test environment on the Outlook on the web virtual directory object in Active Directory, the metabase, or both. - You can run the Set-OwaVirtualDirectory cmdlet on any server that has the Exchange Server administration tools installed. -- Several parameters for the Set-OwaVirtualDirectory cmdlet can contain more than one value. These are known as multivalued properties. Make sure that you modify multivalued properties correctly. For information, see [Modifying multivalued properties](https://docs.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). +- Several parameters for the Set-OwaVirtualDirectory cmdlet can contain more than one value. These are known as multivalued properties. Make sure that you modify multivalued properties correctly. For information, see [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). - Many of the Outlook on the web virtual directory settings require you to restart IIS (Stop-Service WAS -Force and Start-Service W3SVC) before the change takes effect. For example, when you enable or disable forms-based authentication, or when you enable or disable the Private computer option on the sign-in page. - To switch from forms-based authentication to Basic authentication, you must first disable forms-based authentication, and then as a separate task, enable Basic authentication. You can't disable forms-based authentication and enable Basic authentication in a single task. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -688,7 +688,7 @@ Accept wildcard characters: False ``` ### -DefaultTheme -The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://docs.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). +The DefaultTheme parameter specifies the default theme that's used in Outlook on the web when the user hasn't selected a theme. The default value is blank ($null). For more information about the built-in themes that are available in Outlook on the web, see [Default Outlook on the web themes in Exchange](https://learn.microsoft.com/Exchange/clients/outlook-on-the-web/themes#default-outlook-on-the-web-themes-in-exchange-2016). Note that this parameter is a text string, and the value you specify isn't validated against the list of available themes. @@ -706,7 +706,7 @@ Accept wildcard characters: False ``` ### -DelegateAccessEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The DelegateAccessEnabled parameter specifies whether delegates can use Outlook Web App to open folders that they have delegate access to. Valid values are: @@ -841,7 +841,7 @@ Accept wildcard characters: False ``` ### -Exchange2003Url -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The Exchange2003Url parameter specifies the Outlook Web App URL for Exchange Server 2003 mailboxes. The URL must include the Outlook Web App virtual directory name, even if you're using a redirect to simplify the URL specified by the Exchange2003Url parameter. @@ -1022,7 +1022,7 @@ Accept wildcard characters: False ### -ExternalSPMySiteHostURL The ExternalSPMySiteHostURL specifies the My Site Host URL for external users (for example, `https://sp01.contoso.com`). -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. +This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. ```yaml Type: String @@ -1457,7 +1457,7 @@ Accept wildcard characters: False ### -InternalSPMySiteHostURL The InternalSPMySiteHostURL specifies the My Site Host URL for internal users (for example, `https://sp01.contoso.com`). -This parameter is part of rich document collaboration that allows links to documents in OneDrive for Business to appear as regular file attachments in messages. +This parameter is part of rich document collaboration that allows links to documents in OneDrive to appear as regular file attachments in messages. ```yaml Type: String @@ -1691,7 +1691,7 @@ Accept wildcard characters: False ``` ### -NotificationInterval -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The NotificationInterval parameter specifies the polling frequency in seconds that the client polls the server for new item notifications, reminder updates, and session time-out information in Outlook Web App. @@ -1840,7 +1840,7 @@ Accept wildcard characters: False ``` ### -PublicFoldersEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The PublicFoldersEnabled parameter specifies whether a user can browse or read items in public folders in Outlook Web App. Valid values are: @@ -1861,7 +1861,7 @@ Accept wildcard characters: False ``` ### -RecoverDeletedItemsEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The RecoverDeletedItemsEnabled parameter specifies whether a user can use Outlook Web App to view, recover, or delete permanently items that have been deleted from the Deleted Items folder. Valid values are: @@ -1941,7 +1941,7 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsActionForUnknownServers -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -1959,7 +1959,7 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsAllowedServers -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -1977,7 +1977,7 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsBlockedServers -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -1995,7 +1995,7 @@ Accept wildcard characters: False ``` ### -RemoteDocumentsInternalDomainSuffixList -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. This parameter has been deprecated and is no longer used. @@ -2072,7 +2072,7 @@ Accept wildcard characters: False ``` ### -SearchFoldersEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SearchFoldersEnabled parameter specifies whether Search Folders are available in Outlook on the web. Valid values are: @@ -2147,7 +2147,7 @@ Accept wildcard characters: False ``` ### -SilverlightEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SilverlightEnabled parameter specifies whether a user can use Microsoft Silverlight features in Outlook Web App. Valid values are: @@ -2168,14 +2168,14 @@ Accept wildcard characters: False ``` ### -SMimeEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SMimeEnabled parameter specifies whether users can download the S/MIME control for Outlook Web App and use it to read and compose signed and encrypted messages. Valid values are: - $true: Users can read and compose S/MIME signed and encrypted messages in Outlook Web App. This is the default value. - $false: Users can't read or compose messages in Outlook Web App that are opaque-signed or encrypted by using S/MIME. Messages that are clear-signed can be read but not composed, and their signatures aren't validated. -**Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see [S/MIME for message signing and encryption](https://docs.microsoft.com/Exchange/policy-and-compliance/smime). +**Note**: In Exchange 2013 or later, use the Get-SmimeConfig and Set-SmimeConfig cmdlets to configure the S/MIME settings in Outlook on the web. For more information, see [S/MIME for message signing and encryption](https://learn.microsoft.com/Exchange/policy-and-compliance/smime). ```yaml Type: Boolean @@ -2191,7 +2191,7 @@ Accept wildcard characters: False ``` ### -SpellCheckerEnabled -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The SpellCheckerEnabled parameter specifies whether to enable or disable the built-in Outlook Web App spell checker in the full version of Outlook Web App. Valid values are: @@ -2730,12 +2730,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-PartnerApplication.md b/exchange/exchange-ps/exchange/Set-PartnerApplication.md index f4904ff47e..157ce52607 100644 --- a/exchange/exchange-ps/exchange/Set-PartnerApplication.md +++ b/exchange/exchange-ps/exchange/Set-PartnerApplication.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-partnerapplication -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-partnerapplication +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-PartnerApplication schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-PartnerApplication ## SYNOPSIS -This cmdlet is available or functional only in on-premises Exchange. +This cmdlet is functional only in on-premises Exchange. Use the Set-PartnerApplication cmdlet to configure partner application configurations in on-premises Exchange organizations. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -77,9 +77,9 @@ Set-PartnerApplication [-Identity] ``` ## DESCRIPTION -You can configure partner applications such as SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://docs.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. +You can configure partner applications such as SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see [Plan Exchange 2016 integration with SharePoint and Skype for Business](https://learn.microsoft.com/Exchange/plan-and-deploy/integration-with-sharepoint-and-skype/integration-with-sharepoint-and-skype). We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -104,7 +104,7 @@ The Identity parameter specifies the partner application you want to modify. You Type: PartnerApplicationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -226,7 +226,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -340,7 +340,7 @@ Accept wildcard characters: False ### -RefreshAuthMetadata This parameter is available only in on-premises Exchange. -The RefreshAuthMetadata switch specifies that the auth metadata should be refreshed from the authorization server. +The RefreshAuthMetadata switch refreshes the auth metadata from the authorization server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -358,7 +358,9 @@ Accept wildcard characters: False ### -TrustAnySSLCertificate This parameter is available only in on-premises Exchange. -The TrustAnySSLCertificate switch specifies whether Exchange should trust certificates issued by a certification authority (CA) not trusted by the server. We don't recommend using this switch in a production environment. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +We don't recommend using this switch in a production environment. ```yaml Type: SwitchParameter @@ -380,7 +382,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -394,12 +396,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md b/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md index 33be63d22d..a823ef0913 100644 --- a/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md +++ b/exchange/exchange-ps/exchange/Set-PendingFederatedDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-pendingfederateddomain +online version: https://learn.microsoft.com/powershell/module/exchange/set-pendingfederateddomain applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-PendingFederatedDomain schema: 2.0.0 @@ -18,7 +18,7 @@ The Set-PendingFederatedDomain cmdlet is used by the Exchange admin center to co The domains being added to the federation trust must exist as accepted domains in the Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Set-PendingFederatedDomain [[-Identity] ] ## DESCRIPTION This cmdlet allows the Exchange admin center to save domains selected as the FederatedOrganizationIdentifier or federated domains when proof of domain ownership hasn't been completed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -152,12 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md index c2106aa7bf..d104c470f0 100644 --- a/exchange/exchange-ps/exchange/Set-PerimeterConfig.md +++ b/exchange/exchange-ps/exchange/Set-PerimeterConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-perimeterconfig -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-perimeterconfig +applicable: Exchange Online, Exchange Online Protection title: Set-PerimeterConfig schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-PerimeterConfig cmdlet to modify the list of gateway server IP addresses that have been added to the cloud-based safelists. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -51,7 +49,7 @@ This parameter is reserved for internal Microsoft use. Type: OrganizationIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -70,7 +68,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -102,7 +100,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -116,12 +114,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md b/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md deleted file mode 100644 index 42bece63ac..0000000000 --- a/exchange/exchange-ps/exchange/Set-PhishFilterPolicy.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-phishfilterpolicy -applicable: Exchange Online, Exchange Online Protection -title: Set-PhishFilterPolicy -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-PhishFilterPolicy - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-PhishFilterPolicy cmdlet to configure the spoof intelligence policy in your cloud-based organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-PhishFilterPolicy [-Identity] -SpoofAllowBlockList - [-Action ] - [-Confirm] - [-WhatIf] - [] -``` - -## DESCRIPTION - -For more information about spoof intelligence, see [Configure spoof intelligence in EOP](https://docs.microsoft.com/microsoft-365/security/office-365-security/learn-about-spoof-intelligence). - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Get-PhishFilterPolicy -Detailed | Export-CSV "C:\My Documents\Spoofed Senders.csv" -$UpdateSpoofedSenders = Get-Content -Raw "C:\My Documents\Spoofed Senders.csv" -Set-PhishFilterPolicy -Identity Default -SpoofAllowBlockList $UpdateSpoofedSenders -``` - -This example configures the spoof intelligence policy to block or allow all spoofed email messages from a source email server. - -- Step 1: Write the output of the Get-PhishFilterPolicy cmdlet to a CSV file. -- Step 2: Add or modify the SpoofedUser and AllowedToSpoof values in the CSV file, save the file, and then read the file and store it as a variable named $UpdateSpoofedSenders. -- Step 3: Use the $UpdateSpoofedSenders variable to configure the spoof intelligence policy. - -### Example 2 -```powershell -Get-PhishFilterPolicy -Detailed | Export-CSV "C:\My Documents\Spoofed Senders.csv" -$UpdateSpoofedSenders = Get-Content -Raw "C:\My Documents\Spoofed Senders.csv" -Set-PhishFilterPolicy -Identity Default -SpoofAllowBlockList $UpdateSpoofedSenders -``` - -This example configures the spoof intelligence policy to selectively block or allow some spoofed email messages from a source email server. - -- Step 1: Write the output of the Get-PhishFilterPolicy cmdlet to a CSV file. -- Step 2: Add or modify the Sender, SpoofedUser, and AllowedToSpoof values in the CSV file, save the file, and then read the CSV file and store it as a variable named $UpdateSpoofedSenders. -- Step 3: Use the $UpdateSpoofedSenders variable to configure the spoof intelligence policy. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the spoof intelligence policy that you want to modify. The only valid value is Default. - -```yaml -Type: HostedConnectionFilterPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Action -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SetPhishFilterPolicyAction -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SpoofAllowBlockList -The SpoofAllowBlockList parameter specifies the CSV file that you want to use to configure the spoof intelligence policy. - -A valid value for this parameter reads the CSV file and stores it as a variable. For example, run the command `$SpoofedUsers = Get-Content -Raw ".csv"`, and then use the value `$SpoofedUsers` for this parameter. - -There are two basic options for the CSV file: - -- **Block or allow all spoofed mail from the source**: You want to block or allow any and all spoofed messages from the specified message source, regardless of the spoofed email address. You can get the CSV file by running the command `Get-PhishFilterPolicy -Detailed | Export-CSV ".csv"`. The important header fields (column headers) are: - - **Sender**: The domain of the source email server from reverse DNS lookup (PTR records), or the IP address if there aren't any PTR records. - - **AllowedToSpoof**: Indicates whether the message source is allowed to send spoofed messages. Valid values are Yes or No. - -- **Block or allow some spoofed mail from the source**: You want to block or allow some spoofed messages from the specified message source, but not others. You can get the CSV file by running the command `Get-PhishFilterPolicy -Detailed | Export-CSV ".csv"`. The important header fields (column headers) are: - - **Sender** - - **SpoofedUser**: The spoofed email address in your organization that the messages appear to be coming from. - - **AllowedToSpoof** - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: True -Position: Named -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md b/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md index 3ebd26d931..95798fa9a6 100644 --- a/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md +++ b/exchange/exchange-ps/exchange/Set-PhishSimOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-phishsimoverridepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-phishsimoverridepolicy +applicable: Exchange Online title: Set-PhishSimOverridePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-PhishSimOverridePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -Use the Set-PhishSimOverridePolicy cmdlet to modify third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). +Use the Set-PhishSimOverridePolicy cmdlet to modify third-party phishing simulation override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,13 +24,15 @@ For information about the parameter sets in the Syntax section below, see [Excha Set-PhishSimOverridePolicy [-Identity] [-Comment ] [-Confirm] + [-DomainController ] [-Enabled ] + [-Force] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -55,7 +57,7 @@ The Identity parameter specifies the phishing simulation override policy that yo Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: True Position: 0 @@ -71,7 +73,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -90,7 +92,23 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -109,7 +127,25 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -119,13 +155,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -139,12 +175,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-PhishSimOverrideRule.md b/exchange/exchange-ps/exchange/Set-PhishSimOverrideRule.md deleted file mode 100644 index 8183f00b28..0000000000 --- a/exchange/exchange-ps/exchange/Set-PhishSimOverrideRule.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-phishsimoverriderule -applicable: Security & Compliance Center -title: Set-PhishSimOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-PhishSimOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Set-PhishSimOverrideRule cmdlet to modify third-party phishing simulation override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-PhishSimOverrideRule [-Identity] - [-AddSenderDomainIs ] - [-AddSenderIpRanges ] - [-Comment ] - [-Confirm] - [-RemoveSenderDomainIs ] - [-RemoveSenderIpRanges ] - [-WhatIf] - [] -``` - -## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -## EXAMPLES - -### Example 1 -```powershell -Set-PhishSimOverrideRule -Identity PhishSimOverrideRulea0eae53e-d755-4a42-9320-b9c6b55c5011 -AddSenderDomainIs blueyonderairlines.com -RemoveSenderIpRanges 192.168.1.55 -``` - -This example modifies the phishing simulation override rule with the specified settings. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the phishing simulation override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AddSenderDomainIs -The AddSenderDomainIs parameter specifies an existing entry to add to the list of email domains that are used by the third-party phishing simulation. - -You can specify multiple values separated by commas. A maximum of 10 entries are allowed in the list. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddSenderIpRanges -The AddSenderIpRanges parameter specifies an existing entry to add to the list of source IP addresses that are used by the third-party phishing simulation. Valid values are: - -- Single IP address: For example, 192.168.1.1. -- IP address range: For example, 192.168.0.1-192.168.0.254. -- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. - -You can specify multiple values separated by commas. - -A maximum of 10 entries are allowed in the list. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSenderDomainIs -The RemoveSenderDomainIs parameter specifies an existing entry to remove from the list of email domains that are used by the third-party phishing simulation. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSenderIpRanges -The RemoveSenderIpRanges parameter specifies an existing entry to remove from the list of source IP addresses that are used by the third-party phishing simulation. Valid values are: - -- Single IP address: For example, 192.168.1.1. -- IP address range: For example, 192.168.0.1-192.168.0.254. -- Classless InterDomain Routing (CIDR) IP address range: For example, 192.168.0.1/25. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-Place.md b/exchange/exchange-ps/exchange/Set-Place.md index b462f6b49d..aeffd3882a 100644 --- a/exchange/exchange-ps/exchange/Set-Place.md +++ b/exchange/exchange-ps/exchange/Set-Place.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-place +online version: https://learn.microsoft.com/powershell/module/exchange/set-place applicable: Exchange Online title: Set-Place schema: 2.0.0 @@ -16,11 +16,11 @@ This cmdlet is available only in the cloud-based service. Use the Set-Place cmdlet to update room mailboxes with additional metadata, which provides a better search and room suggestion experience. -**Note**: In hybrid environments, this cmdlet doesn't work on the following properties on synchronized room mailboxes: City, CountryOrRegion, GeoCoordinates, Phone, PostalCode, State, and Street. To modify these properties on synchronized room mailboxes, use the Set-User or Set-Mailbox cmdlets in on-premises Exchange. +**Note**: In hybrid environments, this cmdlet doesn't work on the following properties on synchronized room mailboxes: City, CountryOrRegion, GeoCoordinates, Phone, PostalCode, State, or Street. To modify these properties (except GeoCoordinates on synchronized room mailboxes), use the Set-User or Set-Mailbox cmdlets in on-premises Exchange. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: We recommend using this cmdlet with the EXO V3 module. Commands using Set-Place to change certain combinations of properties together can fail in older versions of the module. For more information about the EXO V3 module, see [About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,6 +38,9 @@ Set-Place [-Identity] [-GeoCoordinates ] [-IsWheelChairAccessible ] [-Label ] + [-MTREnabled ] + [-ParentId ] + [-ParentType ] [-Phone ] [-PostalCode ] [-State ] @@ -49,13 +52,13 @@ Set-Place [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-Place -Identity "Conference Room 01" -IsWheelChairAccessible $true -AudioDeviceName PolyCom -VideoDeviceName "InFocus WXGA Projector" +Set-Place -Identity "Conference Room 01" -IsWheelChairAccessible $true -AudioDeviceName PolyCom -DisplayDeviceName "InFocus WXGA Projector" ``` The example adds the specified metadata to the room mailbox named Conference Room 01. @@ -159,10 +162,7 @@ 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`. -- 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. +This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter @@ -250,8 +250,10 @@ Accept wildcard characters: False ### -GeoCoordinates The GeoCoordinates parameter specifies the room's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats: -- Latitude and longitude: For example, "47,644125;-122,122411" -- Latitude, longitude, and altitude: For example, "47,644125;-122,122411;161,432" +- Latitude and longitude: For example, "47.644125;-122.122411" +- Latitude, longitude, and altitude: For example, "47.644125;-122.122411;161.432" + +**Note**: If period separators don't work for you, use commas instead. ```yaml Type: GeoCoordinates @@ -301,6 +303,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MTREnabled +**Note**: Currently, this parameter is informational only and results in no additional functionality. + +The MTREnabled parameter identifies the room as configured with a Microsoft Teams room system. You can add Teams room systems as audio sources in Teams meetings that involve the room. Valid values are: + +- $true: The room is has a Teams room system. You can add the Teams room system to Microsoft Teams meetings when selecting to join a meeting with room audio. +- $false: The room is does not have a Teams room system. Users will join Teams meetings using their PC or mobile device audio instead of using room audio. This is the default value. + +For more information about Microsoft Teams Rooms, see [Microsoft Teams Rooms](https://learn.microsoft.com/microsoftteams/rooms/). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentId +**Note**: This feature is experimental and is available only for organizations using Microsoft Places. + +The ParentId parameter specifies the ID of a Place in the parent location hierarchy in Microsoft Places. + +Organizations that are onboarding Rooms and Workspaces to Microsoft Places need to use the ParentId and ParentType parameters in a Set-Place command so Microsoft Places works properly. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParentType +**Note**: This feature is experimental and is available only for organizations using Microsoft Places. + +The ParentType parameter specifies the parent type of the ParentId in Microsoft Places. Valid values are: + +- Floor +- Section + +Organizations that are onboarding Rooms and Workspaces to Microsoft Places need to use the ParentId and ParentType parameters in a Set-Place command so Microsoft Places works properly. + +```yaml +Type: Microsoft.Exchange.Management.RecipientTasks.SetPlaceParentType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Phone The Phone parameter specifies the room's telephone number. @@ -422,12 +490,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-PolicyConfig.md b/exchange/exchange-ps/exchange/Set-PolicyConfig.md index 8f429888da..6455c497f6 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyConfig.md +++ b/exchange/exchange-ps/exchange/Set-PolicyConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-policyconfig -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-policyconfig +applicable: Security & Compliance title: Set-PolicyConfig schema: 2.0.0 author: chrisda @@ -12,35 +12,51 @@ ms.reviewer: # Set-PolicyConfig ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Set-PolicyConfig cmdlet to modify the endpoint restrictions that are configured in the organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-PolicyConfig +Set-PolicyConfig [[-Identity] ] + [-CaseHoldPolicyLimit ] [-ClassificationScheme ] [-ComplianceUrl ] [-Confirm] + [-DlpAppGroups ] + [-DlpAppGroupsPsws ] + [-DlpExtensionGroups ] + [-DlpNetworkShareGroups ] + [-DlpPrinterGroups ] + [-DlpRemovableMediaGroups ] [-DocumentIsUnsupportedSeverity ] + [-EnableAdvancedRuleBuilder ] [-EnableLabelCoauth ] [-EnableSpoAipMigration ] [-EndpointDlpGlobalSettings ] [-EndpointDlpGlobalSettingsPsws ] + [-ExtendTeamsDlpPoliciesToSharePointOneDrive ] + [-InformationBarrierMode ] + [-InformationBarrierPeopleSearchRestriction ] + [-IsDlpSimulationOptedIn ] [-OnPremisesWorkload ] [-ProcessingLimitExceededSeverity ] + [-PurviewLabelConsent ] + [-ReservedForFutureUse ] [-RetentionForwardCrawl ] [-RuleErrorAction ] [-SenderAddressLocation ] + [-SiteGroups ] + [-SiteGroupsPsws ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -53,6 +69,38 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as ## PARAMETERS +### -Identity +You don't need to use this parameter. The only endpoint restrictions object in the organization is named Settings. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -CaseHoldPolicyLimit +{{ Fill CaseHoldPolicyLimit Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClassificationScheme {{ Fill ClassificationScheme Description }} @@ -61,7 +109,7 @@ Type: ClassificationScheme Parameter Sets: (All) Aliases: Accepted values: Default, V0_AggregatedOnly, V1_DetailedResults -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -77,7 +125,7 @@ Accept wildcard characters: False Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -96,7 +144,103 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpAppGroups +{{ Fill DlpAppGroups Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpAppGroupsPsws +{{ Fill DlpAppGroupsPsws Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpExtensionGroups +{{ Fill DlpExtensionGroups Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpNetworkShareGroups +{{ Fill DlpNetworkShareGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpPrinterGroups +{{ Fill DlpPrinterGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DlpRemovableMediaGroups +{{ Fill DlpRemovableMediaGroups Description }} + +```yaml +Type: PswsHashtable +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -113,7 +257,23 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableAdvancedRuleBuilder +{{ Fill EnableAdvancedRuleBuilder Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -123,13 +283,23 @@ Accept wildcard characters: False ``` ### -EnableLabelCoauth -{{ Fill EnableLabelCoauth Description }} +The EnableLabelCoauth parameter enables or disables co-authoring support in Office desktop apps for the entire organization. Valid value are: + +- $true: Co-authoring support in Office desktop apps is enabled. When documents are labeled and encrypted by sensitivity labels, multiple users can edit these documents at the same time. Labeling information for unencrypted files is no longer saved in custom properties. Don't enable co-authoring if you use any apps, services, scripts, or tools that read or write labeling metadata to the old location. +- $false: Co-authoring support in Office desktop apps is disabled. + +Disabling co-authoring support in Office desktop apps in the organization has the following consequences: + +- For apps and services that support the new labeling metadata, they now revert to the original metadata format and location when labels are read or saved. +- The new metadata format and location for Office documents that was used while the setting was enabled will not be copied to the original format and location. As a result, this labeling information for unencrypted Word, Excel, and PowerPoint files will be lost. +- Co-authoring and AutoSave no longer work in your organization for labeled and encrypted documents. +- Sensitivity labels remain enabled for Office files in OneDrive and SharePoint. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -139,13 +309,16 @@ Accept wildcard characters: False ``` ### -EnableSpoAipMigration -{{ Fill EnableSpoAipMigration Description }} +The EnableSpoAipMigration parameter enables or disables built-in labeling for supported Office files in SharePoint and OneDrive. Valid values are: + +- $true: Users can apply your sensitivity labels in Office for the web. Users will see the Sensitivity button on the ribbon so they can apply labels, and see any applied label name on the status bar. +- $false: Users can't apply your sensitivity labels in Office for the web. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -155,7 +328,6 @@ Accept wildcard characters: False ``` ### -EndpointDlpGlobalSettings - The EndpointDlpGlobalSettings parameter specifies the global endpoints. This parameter uses the following syntax: `@(@{"Setting"=""; "Value"="}",@{"Setting"=""; "Value"=""},...)`. The value of `` is one of the supported values. @@ -178,7 +350,7 @@ Example values: Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -194,7 +366,26 @@ Accept wildcard characters: False Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendTeamsDlpPoliciesToSharePointOneDrive +The ExtendTeamsDlpPoliciesToSharePointOneDrive parameter enables the Teams DLP Policy to automatically extend protection to the content stored in OneDrive shared in 1:1 chats and content stored in SharePoint associated with Teams teams shared through channel chats. Valid values are: + +- $true +- $false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -203,6 +394,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InformationBarrierMode +The InformationBarrierMode parameter specifies the mode that controls the total number of segments and how many segments a user can be part of. Valid values are: + +- SingleSegment: Users in the organization can have 5000 segments but can only be assigned to one segment. +- MultiSegment: Users in the organization can have 5000 segments and can be assigned up to 10 segments. For more information, see [Use multi-segment support in information barriers](https://learn.microsoft.com/purview/information-barriers-multi-segment). + +```yaml +Type: InformationBarrierMode +Parameter Sets: (All) +Aliases: +Accepted values: SingleSegment, MultiSegment +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationBarrierPeopleSearchRestriction +{{ Fill InformationBarrierPeopleSearchRestriction Description }} + +```yaml +Type: InformationBarrierPeopleSearchRestriction +Parameter Sets: (All) +Aliases: +Accepted values: Enabled, Disabled +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsDlpSimulationOptedIn +{{ Fill IsDlpSimulationOptedIn Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OnPremisesWorkload {{ Fill OnPremisesWorkload Description }} @@ -211,7 +455,7 @@ Type: Workload Parameter Sets: (All) Aliases: Accepted values: None, Exchange, SharePoint, Intune, OneDriveForBusiness, PublicFolder, SharePointOnPremises, ExchangeOnPremises, AuditAlerting, Skype, ModernGroup, DynamicScope, Teams, UnifiedAuditAzure, EndpointDevices, ThirdPartyApps, OnPremisesScanner -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -228,7 +472,39 @@ Type: RuleSeverity Parameter Sets: (All) Aliases: Accepted values: Low, Medium, High, None, Informational, Information -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PurviewLabelConsent +{{ Fill PurviewLabelConsent Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReservedForFutureUse +{{ Fill ReservedForFutureUse Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -244,7 +520,7 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -264,7 +540,7 @@ Type: PolicyRuleErrorAction Parameter Sets: (All) Aliases: Accepted values: Ignore, RetryThenBlock -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -285,7 +561,39 @@ Type: PolicySenderAddressLocation Parameter Sets: (All) Aliases: Accepted values: Header, Envelope, HeaderOrEnvelope -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteGroups +{{ Fill SiteGroups Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SiteGroupsPsws +{{ Fill SiteGroupsPsws Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -295,13 +603,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -315,12 +623,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md b/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md index 909824262a..16cd681d3b 100644 --- a/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md +++ b/exchange/exchange-ps/exchange/Set-PolicyTipConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-policytipconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-policytipconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-PolicyTipConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-PolicyTipConfig cmdlet to modify custom Policy Tips in your organization. You can't modify built-in Policy Tips. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Set-PolicyTipConfig [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,7 +53,7 @@ This example replaces the text of all custom Spanish Policy Tips with the value, ### -Identity The Identity parameter specifies the custom Policy Tip you want to modify. You can use any value that uniquely identifies the custom Policy Tip. For example: -- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. +- `Locale\Action`: Locale is a supported locale code. For example, en for English or fr for French. For more information about supported locales, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). Action is one of the following Policy Tip actions: NotifyOnly, RejectOverride or Reject. - The value Url - GUID - Distinguished name (DN) @@ -145,12 +145,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-PopSettings.md b/exchange/exchange-ps/exchange/Set-PopSettings.md index d892070697..a6e5d017f8 100644 --- a/exchange/exchange-ps/exchange/Set-PopSettings.md +++ b/exchange/exchange-ps/exchange/Set-PopSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-popsettings +online version: https://learn.microsoft.com/powershell/module/exchange/set-popsettings applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-PopSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-PopSettings cmdlet to modify the configuration of the Microsoft Exchange POP3 service. This service exists on Exchange servers that have the Client Access server role installed, and is used by POP3 clients to connect to Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -56,7 +56,7 @@ Set-PopSettings [-AuthenticatedConnectionTimeout ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -345,8 +345,8 @@ Accept wildcard characters: False ### -LogFileRollOverSettings The LogFileRollOverSettings parameter defines how frequently POP3 protocol logging creates a new log file. Valid values are: -- 1 or Hourly. -- 2 or Daily. This is the default value. +- 1 or Hourly. This is the default value in Exchange 2019 and Exchange 2016. +- 2 or Daily. This is the default value in Exchange 2013 and Exchange 2010. - 3 or Weekly. - 4 or Monthly. @@ -722,12 +722,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md index 418348f5f4..16c3da7808 100644 --- a/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-PowerShellVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-powershellvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/set-powershellvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-PowerShellVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-PowerShellVirtualDirectory cmdlet to modify existing Windows PowerShell virtual directories that are used in Internet Information Services (IIS) on Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -26,6 +26,9 @@ Set-PowerShellVirtualDirectory [-Identity] [-CertificateAuthentication ] [-Confirm] [-DomainController ] + [-ExtendedProtectionFlags ] + [-ExtendedProtectionSPNList ] + [-ExtendedProtectionTokenChecking ] [-ExternalUrl ] [-InternalUrl ] [-RequireSSL ] @@ -37,7 +40,7 @@ Set-PowerShellVirtualDirectory [-Identity] ## DESCRIPTION Although it's possible to modify a Windows PowerShell virtual directory, we recommend that you only do so at the request of Microsoft Customer Service and Support. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -142,6 +145,69 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExtendedProtectionFlags +The ExtendedProtectionFlags parameter specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are: + +- None: This is the default setting. +- AllowDotlessSPN: Required if you want to use Service Principal Name (SPN) values that don't contain FQDNs (for example, HTTP/ContosoMail instead of HTTP/mail.contoso.com). You specify SPNs with the ExtendedProtectionSPNList parameter. This setting makes Extended Protection for Authentication less secure because dotless certificates aren't unique, so it isn't possible to ensure that the client-to-proxy connection was established over a secure channel. +- NoServiceNameCheck: The SPN list isn't checked to validate a channel binding token. This setting makes Extended Protection for Authentication less secure. We generally don't recommend this setting. +- Proxy: A proxy server is responsible for terminating the SSL channel. To use this setting, you need to register an SPN by using the ExtendedProtectionSPNList parameter. +- ProxyCoHosting: HTTP and HTTPS traffic may be accessing the virtual directory, and a proxy server is located between at least some of the clients and the Client Access services on the Exchange server. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionSPNList +The ExtendedProtectionSPNList parameter specifies a list of valid Service Principal Names (SPNs) if you're using Extended Protection for Authentication on the virtual directory. Valid values are: + +- $null: This is the default value. +- Single SPN or comma delimited list of valid SPNs: The SPN value format is `Protocol\FQDN`. For example, HTTP/mail.contoso.com. To add an SPN that's not an FQDN (for example, HTTP/ContosoMail), you also need to use the AllowDotlessSPN value for the ExtendedProtectionFlags parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedProtectionTokenChecking +The ExtendedProtectionTokenChecking parameter defines how you want to use Extended Protection for Authentication on the virtual directory. Extended Protection for Authentication isn't enabled by default. Valid values are: + +- None: Extended Protection for Authentication isn't be used on the virtual directory. This is the default value. +- Allow: Extended Protection for Authentication is used for connections between clients and the virtual directory if both the client and server support it. Connections that don't support Extended Protection for Authentication will work, but may not be as secure as connections that use Extended Protection for Authentication. +- Require: Extended Protection for Authentication is used for all connections between clients and the virtual directory. If either the client or server doesn't support it, the connection will fail. If you use this value, you also need to set an SPN value for the ExtendedProtectionSPNList parameter. + +**Note**: If you use the value Allow or Require, and you have a proxy server between the client and the Client Access services on the Mailbox server that's configured to terminate the client-to-proxy SSL channel, you also need to configure one or more Service Principal Names (SPNs) by using the ExtendedProtectionSPNList parameter. + +```yaml +Type: ExtendedProtectionTokenCheckingMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExternalUrl The ExternalURL parameter specifies the URL that's used to connect to the virtual directory from outside the firewall. @@ -230,12 +296,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md index f444f03b4a..c1875d6ea6 100644 --- a/exchange/exchange-ps/exchange/Set-ProtectionAlert.md +++ b/exchange/exchange-ps/exchange/Set-ProtectionAlert.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-protectionalert -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-protectionalert +applicable: Security & Compliance title: Set-ProtectionAlert schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Set-ProtectionAlert ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-ProtectionAlert cmdlet to modify alert policies in the Microsoft 365 compliance center. +Use the Set-ProtectionAlert cmdlet to modify alert policies in the Microsoft Purview compliance portal. **Note**: You can't use this cmdlet to edit default alert policies. You can only modify alerts that you created using the New-ProtectionAlert cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,6 +41,9 @@ Set-ProtectionAlert [-Identity] [-NotifyUserThrottleThreshold ] [-NotifyUserThrottleWindow ] [-Operation ] + [-PrivacyManagementScopedSensitiveInformationTypes ] + [-PrivacyManagementScopedSensitiveInformationTypesForCounting ] + [-PrivacyManagementScopedSensitiveInformationTypesThreshold ] [-Severity ] [-Threshold ] [-TimeWindow ] @@ -50,7 +53,7 @@ Set-ProtectionAlert [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -59,7 +62,7 @@ To use this cmdlet in Security & Compliance Center PowerShell, you need to be as Set-ProtectionAlert -Identity "Content search deleted" -Severity High ``` -This example sets the Severity of the detection to High. +This example sets the Severity of the detection to High for the specified alert policy. ### Example 2 ```powershell @@ -81,7 +84,7 @@ The Identity parameter specifies the alert policy that you want to modify. You c Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -101,7 +104,7 @@ The AggregationType parameter specifies the how the alert policy triggers alerts Type: AlertAggregationType Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -122,7 +125,7 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -138,7 +141,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -151,10 +154,13 @@ Accept wildcard characters: False The Category parameter specifies a category for the alert policy. Valid values are: - AccessGovernance +- ComplianceManager - DataGovernance -- DataLossPrevention -- ThreatManagement +- MailFlow - Others +- PrivacyManagement +- Supervision +- ThreatManagement When an activity occurs that matches the conditions of the alert policy, the alert that's generated is tagged with the category that's specified by this parameter. This allows you to track and manage alerts that have the same category setting @@ -162,7 +168,7 @@ When an activity occurs that matches the conditions of the alert policy, the ale Type: AlertRuleCategory Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -178,7 +184,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -197,7 +203,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -213,7 +219,7 @@ The Description parameter specifies descriptive text for the alert policy. If th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -232,7 +238,7 @@ The Disabled parameter enables or disables the alert policy. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -242,16 +248,16 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. +The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`. -- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. +- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property. -- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). -- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`). +- ComparisonOperator is an OPATH comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see [about_Comparison_Operators](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators). +- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values in quotation marks (for example, use `500`, `$true`, `$false`, or `$null` instead). You can chain multiple search criteria together using the `-and` logical operator (for example, `"Criteria1 -and Criteria2"`). -For detailed information about OPath filters in Exchange, see [Additional OPATH syntax information](https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). +For detailed information about OPATH filters in Exchange, see [Additional OPATH syntax information](https://learn.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information). The filterable properties are: @@ -302,7 +308,7 @@ You can specify multiple criteria by using the -and comparison operator. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -314,13 +320,13 @@ Accept wildcard characters: False ### -NotificationCulture The NotificationCulture parameter specifies the language or locale that's used for notifications. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -336,7 +342,7 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -352,7 +358,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -373,7 +379,7 @@ You can't use this parameter when the AggregationType parameter value is None (a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -385,13 +391,13 @@ Accept wildcard characters: False ### -NotifyUserSuppressionExpiryDate The NotifyUserSuppressionExpiryDate parameter specifies whether to temporarily suspend notifications for the alert policy. Until the specified date-time, no notifications are sent for detected activities. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -410,7 +416,7 @@ The NotifyUserThrottleThreshold parameter specifies the maximum number of notifi Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -429,7 +435,7 @@ The NotifyUserThrottleWindow parameter specifies the time interval in minutes th Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -439,7 +445,7 @@ Accept wildcard characters: False ``` ### -Operation -The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://docs.microsoft.com/microsoft-365/compliance/search-the-audit-log-in-security-and-compliance#audited-activities). +The Operation parameter specifies the activities that are monitored by the alert policy. For the list of available activities, see the Audited activities tab at [Audited activities](https://learn.microsoft.com/purview/audit-log-activities). Although this parameter is technically capable of accepting multiple values separated by commas, multiple values don't work. @@ -449,7 +455,55 @@ You can only use this parameter when the ThreatType parameter has the value Acti Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypes +{{ Fill PrivacyManagementScopedSensitiveInformationTypes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypesForCounting +{{ Fill PrivacyManagementScopedSensitiveInformationTypesForCounting Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivacyManagementScopedSensitiveInformationTypesThreshold +{{ Fill PrivacyManagementScopedSensitiveInformationTypesThreshold Description }} + +```yaml +Type: System.UInt64 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -469,7 +523,7 @@ The Severity parameter specifies the severity of the detection. Valid values are Type: RuleSeverity Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -487,7 +541,7 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -505,7 +559,7 @@ You can only use this parameter when the AggregationType parameter value is Simp Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -521,7 +575,7 @@ Accept wildcard characters: False Type: System.UInt64 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -531,13 +585,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -551,12 +605,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-PublicFolder.md b/exchange/exchange-ps/exchange/Set-PublicFolder.md index 7f18f841ec..d2f0376645 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Set-PublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-publicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfolder applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-PublicFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-PublicFolder cmdlet to set the attributes of public folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -51,7 +51,7 @@ Set-PublicFolder [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -150,7 +150,7 @@ Accept wildcard characters: False ``` ### -EformsLocaleId -The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +The EformsLocaleId parameter specifies the locale-specific version of the e-forms library. The valid input for the EformsLocaleId parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -166,7 +166,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -614,12 +616,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md b/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md index 1eb6a33e8f..85ad17feda 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md +++ b/exchange/exchange-ps/exchange/Set-PublicFolderDatabase.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-publicfolderdatabase +online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfolderdatabase applicable: Exchange Server 2010 title: Set-PublicFolderDatabase schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-PublicFolderDatabase cmdlet to set attributes of public folder databases. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -48,7 +48,7 @@ Set-PublicFolderDatabase [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -528,12 +528,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md b/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md index 9bab1fe317..7c4de5b3bf 100644 --- a/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Set-PublicFolderMigrationRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-publicfoldermigrationrequest +online version: https://learn.microsoft.com/powershell/module/exchange/set-publicfoldermigrationrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-PublicFolderMigrationRequest schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Set-PublicFolderMigrationRequest cmdlet to modify serial public folder m **Note**: Support for serial migration of public folders ended in Exchange 2013 Cumulative Update 8 (CU8), and the cmdlets are no longer available in Exchange Online. Instead, use the corresponding **\*-MigrationBatch** and **\*-PublicFolderMailboxMigration\*** cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -55,7 +55,7 @@ Set-PublicFolderMigrationRequest [-Identity] ## DESCRIPTION You can pipeline the Set-PublicFolderMoveRequest cmdlet from the Get-PublicFolderMoveRequestStatistics or Get-PublicFolderMoveRequest cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -176,8 +176,8 @@ The LargeItemLimit parameter specifies the maximum number of large items that ar For more information about maximum message size values, see the following topics: -- Exchange 2016: [Message size limits in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/message-size-limits) -- Exchange Online: [Exchange Online Limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) +- Exchange 2016: [Message size limits in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/message-size-limits) +- Exchange Online: [Exchange Online Limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits) Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. @@ -281,12 +281,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md b/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md new file mode 100644 index 0000000000..124bd14378 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-QuarantinePermissions.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepermissions +applicable: Exchange Online, Exchange Online Protection +title: Set-QuarantinePermissions +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-QuarantinePermissions + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +**Note**: Instead of using this cmdlet to set quarantine policy permissions, we recommend using the EndUserQuarantinePermissionsValue parameter on the New-QuarantinePolicy and Set-QuarantinePolicy cmdlets. + +Use the Set-QuarantinePermissions cmdlet to modify quarantine permissions objects that were created by the New-QuarantinePermissions and stored as a variable in the current PowerShell session. You use the variable as a value for the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets in the same PowerShell session. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-QuarantinePermissions -QuarantinePermissionsObject + [[-PermissionToAllowSender] ] + [[-PermissionToBlockSender] ] + [[-PermissionToDelete] ] + [[-PermissionToDownload] ] + [[-PermissionToPreview] ] + [[-PermissionToRelease] ] + [[-PermissionToRequestRelease] ] + [[-PermissionToViewHeader] ] + [] +``` + +## DESCRIPTION +To see the current value of the permissions object that you want to modify, run the variable name as a command. For example, run the command `$Perms` to see the quarantine policy permissions stored in the `$Perms` variable. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-QuarantinePermissions -QuarantinePermissionsObject $Perms -PermissionToRequestRelease $true -PermissionToRelease $false +``` + +This example modifies the quarantine policy permissions in the exiting `$Perms` variable that was previously created using the New-QuarantinePermissions cmdlet in the same PowerShell session (the `$Perms` variable is still available and populated). + +In the same PowerShell session, you can use `$Perms` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command. + +## PARAMETERS + +### -QuarantinePermissionsObject +The QuarantinePermissionsObject parameter specifies the existing variable that contains quarantine permissions that you want to modify. For example if you previously ran the command `$Perms = New-QuarantinePermissions `, use the value `$Perms` for this parameter. + +```yaml +Type: QuarantinePermissions +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 9 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToAllowSender +The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are: + +- $true: Allow sender is available for affected messages in quarantine. +- $false: Allow sender isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 1 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToBlockSender +The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are: + +- $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine. +- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToDelete +The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are: + +- $true: Delete messages and Delete from quarantine are available for affected messages in quarantine. +- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToDownload +The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are: + +- $true: The permission is enabled. +- $false: The permission is disabled. This is the default value. + +Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. End-users can't download quarantined messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToPreview +The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are: + +- $true: Preview message is available for affected messages in quarantine. +- $false: Preview message isn't available for affected messages in quarantine. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToRelease +The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are: + +- $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine. +- $false: Release message isn't available in quarantine notifications for affected messages, and Release and Release email aren't available for affected messages in quarantine. + +Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToRequestRelease +The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are: + +- $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine. +- $false: Request Release isn't available in quarantine notifications for affected messages, and Request release isn't available for affected messages in quarantine. + +Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PermissionToViewHeader +The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are: + +- $true: The permission is enabled. +- $false: The permission is disabled. This is the default value. + +Currently, this value has no effect on available actions in quarantine notifications or quarantine for affected messages. View message header is always available for affected messages in quarantine. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: 8 +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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md new file mode 100644 index 0000000000..796d65b9a1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-QuarantinePolicy.md @@ -0,0 +1,551 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-quarantinepolicy +applicable: Exchange Online, Exchange Online Protection +title: Set-QuarantinePolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-QuarantinePolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-QuarantinePolicy cmdlet to modify quarantine policies in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-QuarantinePolicy [-Identity] + [-AdminNotificationFrequencyInDays ] + [-AdminNotificationLanguage ] + [-AdminNotificationsEnabled ] + [-AdminQuarantinePermissionsList ] + [-Confirm] + [-CustomDisclaimer ] + [-DomainController ] + [-EndUserQuarantinePermissions ] + [-EndUserQuarantinePermissionsValue ] + [-EndUserSpamNotificationCustomFromAddress ] + [-EndUserSpamNotificationFrequency ] + [-EndUserSpamNotificationFrequencyInDays ] + [-EndUserSpamNotificationLanguage ] + [-EsnCustomSubject ] + [-ESNEnabled ] + [-IgnoreDehydratedFlag] + [-IncludeMessagesFromBlockedSenderAddress ] + [-MultiLanguageCustomDisclaimer ] + [-MultiLanguageSenderName ] + [-MultiLanguageSetting ] + [-OrganizationBrandingEnabled ] + [-QuarantineRetentionDays ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can't modify the built-in quarantine policies named AdminOnlyAccessPolicy, DefaultFullAccessPolicy, or DefaultFullAccessWithNotificationPolicy. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-QuarantinePolicy -Identity CustomAccess -EndUserQuarantinePermissionsValue 1 +``` + +This example configures the permissions in the quarantine policy named CustomAccess that allows users to delete quarantined messages only. + +### Example 2 +```powershell +Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy -MultiLanguageSetting ('English','ChineseSimplified','French') -MultiLanguageCustomDisclaimer ('For more information, contact the Help Desk.','有关更多信息，请联系服务台','Pour plus d''informations, contactez le service d''assistance.') -ESNCustomSubject ('You have quarantined messages','您有隔离邮件','Vous avez des messages en quarantaine') -MultiLanguageSenderName ('Contoso administrator','Contoso管理员','Administrateur Contoso') -EndUserSpamNotificationCustomFromAddress aashutosh@contso.onmicrosoft.com -OrganizationBrandingEnabled $true -EndUserSpamNotificationFrequency 04:00:00 +``` + +This example modifies the global settings for quarantine notifications (formerly known as end-user spam notification settings): + +- Quarantine notifications are customized for English, Chinese, and French. Extra quotation marks are required in the French MultiLanguageCustomDisclaimer value as escape characters for the quotation mark characters in the text. +- The existing user aashutosh@contso.onmicrosoft.com is used as the quarantine notification sender. +- The previously configured custom logo replaces the default Microsoft logo. +- The frequency of quarantine notifications is changed to 4 hours. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the quarantine policy you want to modify. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +```yaml +Type: QuarantineTagIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AdminNotificationFrequencyInDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationLanguage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection +Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminNotificationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminQuarantinePermissionsList +This parameter is reserved for internal Microsoft use. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserQuarantinePermissions +**Note**: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter. + +The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command. + +For example, run the following command to store the required permissions in a variable: `$Perms = New-QuarantinePermissions `. In the same PowerShell session, use the value `$Perms` for this parameter. + +```yaml +Type: QuarantinePermissions +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserQuarantinePermissionsValue +The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy. + +This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1): + +- PermissionToViewHeader: The value 0 doesn't hide the **View message header** action in quarantine. If the message is visible in quarantine, the action is always available for the message. +- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing). +- PermissionToAllowSender +- PermissionToBlockSender +- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0. +- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead. +- PermissionToPreview +- PermissionToDelete + +The values for the preset end-user permission groups are described in the following list: + +- No access: Binary = 0000000, so use the decimal value 0. +- Limited access: Binary = 00101011, so use the decimal value 43. +- Full access: Binary = 00100111, so use the decimal value 39. + +For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter. + +**Note**: If the value of this parameter is 0 (No access) and the value of the ESNEnabled parameter is $true, users can view their messages in quarantine, but the only available action for the messages is **View message header**. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationCustomFromAddress +The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications. To set this parameter back to the default email address quarantine@messaging.microsoft.com, use the value $null. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequency +The EndUserSpamNotificationFrequency parameter species how often quarantine notifications are sent to users. Valid values are: + +- 04:00:00 (4 hours) +- 1.00:00:00 (1 day) +- 7.00:00:00 (7 days) + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationFrequencyInDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndUserSpamNotificationLanguage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: EsnLanguage +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection +Accepted values: Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EsnCustomSubject +The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: MultiValuedProperty +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ESNEnabled +The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are: + +- $true: Quarantine notifications are enabled. +- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value. + +**Note**: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can view their messages in quarantine, but the only available action for the messages is **View message header**. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IgnoreDehydratedFlag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeMessagesFromBlockedSenderAddress +The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are: + +- $true: Recipients get quarantine notifications for affected messages from blocked senders. +- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageCustomDisclaimer +The MultiLanguageCustomDisclaimer parameter specifies the custom disclaimer text to use near the bottom of quarantine notifications. The localized text, **A disclaimer from your organization:** is always included first, followed by the text you specify for this parameter. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique custom disclaimer text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageSenderName +The MultiLanguageSenderName parameter specifies the email sender's display name to use in quarantine notifications. + +You can specify multiple values separated by commas using the syntax: `('value1',''value2',...'valueN')`. For each language that you specify with the MultiLanguageSetting parameter, you can specify a unique sender name. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. + +To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MultiLanguageSetting +The MultiLanguageSetting parameter specifies the language of quarantine notifications. Valid values are: + +Default, Amharic, Arabic, Basque, BengaliIndia, Bulgarian, Catalan, ChineseSimplified, ChineseTraditional, Croatian, Cyrillic, Czech, Danish, Dutch, English, Estonian, Filipino, Finnish, French, Galician, German, Greek, Gujarati, Hebrew, Hindi, Hungarian, Icelandic, Indonesian, Italian, Japanese, Kannada, Kazakh, Korean, Latvian, Lithuanian, Malay, Malayalam, Marathi, Norwegian, NorwegianNynorsk, Odia, Persian, Polish, Portuguese, PortuguesePortugal, Romanian, Russian, Serbian, SerbianCyrillic, Slovak, Slovenian, Spanish, Swahili, Swedish, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, and Vietnamese. + +You can specify multiple value separated by commas using the syntax: `('value1',''value2',...'valueN')`. The default value is Default, which means quarantine notifications use the default language of the cloud-based organization. + +For each language that you specify, you can specify a unique value for the MultiLanguageCustomDisclaimer and MultiLanguageSenderName parameters. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, and MultiLanguageSenderName parameter values in the same order. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +**Note**: The value English maps to every English language code except en-US. If you have users with en-US mailboxes only, use the value Default. If you have a mix of mailboxes with en-US and other English languages codes (en-GB, en-CA, en-AU, etc.), use the value Default in one customized quarantine notification, and the value English in another customized quarantine notification. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrganizationBrandingEnabled +The OrganizationBrandingEnabled parameter enables or disables organization branding in the end-user quarantine notification messages. Valid values are: + +- $true: Organization branding is enabled. The default Microsoft logo that's used in quarantine notifications is replaced by your custom logo. Before you do this, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your custom logo. +- $false: Organization branding is disabled. The default Microsoft logo is used in quarantine notifications. This is the default value. + +This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global settings. To access this quarantine policy, start your command with the following syntax: `Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ...`. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineRetentionDays +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-RMSTemplate.md b/exchange/exchange-ps/exchange/Set-RMSTemplate.md index f475921fc5..807ec202d5 100644 --- a/exchange/exchange-ps/exchange/Set-RMSTemplate.md +++ b/exchange/exchange-ps/exchange/Set-RMSTemplate.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-rmstemplate -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-rmstemplate +applicable: Exchange Online, Exchange Online Protection title: Set-RMSTemplate schema: 2.0.0 author: chrisda @@ -14,11 +14,12 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-RMSTemplate cmdlet to modify the properties of an existing Rights Management Services (RMS) template in your organization. +> [!NOTE] +> This cmdlet has been deprecated. If you use AD RMS with Exchange Online, you need to migrate to Azure Information Protection before you can use message encryption. For more information, see [Verify that Azure Rights Management is active](https://learn.microsoft.com/purview/set-up-new-message-encryption-capabilities#verify-that-azure-rights-management-is-active). -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Set-RMSTemplate cmdlet to modify the properties of an existing Active Directory Rights Management Services (AD RMS) template in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -55,7 +56,7 @@ You can use the Get-RMSTemplate cmdlet to view the RMS templates in your organiz Type: RmsTemplateIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -77,7 +78,7 @@ The default type for imported RMS templates is Archived. Type: RmsTemplateType Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: Named @@ -96,7 +97,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -112,7 +113,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -126,12 +127,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RMSTrustedPublishingDomain.md b/exchange/exchange-ps/exchange/Set-RMSTrustedPublishingDomain.md deleted file mode 100644 index 8ef80ae905..0000000000 --- a/exchange/exchange-ps/exchange/Set-RMSTrustedPublishingDomain.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-rmstrustedpublishingdomain -applicable: Exchange Online -title: Set-RMSTrustedPublishingDomain -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-RMSTrustedPublishingDomain - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-RMSTrustedPublishingDomain cmdlet to configure a trusted publishing domain (TPD) in your organization. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-RMSTrustedPublishingDomain [-Identity] - [-Confirm] - [-Default] - [-ExtranetCertificationUrl ] - [-ExtranetLicensingUrl ] - [-IntranetCertificationUrl ] - [-IntranetLicensingUrl ] - [-Name ] - [-WhatIf] - [] -``` - -## DESCRIPTION -A TPD contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. - -## EXAMPLES - -### Example 1 -```powershell -Set-RMSTrustedPublishingDomain "Contoso TPD" -Default -ExtranetLicensingUrl https://rms.contoso.com/_wmcs/licensing -ExtranetCertificationUrl https://rms.contoso.com/_wmcs/certification/servercertification.asmx -``` - -This example makes the following changes to the existing TPD Contoso TPD: - -- Sets Contoso TPD as the default TPD for the organization. -- Sets the external licensing URL to `https://rms.contoso.com/_wmcs/licensing`. -- Sets the external certification URL to `https://rms.contoso.com/_wmcs/certification/servercertification.asmx`. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the TPD. You can use any value that uniquely identifies the TPD, for example: - -- Name -- Distinguished name (DN) -- GUID - -```yaml -Type: RmsTrustedPublishingDomainIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -The Default parameter specifies this is the default TPD. The default TPD displays RMS templates and provides rights protection to all new content. There can be only one default TPD in an organization. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtranetCertificationUrl -The ExtranetCertificationUrl parameter specifies the external certification URL of the on-premises AD RMS server that's stamped into the Rights Account Certificate (RAC). The RAC establishes a user's identity in the AD RMS system and is used to decrypt content. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtranetLicensingUrl -The ExtranetLicensingUrl parameter specifies the external licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntranetCertificationUrl -The IntranetCertificationUrl parameter specifies the internal certification URL of the on-premises AD RMS server that's stamped into the RAC. The RAC establishes a user's identity in the AD RMS system and is used to decrypt content. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntranetLicensingUrl -The IntranetLicensingUrl parameter specifies the internal licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The Name parameter specifies the name of the TPD. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### -To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. - -## OUTPUTS - -### -To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md b/exchange/exchange-ps/exchange/Set-ReceiveConnector.md index 93e6f46539..0243479192 100644 --- a/exchange/exchange-ps/exchange/Set-ReceiveConnector.md +++ b/exchange/exchange-ps/exchange/Set-ReceiveConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-receiveconnector +online version: https://learn.microsoft.com/powershell/module/exchange/set-receiveconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ReceiveConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ReceiveConnector cmdlet to modify Receive connectors on Mailbox servers and Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -82,7 +82,7 @@ Set-ReceiveConnector [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -631,7 +631,7 @@ Accept wildcard characters: False ``` ### -MaxAcknowledgementDelay -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The MaxAcknowledgementDelay parameter specifies the period the transport server delays acknowledgement when receiving messages from a host that doesn't support shadow redundancy. When receiving messages from a host that doesn't support shadow redundancy, a Microsoft Exchange Server 2010 transport server delays issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server times out and issues an acknowledgement anyway. The default value is 30 seconds. @@ -956,7 +956,7 @@ The default permission groups that are assigned to a Receive connector depend on When you use the value Custom, you need to configure individual permissions by using the Add-ADPermission cmdlet. -For more information about the default permissions and security principals for permission groups, see [Receive connector permission groups](https://docs.microsoft.com/Exchange/mail-flow/connectors/receive-connectors#receive-connector-permission-groups). +For more information about the default permissions and security principals for permission groups, see [Receive connector permission groups](https://learn.microsoft.com/Exchange/mail-flow/connectors/receive-connectors#receive-connector-permission-groups). ```yaml Type: PermissionGroups @@ -998,7 +998,7 @@ The ProtocolLoggingLevel parameter specifies whether to enable or disable protoc - None: Protocol logging is disabled on the Receive connector. This is the default value. - Verbose: Protocol logging is enabled on the Receive connector. -For more information about protocol logging, see [Protocol logging](https://docs.microsoft.com/Exchange/mail-flow/connectors/protocol-logging). +For more information about protocol logging, see [Protocol logging](https://learn.microsoft.com/Exchange/mail-flow/connectors/protocol-logging). ```yaml Type: ProtocolLoggingLevel @@ -1324,12 +1324,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md b/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md index fcf053cde8..d1543894e3 100644 --- a/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md +++ b/exchange/exchange-ps/exchange/Set-RecipientFilterConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-recipientfilterconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-recipientfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-RecipientFilterConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-RecipientFilterConfig cmdlet to enable and configure the Recipient Filter agent. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Set-RecipientFilterConfig [-BlockedRecipients ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -211,12 +211,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md b/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md index 0c463aa61f..b3552f8231 100644 --- a/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md +++ b/exchange/exchange-ps/exchange/Set-RecordReviewNotificationTemplateConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-recordreviewnotificationtemplateconfig -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-recordreviewnotificationtemplateconfig +applicable: Security & Compliance title: Set-RecordReviewNotificationTemplateConfig schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-RecordReviewNotificationTemplateConfig cmdlet to set up the customized record review notification and reminder that's sent when an item requires review. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Set-RecordReviewNotificationTemplateConfig -IsCustomizedNotificationTemplate ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -48,7 +48,7 @@ $false: The option to mark content as a regulatory record is not visible in the Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -62,12 +62,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-RemoteDomain.md b/exchange/exchange-ps/exchange/Set-RemoteDomain.md index 465e7568e2..8f7c3965a5 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteDomain.md +++ b/exchange/exchange-ps/exchange/Set-RemoteDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-remotedomain +online version: https://learn.microsoft.com/powershell/module/exchange/set-remotedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-RemoteDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-RemoteDomain cmdlet to configure a managed connection for a remote domain. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,6 +43,7 @@ Set-RemoteDomain [-Identity] [-NonMimeCharacterSet ] [-PreferredInternetCodePageForShiftJis ] [-RequiredCharsetCoverage ] + [-SmtpDaneMandatoryModeEnabled ] [-TargetDeliveryDomain ] [-TNEFEnabled ] [-TrustedMailInboundEnabled ] @@ -55,7 +56,7 @@ Set-RemoteDomain [-Identity] ## DESCRIPTION When you set a remote domain, you can control mail flow with more precision, specify message formatting and policy and specify acceptable character sets for messages sent to or received from the remote domain. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -107,6 +108,11 @@ The AllowedOOFType parameter specifies the type of automatic replies or out-of-o - InternalLegacy: Only internal automatic replies or automatic replies that aren't designated as internal or external are sent to recipients in the remote domain. - None: No automatic replies are sent to recipients in the remote domain. +The value of this parameter is affected by the value of the IsInternal parameter, and vice-versa: + +- If you change the AllowedOOFType parameter to the value InternalLegacy, the IsInternal parameter is changed to the value $true. +- If you change the IsInternal parameter to the value $false, the AllowedOOFType parameter is changed to the value ExternalLegacy. + ```yaml Type: AllowedOOFType Parameter Sets: (All) @@ -328,9 +334,14 @@ Accept wildcard characters: False ### -IsInternal The IsInternal parameter specifies whether the recipients in the remote domain are considered to be internal recipients. Valid values are: -- $true: All transport components (for example, transport rules or antispam agents) treat recipients in the remote domain as internal recipients. Typically, you use this value in cross-forest deployments. +- $true: All transport components (for example, transport rules) treat recipients in the remote domain as internal recipients. Typically, you use this value in cross-forest deployments. - $false: Recipients in the remote domain are treated as external recipients. This is the default value. +The value of this parameter is affected by the value of the AllowedOOFType parameter, and vice-versa: + +- If you change the AllowedOOFType parameter to the value InternalLegacy, the IsInternal parameter is changed to the value $true. +- If you change the IsInternal parameter to the value $false, the AllowedOOFType parameter is changed to the value ExternalLegacy. + ```yaml Type: Boolean Parameter Sets: (All) @@ -416,7 +427,7 @@ Accept wildcard characters: False ``` ### -NDRDiagnosticInfoEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The NDRDiagnosticInfoEnabled parameter specifies whether diagnostic information is included in non-delivery reports (also known NDRs or bounce messages) that are sent to recipients the remote domain. Valid values are: @@ -439,8 +450,6 @@ Accept wildcard characters: False ``` ### -NDREnabled -This parameter is available or functional only in on-premises Exchange. - The NDREnabled parameter specifies whether to allow non-delivery reports (also known NDRs or bounce messages) from your organization to recipients in the remote domain. Valid values are: - $true: NDRs from your organization are sent to recipients in the remote domain. This is the default value. @@ -522,6 +531,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SmtpDaneMandatoryModeEnabled +This parameter is available only in the cloud-based service. + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetDeliveryDomain The TargetDeliveryDomain parameter specifies whether the remote domain is used in cross-forest deployments to generate target email addresses for new mail users that represent users in the other organization (for example, all mailboxes hosted on Exchange Online are represented as mail users in your on-premises organization). Valid values are: @@ -639,12 +666,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md index 6f4743b275..6850e91830 100644 --- a/exchange/exchange-ps/exchange/Set-RemoteMailbox.md +++ b/exchange/exchange-ps/exchange/Set-RemoteMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-remotemailbox +online version: https://learn.microsoft.com/powershell/module/exchange/set-remotemailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-RemoteMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-RemoteMailbox cmdlet to modify remote mailboxes. A remote mailbox is a mail user in Active Directory that's associated with a mailbox in the cloud-based service. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -92,7 +92,7 @@ Some attributes on mailboxes in the service can only be configured by connecting Directory synchronization must be configured correctly for changes made to an on-premises mail user to be applied to a mailbox in the service. Changing the configuration of the mailbox in the service isn't immediate and depends on the directory synchronization schedule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -239,7 +239,10 @@ Accept wildcard characters: False ``` ### -ACLableSyncedObjectEnabled -The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. To enable this, use this switch without a value. To disable this, use this exact syntax: -ACLableSyncedObjectEnabled:$false. +The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. + +- To enable this feature, use this switch without a value. +- To disable this feature, use this exact syntax: `-ACLableSyncedObjectEnabled:$false`. ```yaml Type: SwitchParameter @@ -255,15 +258,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. -When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address. +When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (`alias@domain`). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to `oe` in the primary email address. If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value: -- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk. +- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.onmicrosoft.com results in the Alias property value `helpdesk`. - Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?). If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient). @@ -300,7 +308,15 @@ Accept wildcard characters: False ``` ### -ArchiveName -The ArchiveName parameter specifies the name of the archive mailbox. Use this parameter to change the name of the archive. +The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in quotation marks ("). + +The following default values are used based on the version of Exchange: + +- Exchange 2016 or later: `In-Place Archive -` +- Exchange 2013: `In-Place Archive - ` +- Exchange 2010: `Personal Archive - ` + +In Outlook, the value of this parameter is ignored. The name of the archive mailbox that's shown in the folder list is `Online Archive - `. ```yaml Type: MultiValuedProperty @@ -638,16 +654,16 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. - X400: X.400 addresses in on-premises Exchange. - X500: X.500 addresses in on-premises Exchange. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -857,9 +873,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -1009,7 +1025,7 @@ Accept wildcard characters: False ### -PrimarySmtpAddress The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. -If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but that means the email addresses of the mail user no longer automatically updated by email address policies. +If you set the EmailAddressPolicyEnabled parameter to $false, you can specify the primary address using the PrimarySmtpAddress parameter, but the email addresses of the mail user are no longer automatically updated by email address policies. The PrimarySmtpAddress parameter updates the primary email address and WindowsEmailAddress property to the same value. @@ -1206,7 +1222,7 @@ Accept wildcard characters: False ``` ### -RemovePicture -The RemovePicture switch specifies whether to remove the picture from the mail user. You don't need to specify a value with this switch. +The RemovePicture switch removes the picture from the mail user. You don't need to specify a value with this switch. You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet. @@ -1224,7 +1240,7 @@ Accept wildcard characters: False ``` ### -RemoveSpokenName -The RemoveSpokenName switch specifies whether to remove the spoken name from the mail user. You don't need to specify a value with this switch. +The RemoveSpokenName switch removes the spoken name from the mail user. You don't need to specify a value with this switch. You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet. @@ -1332,7 +1348,7 @@ The Type parameter specifies the type for the mailbox in the service. Valid valu Notes on the value Shared: - Shared is available only in Exchange 2013 CU21 or later, Exchange 2016 CU10 or later, and Exchange 2019. In Exchange 2013 and Exchange 2016, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605). -- If you tried to convert a migrated remote mailbox to a shared remote mailbox, you would receive the following error: `remoteMailbox.RemoteRecipientType must include ProvisionMailbox`. This issue was fixed in Exchange 2016 CU14 and Exchange 2019 CU3, but not in Exchange 2013. For more information, see [KB4515271](https://support.microsoft.com/help/4515271). +- In hybrid environments, changing the mailbox type of a migrated mailbox needs to be done on both sides: Set-Mailbox in Exchange Online and Set-RemoteMailbox in on-premises Exchange. - If directory synchronization unexpectedly converts shared mailboxes in Exchange Online back into user mailboxes, or if you continue to receive the `remoteMailbox.RemoteRecipientType must include ProvisionMailbox` error when you use the value Shared, take the action described in Step 3 in the Resolution section in [KB2710029](https://support.microsoft.com/help/2710029). ```yaml @@ -1406,12 +1422,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md new file mode 100644 index 0000000000..9e9b525a46 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionPolicy.md @@ -0,0 +1,1107 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-reportsubmissionpolicy +applicable: Exchange Online +title: Set-ReportSubmissionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ReportSubmissionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ReportSubmissionPolicy cmdlet to modify the report submission policy in your cloud-based organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ReportSubmissionPolicy [-Identity] + [-Confirm] + [-DisableQuarantineReportingOption ] + [-DisableUserSubmissionOptions ] + [-EnableCustomizedMsg ] + [-EnableCustomNotificationSender ] + [-EnableOrganizationBranding ] + [-EnableReportToMicrosoft ] + [-EnableThirdPartyAddress ] + [-EnableUserEmailNotification ] + [-JunkReviewResultMessage ] + [-NotJunkReviewResultMessage ] + [-NotificationFooterMessage ] + [-NotificationSenderAddress ] + [-NotificationsForCleanSubmissionAirInvestigationsEnabled ] + [-NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled ] + [-NotificationsForSpamSubmissionAirInvestigationsEnabled ] + [-NotificationsForSubmissionAirInvestigationsEnabled ] + [-OnlyShowPhishingDisclaimer ] + [-PhishingReviewResultMessage ] + [-PostSubmitMessage ] + [-PostSubmitMessageEnabled ] + [-PostSubmitMessageForJunk ] + [-PostSubmitMessageForNotJunk ] + [-PostSubmitMessageForPhishing ] + [-PostSubmitMessageTitle ] + [-PostSubmitMessageTitleForJunk ] + [-PostSubmitMessageTitleForNotJunk ] + [-PostSubmitMessageTitleForPhishing ] + [-PreSubmitMessage ] + [-PreSubmitMessageEnabled ] + [-PreSubmitMessageForJunk ] + [-PreSubmitMessageForNotJunk ] + [-PreSubmitMessageForPhishing ] + [-PreSubmitMessageTitle ] + [-PreSubmitMessageTitleForJunk ] + [-PreSubmitMessageTitleForNotJunk ] + [-PreSubmitMessageTitleForPhishing ] + [-ReportChatMessageEnabled ] + [-ReportChatMessageToCustomizedAddressEnabled ] + [-ReportJunkAddresses ] + [-ReportJunkToCustomizedAddress ] + [-ReportNotJunkAddresses ] + [-ReportNotJunkToCustomizedAddress ] + [-ReportPhishAddresses ] + [-ReportPhishToCustomizedAddress ] + [-ThirdPartyReportAddresses ] + [-UserSubmissionOptions ] + [-UserSubmissionOptionsMessage ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The report submission policy controls most of the settings for user submissions in the Microsoft Defender portal at . + +The report submission rule (the SentTo parameter \*-ReportSubmissionRule cmdlets) controls the email address of the reporting mailbox where user reported messages are sent. + +When you set the email address of the reporting mailbox in the Microsoft Defender portal, the same email address is also set in the following parameters in the \*-ReportSubmissionPolicy cmdlets: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: The ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses parameters. +- Microsoft integrated reporting using third-party tools in Outlook: The ThirdPartyReportAddresses parameter. + +Although it's not absolutely required, it makes sense to keep the email address consistent in the related parameters in the \*-ReportSubmissionPolicy and \*-ReportSubmissionRule cmdlets. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $true -EnableThirdPartyAddress $false -ThirdPartyReportAddresses $null -ReportJunkToCustomizedAddress $false -ReportJunkAddresses $null -ReportNotJunkToCustomizedAddress $false -ReportNotJunkAddresses $null -ReportPhishToCustomizedAddress $false -ReportPhishAddresses $null + +Get-ReportSubmissionRule | Remove-ReportSubmissionRule +``` + +This example turns on reporting in Outlook, uses Microsoft reporting tools in Outlook, but allows users to report messages to Microsoft only. The reporting mailbox is not used. + +**Notes**: + +- You can use this example (and the other examples) without concern for the existing values of the specified parameters. Depending on your current configuration, some of the parameters might already be set to the required values and therefore might not be required. +- If the report submission rule doesn't already exist (the Get-ReportSubmissionRule command returns no output), you don't need to run the second command to remove it. + +### Example 2 +```powershell +$usersub = "reportedmessages@contoso.com" + +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $true -EnableThirdPartyAddress $false -ThirdPartyReportAddresses $null -ReportJunkToCustomizedAddress $true -ReportJunkAddresses $usersub -ReportNotJunkToCustomizedAddress $true -ReportNotJunkAddresses $usersub -ReportPhishToCustomizedAddress $true -ReportPhishAddresses $usersub + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example turns on reporting in Outlook, uses Microsoft reporting tools in Outlook, allows users to report messages to Microsoft, and sends reported messages to the specified reporting mailbox. + +The required third command is different based on whether you already have a report submission rule: + +- If you don't already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns nothing), run the New-ReportSubmissionRule command as described. +- If you already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns output), run the following command instead: `Set-ReportSubmissionRule -Name DefaultReportSubmissionRule -SentTo $usersub`. + +### Example 3 +```powershell +$usersub = "userreportedmessages@fabrikam.com" + +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddress $false -ThirdPartyReportAddresses $null -ReportJunkToCustomizedAddress $true -ReportJunkAddresses $usersub -ReportNotJunkToCustomizedAddress $true -ReportNotJunkAddresses $usersub -ReportPhishToCustomizedAddress $true -ReportPhishAddresses $usersub + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example turns on reporting in Outlook, uses Microsoft reporting tools in Outlook, and sends reported messages to the specified reporting mailbox only (users can't report messages to Microsoft). + +The required third command is different based on whether you already have a report submission rule: + +- If you don't already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns nothing), run the New-ReportSubmissionRule command as described. +- If you already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns output), run the following command instead: `Set-ReportSubmissionRule -Name DefaultReportSubmissionRule -SentTo $usersub`. + +### Example 4 +```powershell +$usersub = "thirdpartyreporting@wingtiptoys.com" + +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ThirdPartyReportAddresses $usersub -ReportJunkToCustomizedAddress $false -ReportJunkAddresses $null -ReportNotJunkToCustomizedAddress $false -ReportNotJunkAddresses $null -ReportPhishToCustomizedAddress $false -ReportPhishAddresses $null + +New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo $usersub +``` + +This example turns on reporting in Outlook, but uses third-party reporting tools in Outlook to send reported messages to the specified reporting mailbox in Exchange Online. + +The required third command is different based on whether you already have a report submission rule: + +- If you don't already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns nothing), run the New-ReportSubmissionRule command as described. +- If you already have a report submission rule (the Get-ReportSubmissionRule cmdlet returns output), run the following command instead: `Set-ReportSubmissionRule -Name DefaultReportSubmissionRule -SentTo $usersub`. + +### Example 5 +```powershell +Set-ReportSubmissionPolicy -Identity DefaultReportSubmissionPolicy -EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ThirdPartyReportAddresses $usersub -ReportJunkToCustomizedAddress $false -ReportJunkAddresses $null -ReportNotJunkToCustomizedAddress $false -ReportNotJunkAddresses $null -ReportPhishToCustomizedAddress $false -ReportPhishAddresses $null + +Get-ReportSubmissionRule | Remove-ReportSubmissionRule +``` + +This example turns off the Microsoft integrated reporting. Microsoft reporting tools in Outlook are not available to users and messages reported by third-party tools in Outlook are not available on the Submissions page in the Microsoft Defender portal. + +If the report submission rule doesn't already exist (the Get-ReportSubmissionRule command returns no output), you don't need to run the second command to remove it. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission policy that you want to modify. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +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. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableQuarantineReportingOption +The DisableQuarantineReportingOption parameter allows or prevents users from reporting messages in quarantine. Valid values are: + +- $true: Users can't report quarantined messages from quarantine. +- $false: Users can report quarantined messages from quarantine. This is the default value. + +This parameter is meaningful only reporting in Outlook is enabled as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableUserSubmissionOptions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomizedMsg +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableCustomNotificationSender +The EnableCustomNotificationSender parameter specifies whether a custom sender email address is used for result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Use a custom Microsoft 365 sender email address. +- $false: Use the default sender email address. This is the default value. + +You specify the sender email address using the NotificationSenderAddress parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableOrganizationBranding +The EnableOrganizationBranding parameter specifies whether to show the company logo in the footer of result messages that users receive after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Use the company logo in the footer text instead of the Microsoft logo. +- $false: Don't use the company logo in the footer text. Use the Microsoft logo. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableReportToMicrosoft +The EnableReportToMicrosoft parameter specifies whether Microsoft integrated reporting experience is enabled or disabled. Valid values are $true or $false. + +The value $true for this parameter enables reporting in Outlook. The following configurations are possible: + +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft only (the reporting mailbox isn't used)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. +- **Microsoft reporting tools are available in Outlook for users to report messages to Microsoft and reporting mailbox (reported messages are sent to the specified mailbox)**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. This is the default configuration. +- **Using a third party add-in in Outlook for users to report to Microsoft and reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. The EnableThirdPartyAddress parameter value is $true. To create the policy, use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. + +The value $false for this parameter disables reporting in Outlook. The following configurations are possible: + +- **Microsoft reporting tools are available in Outlook, but reported messages are sent only to the reporting mailbox**: The ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $true. To create the policy, use the same email address in the ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhisAddresses parameters, and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. +- **Reporting in Outlook is disabled. Microsoft reporting tools are not available in Outlook. Any messages reported by users in Outlook with third-party reporting tools aren't visible on the Submissions page in the Microsoft Defender portal**: The EnableThirdPartyAddress, ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameter values are $false. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableThirdPartyAddress +The EnableThirdPartyAddress parameter specifies whether you're using third-party reporting tools in Outlook instead of Microsoft tools to send messages to the reporting mailbox in Exchange Online. Valid values are $true or $false. + +The value $true enables Microsoft to capture information about email sent to the third-party reporting mailbox. The following configurations are possible: + +- **Reported messages are sent only to the reporting mailbox**: Microsoft pulls metadata from messages sent to the Exchange Online reporting mailbox by third-party tools. Microsoft uses the metadata to populate the submissions page in the Microsoft Defender Portal and fire alerts. You also need to set the EnableReportToMicrosoft parameter value to $false. Use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. +- **Reported messages are sent to both Microsoft and reporting mailbox**: Microsoft pulls the metadata and message content from messages sent to the Exchange Online reporting mailbox by third-party tools. Microsoft uses the metadata to populate the submissions page in the Microsoft Defender Portal and fire alerts. The email is used to generate result for the submissions. You also need to set the EnableReportToMicrosoft parameter value to $true. Use the same email address in the ThirdPartyReportAddresses parameter and also in the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlets. + +The value $false means third-party reporting tools in Outlook aren't used. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableUserEmailNotification +The EnableUserEmailNotification parameter species whether users receive result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. Valid values are: + +- $true: Customized admin review result messages are sent. This value is required when user reported messages go only to the reporting mailbox (the value of the EnableReportToMicrosoft parameter is $false). +- $false: Customized admin review result messages are not sent. + +Use the JunkReviewResultMessage, NotJunkReviewResultMessage, PhishingReviewResultMessage parameters to configure the message body text that's used for each verdict. + +Use the NotificationFooterMessage parameter for the footer that's used for all verdicts (junk, not junk, and phishing). + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JunkReviewResultMessage +The JunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as junk. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotJunkReviewResultMessage +The NotJunkReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as not junk. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationFooterMessage +The NotificationFooterMessage parameter specifies the custom footer text to use in email notifications after an admin reviews and marks the reported messages as junk, not junk, or phishing. If the value contains spaces, enclose the value in quotation marks. + +You can use the EnableOrganizationBranding parameter to include your company logo in the message footer. + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationSenderAddress +The NotificationSenderAddress parameter specifies the sender email address to use in result messages after an admin reviews and marks the reported messages as junk, not junk, or phishing. The email address must be in Exchange Online. + +This parameter is meaningful only when reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForCleanSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForPhishMalwareSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForSpamSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotificationsForSubmissionAirInvestigationsEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OnlyShowPhishingDisclaimer +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PhishingReviewResultMessage +The PhishingReviewResultMessage parameter specifies the custom text to use in result messages after an admin reviews and marks the reported messages as phishing. If the value contains spaces, enclose the value in quotation marks ("). + +This parameter is meaningful only when the value of the EnableUserEmailNotification parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +Use the NotificationFooterMessage parameter to customize the footer text of result messages. + +Use the NotificationSenderAddress parameter to customize the sender email address of result messages. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessage +The PostSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message title using the PostSubmitMessageTitle parameter. + +This parameter is meaningful only when the value of the PostSubmitMessageEnabled parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageEnabled +The PostSubmitMessageEnabled parameter enables or disables the pop-up Outlook notifications that users see after they report messages using Microsoft reporting tools. Valid values are: + +- $true: Users receive pop-up notifications in Outlook after they report messages. This is the default value. +- $false: Users don't receive pop-up notifications in Outlook after they report messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForJunk +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForNotJunk +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageForPhishing +Don't use this parameter. Use the PostSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitle +The PostSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications after users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message text using the PostSubmitMessage parameter. + +This parameter is meaningful only when the value of the PostSubmitMessageEnabled parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForJunk +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForNotJunk +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PostSubmitMessageTitleForPhishing +Don't use this parameter. Use the PostSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessage +The PreSubmitMessage parameter specifies the custom pop-up message text to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the custom pop-up message title using the PreSubmitMessageTitle parameter. + +This parameter is meaningful only when the value of the PreSubmitMessageEnabled parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageEnabled +The PreSubmitMessageEnabled parameter enables or disables the pop-up Outlook notifications that users see before they report messages using Microsoft reporting tools. Valid values are: + +- $true: Users receive pop-up notifications in Outlook before they report messages. This is the default value. +- $false: Users don't receive pop-up notifications in Outlook before they report messages. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForJunk +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForNotJunk +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageForPhishing +Don't use this parameter. Use the PreSubmitMessage parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitle +The PreSubmitMessage parameter parameter specifies the custom pop-up message title to use in Outlook notifications before users report messages. If the value contains spaces, enclose the value in quotation marks ("). + +You specify the pop-up message text using the PreSubmitMessage parameter. + +This parameter is meaningful only when the value of the PreSubmitMessageEnabled parameter is $true and reporting in Outlook is enabled for Microsoft reporting tools in Outlook as described in the EnableReportToMicrosoft parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForJunk +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForNotJunk +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreSubmitMessageTitleForPhishing +Don't use this parameter. Use the PreSubmitMessageTitle parameter instead. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageEnabled +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportChatMessageToCustomizedAddressEnabled +{{ Fill ReportChatMessageToCustomizedAddressEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkAddresses +**Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. + +The ReportJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +If you change the ReportJunkToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportJunkToCustomizedAddress +The ReportJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters in the same command. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportNotJunkAddresses +**Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. + +The ReportNotJunkAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +If you change the ReportNotJunkToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportNotJunkToCustomizedAddress +The ReportNotJunkToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPhishAddresses +**Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. + +The ReportPhishAddresses parameter specifies the email address of the reporting mailbox in Exchange Online to receive user reported messages in reporting in Outlook using Microsoft or third-party reporting tools in Outlook. + +If you change the ReportPhishToCustomizedAddress parameter value to $false, you should set the value $null (blank) for this parameter. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkAddresses, ReportNotJunkAddresses and ReportPhishAddresses parameters. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportPhishToCustomizedAddress +The ReportPhishToCustomizedAddress parameter specifies whether to send user reported messages from Outlook (using Microsoft or third-party reporting tools) to the reporting mailbox as part of reporting in Outlook. Valid values are: + +- $true: User reported messages are sent to the reporting mailbox. +- $false: User reported messages are not sent to the reporting mailbox. + +You can't use this parameter by itself. You need to specify the same value for the ReportJunkToCustomizedAddress, ReportNotJunkToCustomizedAddress, and ReportPhishToCustomizedAddress parameters. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThirdPartyReportAddresses +**Note**: You aren't absolutely required to use this parameter. You specify the email address of the reporting mailbox using the SentTo parameter on the New-ReportSubmissionRule or Set-ReportSubmissionRule cmdlet. To reduce confusion, set this parameter to the same value. + +Use the ThirdPartyReportAddresses parameter to specify the email address of the reporting mailbox when you're using a third-party product for user submissions instead of reporting in Outlook. + +If you change the EnableThirdPartyAddress parameter value to $false, you should set the value $null (blank) for this parameter. + +For more information about using third-party reporting tools with or without reporting in Outlook in favor of a third-party product, see the EnableThirdPartyAddress parameter. + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSubmissionOptions +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSubmissionOptionsMessage +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md b/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md new file mode 100644 index 0000000000..88878ff4a1 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-ReportSubmissionRule.md @@ -0,0 +1,193 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-reportsubmissionrule +applicable: Exchange Online +title: Set-ReportSubmissionRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-ReportSubmissionRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-ReportSubmissionRule cmdlet to modify the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-ReportSubmissionRule [-Identity] + [-Comments ] + [-Confirm] + [-Name ] + [-ReportSubmissionPolicy ] + [-SentTo ] + [-WhatIf] + [] +``` + +## DESCRIPTION +The SentTo parameter identifies the email address of the reporting mailbox. + +If you set the email address of the reporting mailbox in the Microsoft Defender portal at , the same email address is also set in the *\-ReportSubmissionPolicy cmdlets: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). +- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. + +When you use this cmdlet to set the email address of the reporting mailbox, the corresponding parameters in the *\-ReportSubmissionPolicy cmdlets are not updated. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ReportSubmissionRule -Identity DefaultReportSubmissionRule -SentTo "userreportedmessages@contoso.onmicrosoft.com" +``` + +This example changes the reporting mailbox to userreportedmessages@contoso.onmicrosoft.com. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the report submission rule that you want to modify. The default rule is named DefaultReportSubmissionRule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportSubmissionPolicy +The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy. + +```yaml +Type: ReportSubmissionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent. + +The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the \*-ReportSubmissionPolicy cmdlets (either of the following scenarios): + +- Microsoft integrated reporting is enabled using Microsoft reporting tools in Outlook: `-EnableThirdPartyAddress $false -ReportJunkToCustomizedAddress $true -ReportNotJunkToCustomizedAddress $true -ReportPhishToCustomizedAddress $true`. +- Microsoft integrated reporting is enabled using third-party reporting tools in Outlook: `-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false`. + +If you set the email address of the reporting mailbox in the Microsoft Defender portal, the following parameters in the *\-ReportSubmissionPolicy cmdlets are set to the same value: + +- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value). +- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses. + +When you use this cmdlet to set the email address of the reporting mailbox, the related parameter values in the *\-ReportSubmissionPolicy cmdlets are not updated, which doesn't affect the functionality of the reporting mailbox. You should update the related values in the \*-ReportSubmissionPolicy cmdlets for consistency and to avoid confusion. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-ResourceConfig.md b/exchange/exchange-ps/exchange/Set-ResourceConfig.md index e2db5a6340..19453e4a45 100644 --- a/exchange/exchange-ps/exchange/Set-ResourceConfig.md +++ b/exchange/exchange-ps/exchange/Set-ResourceConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-resourceconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-resourceconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-ResourceConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-ResourceConfig cmdlet to create custom resource properties that you can add to room and equipment mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Set-ResourceConfig [-Confirm] ## DESCRIPTION After you use this cmdlet to create custom resource properties, you use the ResourceCustom parameter on the Set-Mailbox cmdlet to add one or more of those properties to a room or equipment mailbox. For more information, see the ResourceCustom parameter description in Set-Mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,8 +44,7 @@ This example adds the custom resource properties Room/Whiteboard and Equipment/V ### Example 2 ```powershell -Set-ResourceConfig -ResourcePropertySchema @{Add="Room/TV" -Remove="Equipment/Laptop"} +Set-ResourceConfig -ResourcePropertySchema @{Add="Room/TV"; Remove="Equipment/Laptop"} ``` This example adds the custom resource property Room/TV and removes Equipment/Laptop without affecting other custom resource properties that are already configured. @@ -130,12 +129,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ResubmitRequest.md b/exchange/exchange-ps/exchange/Set-ResubmitRequest.md index a7f806d144..222f007a7c 100644 --- a/exchange/exchange-ps/exchange/Set-ResubmitRequest.md +++ b/exchange/exchange-ps/exchange/Set-ResubmitRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-resubmitrequest +online version: https://learn.microsoft.com/powershell/module/exchange/set-resubmitrequest applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ResubmitRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ResubmitRequest cmdlet to enable or disable requests to replay redundant copies of messages from Safety Net after a mailbox database recovery. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Set-ResubmitRequest [-Identity] -Enabled - [-RetryDistribution] - [-Confirm] - [-WhatIf] - [] -``` - ### Identity ``` Set-RetentionCompliancePolicy [-Identity] @@ -48,8 +39,13 @@ Set-RetentionCompliancePolicy [-Identity] [-Applications ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] + [-PolicyTemplateInfo ] + [-PolicyRBACScopes ] + [-PriorityCleanup] [-RemoveExchangeLocation ] [-RemoveExchangeLocationException ] [-RemoveModernGroupLocation ] @@ -62,6 +58,36 @@ Set-RetentionCompliancePolicy [-Identity] [-RemoveSkypeLocation ] [-RemoveSkypeLocationException ] [-RestrictiveRetention ] + [-StartSimulation ] + [-WhatIf] + [] +``` + +### AdaptiveScopeLocation +``` +Set-RetentionCompliancePolicy [-Identity] [-AddAdaptiveScopeLocation ] + [-Applications ] + [-Comment ] + [-Confirm] + [-DeletedResources ] + [-Enabled ] + [-EnforceSimulationPolicy ] + [-Force] + [-PriorityCleanup] + [-RemoveAdaptiveScopeLocation ] + [-StartSimulation ] + [-WhatIf] + [] +``` + +### RetryDistribution +``` +Set-RetentionCompliancePolicy [-Identity] [-RetryDistribution] + [-Confirm] + [-DeletedResources ] + [-EnforceSimulationPolicy ] + [-PriorityCleanup] + [-StartSimulation ] [-WhatIf] [] ``` @@ -75,18 +101,24 @@ Set-RetentionCompliancePolicy [-Identity] [-AddTeamsChatLocationException ] [-Comment ] [-Confirm] + [-DeletedResources ] [-Enabled ] + [-EnforceSimulationPolicy ] [-Force] + [-PriorityCleanup] [-RemoveTeamsChannelLocation ] [-RemoveTeamsChannelLocationException ] [-RemoveTeamsChatLocation ] [-RemoveTeamsChatLocationException ] + [-StartSimulation ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). + +**Note**: Don't use a piped Foreach-Object command when adding or removing scope locations: `"Value1","Value2",..."ValueN" | Foreach-Object {Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -RemoveExchangeLocation $_}`. ## EXAMPLES @@ -98,10 +130,97 @@ Set-RetentionCompliancePolicy -Identity "Regulation 123 Compliance" -AddExchange This example makes the following changes to the existing retention policy named "Regulation 123 Compliance": - Adds the mailbox for the user named Kitty Petersen. -- Adds the SharePoint Online site `https://contoso.sharepoint.com/sites/teams/finance`. +- Adds the SharePoint site `https://contoso.sharepoint.com/sites/teams/finance`. - Removes public folders. - Updates the comment. +### Example 2 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'USSales@contoso.onmicrosoft.com', + 'SiteId': '9b2a8116-b9ec-4e2c-bf31-7eaa83697c4b' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocation "USSales@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +The example removes the specified deleted Microsoft 365 Group and site from the specified policy. You identify the deleted resources using the Microsoft 365 Group email address and the related site ID. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +### Example 3 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'USSales@contoso.onmicrosoft.com', + 'SiteId': '8b2a8345-b9ec-3b6a-bf31-6eaa83697c4b' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Tenant Level Policy" -AddModernGroupLocationException "USSales@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +The example excludes the specified deleted Microsoft 365 Group and site from the specified tenant level policy. You identify the deleted resources using the Microsoft 365 Group email address and the related site ID. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +### Example 4 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'USSales2@contoso.onmicrosoft.com', + 'SiteId': '9b2a8116-b9ec-4e2c-bf31-7eaa83697c4b' + }, +{ + 'EmailAddress': 'USSales2@contoso.onmicrosoft.com', + 'SiteId': '4afb7116-b9ec-4b2c-bf31-4abb83697c4b' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Sales Policy" -RemoveModernGroupLocation "USSales2@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +This example is similar to Example 2, except multiple deleted resources are specified. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +### Example 5 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'SalesUser@contoso.onmicrosoft.com' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "SalesUser@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +This example excludes the specified soft-deleted mailbox or mail user from the mentioned Teams Retention Policy. You can identify the deleted resources using the mailbox or mail user's email address. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +### Example 6 +```powershell +$stringJson = @" +[{ + 'EmailAddress': 'SalesUser1@contoso.onmicrosoft.com' +}, +{ + 'EmailAddress': 'SalesUser2@contoso.onmicrosoft.com' +}] +"@ + +Set-RetentionCompliancePolicy -Identity "Teams Chat Retention Policy" -AddTeamsChatLocationException "SalesUser1@contoso.onmicrosoft.com", "SalesUser2@contoso.onmicrosoft.com" -DeletedResources $stringJson +``` + +This example is similar to Example 5, except multiple deleted resources are specified. + +**IMPORTANT**: Before you run this command, make sure you read the Caution information for the [DeletedResources parameter](#-deletedresources) about duplicate SMTP addresses. + +Policy exclusions must remain within the supported limits for retention policies: [Limits for Microsoft 365 retention policies and retention label policies](https://learn.microsoft.com/purview/retention-limits#maximum-number-of-items-per-policy) + ## PARAMETERS ### -Identity @@ -115,7 +234,7 @@ The Identity parameter specifies the retention policy that you want to modify. Y Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -125,13 +244,15 @@ Accept wildcard characters: False ``` ### -RetryDistribution -The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint Online locations. Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. +The RetryDistribution switch specifies whether to redistribute the policy to all Exchange Online and SharePoint locations. You don't need to specify a value with this switch. + +Locations whose initial distributions succeeded aren't included in the retry. Policy distribution errors are reported when you use this switch. ```yaml Type: SwitchParameter Parameter Sets: RetryDistribution Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -140,6 +261,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AddAdaptiveScopeLocation +The AddAdaptiveScopeLocation parameter specifies the adaptive scope location to add to the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AddExchangeLocation The AddExchangeLocation parameter specifies the mailboxes to add to the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: @@ -159,7 +302,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -187,7 +330,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -212,7 +355,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -237,7 +380,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -247,7 +390,7 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocation -The AddOneDriveLocation parameter specifies the OneDrive for Business sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. +The AddOneDriveLocation parameter specifies the OneDrive sites to add to the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -255,7 +398,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -265,7 +408,7 @@ Accept wildcard characters: False ``` ### -AddOneDriveLocationException -This parameter specifies the OneDrive for Business sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. +This parameter specifies the OneDrive sites to add to the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -273,7 +416,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -289,7 +432,7 @@ The AddPublicFolderLocation parameter specifies that you want to add all public Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -299,17 +442,17 @@ Accept wildcard characters: False ``` ### -AddSharePointLocation -The AddSharePointLocation parameter specifies the SharePoint Online sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The AddSharePointLocation parameter specifies the SharePoint sites to add to the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -SharePoint Online sites can't be added to the policy until they have been indexed. +SharePoint sites can't be added to the policy until they have been indexed. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -319,7 +462,7 @@ Accept wildcard characters: False ``` ### -AddSharePointLocationException -This parameter specifies the SharePoint Online sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +This parameter specifies the SharePoint sites to add to the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -327,7 +470,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -352,7 +495,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -368,7 +511,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -392,7 +535,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -414,7 +557,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -439,7 +582,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -461,7 +604,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -475,14 +618,14 @@ The Applications parameter specifies the target when Microsoft 365 Groups are in - `Group:Exchange` for the mailbox that's connected to the Microsoft 365 Group. - `Group:SharePoint` for the SharePoint site that's connected to the Microsoft 365 Group. -- `"Group:Exchange","Group:SharePoint"` for both the mailbox and the SharePoint site that are connected to the Microsoft 365 Group. -- blank (`$null`): This is the default value, and is functionally equivalent to the value `"Group:Exchange","Group:SharePoint"`. +- `"Group:Exchange,SharePoint"` for both the mailbox and the SharePoint site that are connected to the Microsoft 365 Group. +- blank (`$null`): This is the default value, and is functionally equivalent to the value `"Group:Exchange,SharePoint"`. To return to the default value of both the mailbox and SharePoint site for the selected Microsoft 365 groups, specify `"Group:Exchange,SharePoint"`. ```yaml Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -498,7 +641,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -517,7 +660,33 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeletedResources +The DeletedResources parameter specifies the deleted Microsoft 365 Group, mailbox, or mail user to be removed or added as an exclusion to the respective location list. Use this parameter with the AddModernGroupLocationException and RemoveModernGroupLocation parameters for deleted Microsoft 365 Groups, or with the AddTeamsChatLocationException parameter for deleted mailboxes or mail users. + +A valid value is a JSON string. Refer to the Examples section for syntax and usage examples of this parameter. + +**CAUTION**: When you use a SMTP address with this parameter, be aware that the same address might also be in use for other mailboxes or mail users. To check for additional mailboxes or mail users with the same SMTP address, use the following command and replace `user@contoso.com` with the SMTP address to check: `Get-Recipient -IncludeSoftDeletedRecipients user@contoso.com | Select-Object DisplayName, EmailAddresses, Description, Alias, RecipientTypeDetails, WhenSoftDeleted` + +To prevent active mailboxes or mail users with the same SMTP address from being excluded, put the mailbox on [Litigation Hold](https://learn.microsoft.com/purview/ediscovery-create-a-litigation-hold) before you run the command with the DeletedResources parameter. + +For more information about the deleted Microsoft 365 Group scenario, see [Learn more about modern group deletion under retention hold](https://learn.microsoft.com/purview/retention-settings#what-happens-if-a-microsoft-365-group-is-deleted-after-a-policy-is-applied). + +For more information about the inactive mailbox scenario, see [Learn about inactive mailboxes](https://learn.microsoft.com/purview/inactive-mailboxes-in-office-365). + +```yaml +Type: String +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -536,7 +705,28 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforceSimulationPolicy +The EnforceSimulationPolicy parameter specifies whether to enforce a simulation policy as an active policy. Valid values are: + +- $true: Enforce the simulation policy as an active policy. +- $false: Don't enforce the simulation policy as an active policy. This is the default value. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -546,13 +736,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Identity, TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -561,13 +753,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoveExchangeLocation -The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. Valid values are: +### -PolicyRBACScopes +**Note**: Admin units aren't currently supported, so this parameter isn't functional. The information presented here is for informational purposes when support for admin units is released. -- A mailbox -- A distribution group or mail-enabled security group +The PolicyRBACScopes parameter specifies the administrative units to assign to the policy. A valid value is the Microsoft Entra ObjectID (GUID value) of the administrative unit. You can specify multiple values separated by commas. -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: +Administrative units are available only in Microsoft Entra ID P1 or P2. You create and manage administrative units in Microsoft Graph PowerShell. + +```yaml +Type: MultiValuedProperty +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplateInfo +This parameter is reserved for internal Microsoft use. + +```yaml +Type: PswsHashtable +Parameter Sets: Identity +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAdaptiveScopeLocation +The RemoveAdaptiveScopeLocation parameter specifies the adaptive scope location to remove from the policy. You create adaptive scopes by using the New-AdaptiveScope cmdlet. You can use any value that uniquely identifies the adaptive scope. For example: + +- Name +- Distinguished name (DN) +- GUID + +You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. + +```yaml +Type: MultiValuedProperty +Parameter Sets: AdaptiveScopeLocation +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveExchangeLocation +The RemoveExchangeLocation parameter specifies the mailboxes to remove from the list of included mailboxes when you aren't using the value All for the ExchangeLocation parameter. + +You can use any value that uniquely identifies the mailbox. For example: - Name - Distinguished name (DN) @@ -580,7 +843,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -590,12 +853,9 @@ Accept wildcard characters: False ``` ### -RemoveExchangeLocationException -This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. Valid values are: - -- A mailbox -- A distribution group or mail-enabled security group +The RemoveExchangeLocationException parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter. -To specify a mailbox or distribution group, you can use any value that uniquely identifies it. For example: +You can use any value that uniquely identifies the mailbox. For example: - Name - Distinguished name (DN) @@ -608,7 +868,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -633,7 +893,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -658,7 +918,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -668,7 +928,7 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocation -The RemoveOneDriveLocation parameter specifies the OneDrive for Business sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. +The RemoveOneDriveLocation parameter specifies the OneDrive sites to remove from the list of included sites when you aren't using the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -676,7 +936,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -686,7 +946,7 @@ Accept wildcard characters: False ``` ### -RemoveOneDriveLocationException -This parameter specifies the OneDrive for Business sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. +This parameter specifies the OneDrive sites to remove from the list of excluded sites when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -694,7 +954,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -710,7 +970,7 @@ The RemovePublicFolderLocation parameter specifies that you want to remove all p Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -720,7 +980,7 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocation -The RemoveSharePointLocation parameter specifies the SharePoint Online sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. +The RemoveSharePointLocation parameter specifies the SharePoint sites to remove from the list of included sites when you aren't using the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -728,7 +988,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -738,7 +998,7 @@ Accept wildcard characters: False ``` ### -RemoveSharePointLocationException -This parameter specifies the SharePoint Online sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. +This parameter specifies the SharePoint sites to remove from the list of excluded sites when you use the value All for the SharePointLocation parameter. You identify the site by its URL value. You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -746,7 +1006,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -771,7 +1031,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -787,7 +1047,7 @@ This parameter is reserved for internal Microsoft use. Type: MultiValuedProperty Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -810,7 +1070,7 @@ Therefore, before you lock a policy for retention, it's critical that you unders Type: Boolean Parameter Sets: Identity Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -834,7 +1094,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -856,7 +1116,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -881,7 +1141,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -903,7 +1163,28 @@ You can enter multiple values separated by commas. If the values contain spaces Type: MultiValuedProperty Parameter Sets: TeamLocation Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartSimulation +The StartSimulation parameter specifies whether to start the simulation for a policy that was created in simulation mode. Valid values are: + +- $true: Start the simulation. +- $false: Don't start the simulation. This is the default value. + +For more information about simulation mode, see [Learn about simulation mode](https://learn.microsoft.com/purview/apply-retention-labels-automatically#learn-about-simulation-mo). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -913,13 +1194,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -933,12 +1214,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md index 2a0c2ef2f2..3a544e128a 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md +++ b/exchange/exchange-ps/exchange/Set-RetentionComplianceRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-retentioncompliancerule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-retentioncompliancerule +applicable: Security & Compliance title: Set-RetentionComplianceRule schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-RetentionComplianceRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-RetentionComplianceRule cmdlet to modify existing retention rules in the Microsoft 365 compliance center. +Use the Set-RetentionComplianceRule cmdlet to modify existing retention rules in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,6 +31,8 @@ Set-RetentionComplianceRule [-Identity] [-ContentMatchQuery ] [-ExcludedItemClasses ] [-ExpirationDateOption ] + [-IRMRiskyUserProfiles ] + [-PriorityCleanup] [-RetentionComplianceAction ] [-RetentionDuration ] [-RetentionDurationDisplayHint ] @@ -39,13 +41,13 @@ Set-RetentionComplianceRule [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-RetentionComplianceRule -Identity "Internal Company Rule" -RetentionDuration 180 RetentionDurationDisplayHint Days +Set-RetentionComplianceRule -Identity "Internal Company Rule" -RetentionDuration 180 -RetentionDurationDisplayHint Days ``` This example changes the hold duration for the existing retention rule named "Internal Company Rule". @@ -63,7 +65,7 @@ The Identity parameter specifies the retention rule that you want to modify. You Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -85,7 +87,7 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -101,7 +103,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -120,7 +122,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -134,7 +136,7 @@ The ContentContainsSensitiveInformation parameter specifies a condition for the This parameter uses the basic syntax `@(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)`. For example, `@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})`. -Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://docs.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). +Use the Get-DLPSensitiveInformationType cmdlet to list the sensitive information types for your organization. For more information on sensitive information types, see [What the sensitive information types in Exchange look for](https://learn.microsoft.com/exchange/what-the-sensitive-information-types-in-exchange-look-for-exchange-online-help). You can't use this parameter for Teams retention rules. @@ -142,7 +144,7 @@ You can't use this parameter for Teams retention rules. Type: PswsHashtable[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -154,13 +156,13 @@ Accept wildcard characters: False ### -ContentDateFrom The ContentDateFrom parameter specifies the start date of the date range for content to include. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -172,13 +174,13 @@ Accept wildcard characters: False ### -ContentDateTo The ContentDateTo parameter specifies the end date of the date range for content to include. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -190,7 +192,7 @@ Accept wildcard characters: False ### -ContentMatchQuery The ContentMatchQuery parameter specifies a content search filter. -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). You can't use this parameter for Teams retention rules. @@ -198,7 +200,7 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -219,7 +221,7 @@ The ExcludedItemClasses parameter specifies the types of messages to exclude fro - IPM.Note.Microsoft.Voicemail.UM - IPM.Note.Microsoft.Voicemail.UM.CA -Additionally, you can specify [message classes for Exchange items](https://docs.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. +Additionally, you can specify [message classes for Exchange items](https://learn.microsoft.com/office/vba/outlook/concepts/forms/item-types-and-message-classes) and custom or third-party message classes. Note that the values you specify aren't validated, so the parameter accepts any text value. You can specify multiple item class values by using the following syntax: `"Value1","Value2",..."ValueN"`. @@ -229,7 +231,7 @@ You can't use this parameter for Teams retention rules. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -250,7 +252,39 @@ You can't use this parameter for Teams retention rules. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IRMRiskyUserProfiles +{{ Fill IRMRiskyUserProfiles Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PriorityCleanup +{{ Fill PriorityCleanup Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -270,7 +304,7 @@ The RetentionComplianceAction parameter specifies the retention action for the r Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -289,7 +323,7 @@ The RetentionDuration parameter specifies the hold duration for the retention ru Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -299,13 +333,13 @@ Accept wildcard characters: False ``` ### -RetentionDurationDisplayHint -The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft 365 compliance center. Valid values are Days, Months or Years. +The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Microsoft Purview compliance portal. Valid values are Days, Months or Years. - Days - Months - Years -For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft 365 compliance center will display 1 year as the content hold duration. +For example, if this parameter is set to the value Years, and the RetentionDuration parameter is set to the value 365, the Microsoft Purview compliance portal will display 1 year as the content hold duration. You can't use this parameter for Teams retention rules. @@ -313,7 +347,7 @@ You can't use this parameter for Teams retention rules. Type: HoldDurationHint Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -323,13 +357,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -343,12 +377,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md b/exchange/exchange-ps/exchange/Set-RetentionPolicy.md index 048ac1433b..14102c1ff4 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-RetentionPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-retentionpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-retentionpolicy +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-RetentionPolicy schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-RetentionPolicy cmdlet to change the properties of an existing retention policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Set-RetentionPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -46,7 +46,7 @@ Set-RetentionPolicy "MyPolicy" -RetentionPolicyTagLinks "MyRetentionPolicyTag" This example modifies the policy MyPolicy to link the retention policy tag MyRetentionPolicyTag with it. -The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). +The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see [About Parameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_parameters). ## PARAMETERS @@ -57,7 +57,7 @@ The Identity parameter specifies the name, distinguished name (DN), or GUID of t Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -104,7 +104,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you use the RetentionId parameter. ```yaml Type: SwitchParameter @@ -122,9 +124,18 @@ Accept wildcard characters: False ### -IsDefault This parameter is available only in the cloud-based service. -This parameter is reserved for internal Microsoft use. +The IsDefault switch specifies that this retention policy is the default retention policy. You don't need to specify a value with this switch. + +When you use this switch, you'll get a warning that this retention policy will replace the current default retention policy (the policy where the IsDefault property value is currently True) as the default. By default, the default retention policy is named Default MRM Policy. -To set the default retention policy for new mailboxes, use the RetentionPolicy parameter on the Set-MailboxPlan cmdlet. +**Note**: Changing which retention policy is the default might or might not affect new and existing mailboxes based on the value of the RetentionPolicy parameter on all mailbox plans: + +- $null (blank): Changes to which retention policy is the default are continually reflected in new and existing mailboxes. +- A retention policy is specified: The value of the RetentionPolicy parameter for all mailbox plans should be $null (blank) or match the Exchange retention policy that's configured as the default policy for the organization. Otherwise, the experience might be inconsistent when creating new mailboxes, enabling disabled mailboxes, and changing licenses. For more information see [Mailbox plans in Exchange Online](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/mailbox-plans). + +If a mailbox is assigned an Exchange retention policy that's not the default policy, the RetentionPolicy value of the mailbox will be overwritten when changing licenses and will need to be manually reset to the original value. + +Changes to the default retention policy that affect existing mailboxes can potentially saturate the network if there are hundreds or thousands of mailboxes that require updates. ```yaml Type: SwitchParameter @@ -142,7 +153,7 @@ Accept wildcard characters: False ### -IsDefaultArbitrationMailbox This parameter is available only in the cloud-based service. -The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. +The IsDefaultArbitrationMailbox switch configures this policy as the default retention policy for arbitration mailboxes in your Exchange Online organization. You don't need to specify a value with this switch. This parameter isn't available in on-premises deployments. @@ -216,7 +227,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -230,12 +241,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md index 7846ccef8c..f4d7334536 100644 --- a/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md +++ b/exchange/exchange-ps/exchange/Set-RetentionPolicyTag.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-retentionpolicytag +online version: https://learn.microsoft.com/powershell/module/exchange/set-retentionpolicytag applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-RetentionPolicyTag schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-RetentionPolicyTag cmdlet to modify the properties of a retention tag. -For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). +For more information about retention tags, see [Retention tags and retention policies in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/mrm/retention-tags-and-retention-policies). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -70,7 +70,7 @@ Set-RetentionPolicyTag -Mailbox ## DESCRIPTION Retention tags are used to apply message retention settings to folders and items in a mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -141,7 +141,7 @@ This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: RecipientIdParameter Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 @@ -223,7 +223,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch overrides the confirmation prompt displayed by the cmdlet when you use the RetentionId parameter. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +Use this switch to hide the confirmation prompt when you use the RetentionId parameter. ```yaml Type: SwitchParameter @@ -244,7 +246,7 @@ This parameter is available only in Exchange Server 2010. This parameter is reserved for internal Microsoft use. ```yaml -Type: Object +Type: Boolean Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 @@ -510,12 +512,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md b/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md index 216e4d42b0..eca66e5008 100644 --- a/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md +++ b/exchange/exchange-ps/exchange/Set-RoleAssignmentPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-roleassignmentpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-roleassignmentpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-RoleAssignmentPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-RoleAssignmentPolicy cmdlet to modify existing management role assignment policies in your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,9 +34,9 @@ Set-RoleAssignmentPolicy [-Identity] ## DESCRIPTION You can use the Set-RoleAssignmentPolicy cmdlet to change the name of an assignment policy or to set the assignment policy as the default assignment policy. -For more information about assignment policies, see [Understanding management role assignment policies](https://docs.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). +For more information about assignment policies, see [Understanding management role assignment policies](https://learn.microsoft.com/exchange/understanding-management-role-assignment-policies-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -121,7 +121,7 @@ Accept wildcard characters: False ``` ### -IsDefault -The IsDefault switch makes the assignment policy the default assignment policy. You don't have to specify a value with this switch. +The IsDefault switch makes the assignment policy the default assignment policy. You don't need to specify a value with this switch. New mailboxes or mailboxes moved from previous versions of Exchange are assigned the default assignment policy when an explicit assignment policy isn't provided. @@ -175,12 +175,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RoleGroup.md b/exchange/exchange-ps/exchange/Set-RoleGroup.md index a86d341ff4..b0c9fd04a3 100644 --- a/exchange/exchange-ps/exchange/Set-RoleGroup.md +++ b/exchange/exchange-ps/exchange/Set-RoleGroup.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-rolegroup -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-rolegroup +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection title: Set-RoleGroup schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-RoleGroup cmdlet to modify who can add or remove members to or from management role groups or change the name of the role group. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -55,9 +55,9 @@ If you want to add or remove members to or from an existing role group, use the If the ManagedBy property is populated with role group managers, the user configuring a role group must be a role group manager. Alternately, if the user is a member of the Organization Management role group or is directly or indirectly assigned the Role Management role, the BypassSecurityGroupManagerCheck switch can be used to override the security group management check. -For more information about role groups, see [Understanding management role groups](https://docs.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). +For more information about role groups, see [Understanding management role groups](https://learn.microsoft.com/exchange/understanding-management-role-groups-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,6 +78,7 @@ This example sets the role group managers list to the Seattle Role Administrator ### Example 3 ```powershell $Credentials = Get-Credential + Set-RoleGroup "ContosoUsers: Toronto Recipient Admins" -LinkedDomainController dc02.contosousers.contoso.com -LinkedCredential $Credentials -LinkedForeignGroup "Toronto Tier 2 Administrators" ``` @@ -94,7 +95,7 @@ The Identity parameter specifies the name of the role group to modify. If the na Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -146,7 +147,12 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch enables a user who hasn't been added to the ManagedBy property to modify a role group. The user must be a member of the Organization Management role group or be assigned, either directly or indirectly, the Role Management role. +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: + +- Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. +- Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. ```yaml Type: SwitchParameter @@ -171,7 +177,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -187,7 +193,7 @@ The Description parameter specifies the description displayed when the role grou Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -197,13 +203,13 @@ Accept wildcard characters: False ``` ### -DisplayName -The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter can have a maximum length of 256 characters. +The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter has a maximum length of 256 characters. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -233,13 +239,15 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: Default Aliases: -Applicable: Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -253,7 +261,7 @@ This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). You can only use the LinkedCredential parameter with a linked role group. @@ -269,7 +277,7 @@ Accept wildcard characters: False ``` ### -ManagedBy -The ManagedBy parameter specifies the users or USG who can modify the configuration of a role group or add or remove members to or from a role group. The list you specify with this parameter overwrites the existing ManagedBy list. To add or remove individual role group managers, and for more information about modifying multivalued properties, see [Modifying multivalued properties](https://docs.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). +The ManagedBy parameter specifies the users or USG who can modify the configuration of a role group or add or remove members to or from a role group. The list you specify with this parameter overwrites the existing ManagedBy list. To add or remove individual role group managers, and for more information about modifying multivalued properties, see [Modifying multivalued properties](https://learn.microsoft.com/exchange/modifying-multivalued-properties-exchange-2013-help). You can use the name, distinguished name (DN), or primary SMTP address of the user or USG you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks ("). @@ -295,7 +303,7 @@ The Name parameter specifies the name of the role group. The name can contain up Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -323,7 +331,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -331,7 +339,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -345,12 +353,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md b/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md index a4fd74b8d7..d17b041270 100644 --- a/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md +++ b/exchange/exchange-ps/exchange/Set-RoutingGroupConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-routinggroupconnector +online version: https://learn.microsoft.com/powershell/module/exchange/set-routinggroupconnector applicable: Exchange Server 2010 title: Set-RoutingGroupConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-RoutingGroupConnector cmdlet to modify the properties of an existing routing group connector between a Microsoft Exchange Server 2010 routing group and an Exchange Server 2003 routing group. You can also use this cmdlet to configure the maximum message size that can pass across a routing group connector. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ The Set-RoutingGroupConnector cmdlet modifies the properties of an existing rout The Exchange 2003 source servers specified in this cmdlet are automatically added to the ExchangeLegacyInterop universal security group. By default, the Exchange 2010 system grants Send to and Receive from permissions on the Hub Transport servers to members of this group. The source and target servers must be computers that have the Exchange 2010 Hub Transport server role installed, or Exchange 2003 bridgehead servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -179,7 +179,7 @@ Accept wildcard characters: False ``` ### -SourceTransportServers -The SourceTransportServers parameter specifies the host name or FQDN of the transport servers that are used to send messages to the target transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see [Modifying Multivalued Properties](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb684908(v=exchg.141)). +The SourceTransportServers parameter specifies the host name or FQDN of the transport servers that are used to send messages to the target transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see [Modifying Multivalued Properties](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb684908(v=exchg.141)). ```yaml Type: MultiValuedProperty @@ -195,7 +195,7 @@ Accept wildcard characters: False ``` ### -TargetTransportServers -The TargetTransportServers parameter specifies the host name or FQDN of the transport servers that receive messages from the source transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see [Modifying Multivalued Properties](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/bb684908(v=exchg.141)). +The TargetTransportServers parameter specifies the host name or FQDN of the transport servers that receive messages from the source transport servers. You can specify more than one server by separating each entry with a comma. For more information about how to add or remove values from multivalued properties, see [Modifying Multivalued Properties](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/bb684908(v=exchg.141)). ```yaml Type: MultiValuedProperty @@ -231,12 +231,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md b/exchange/exchange-ps/exchange/Set-RpcClientAccess.md index 0c2078feca..970b171e11 100644 --- a/exchange/exchange-ps/exchange/Set-RpcClientAccess.md +++ b/exchange/exchange-ps/exchange/Set-RpcClientAccess.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-rpcclientaccess +online version: https://learn.microsoft.com/powershell/module/exchange/set-rpcclientaccess applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-RpcClientAccess schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-RpcClientAccess cmdlet to modify the settings of the Microsoft Exchange RPC Client Access service on Exchange servers that have the Client Access server role installed. These settings affect Outlook clients that connect by using Outlook Anywhere (RPC over HTTP). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Outlook 2007 isn't supported in Exchange 2016 or later, so you shouldn't see Out To block Outlook versions for specific mailboxes, use the Set-CASMailbox cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -217,12 +217,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md index 2207ed5467..fbaa17c621 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-safeattachmentpolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-safeattachmentpolicy +applicable: Exchange Online title: Set-SafeAttachmentPolicy schema: 2.0.0 author: chrisda @@ -16,19 +16,17 @@ This cmdlet is available only in the cloud-based service. Use the Set-SafeAttachmentPolicy cmdlet to modify safe attachment policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-SafeAttachmentPolicy [-Identity] [-Action ] - [-ActionOnError ] [-AdminDisplayName ] [-Confirm] [-Enable ] + [-QuarantineTag ] [-Redirect ] [-RedirectAddress ] [-WhatIf] @@ -36,20 +34,20 @@ Set-SafeAttachmentPolicy [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). A safe attachment policy can be assigned to only one safe attachment rule by using the SafeAttachmentPolicy parameter on the New-SafeAttachmentRule or Set-SafeAttachmentRule cmdlets. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -Redirect $true -RedirectAddress admin@contoso.com +Set-SafeAttachmentsPolicy -Identity "Engineering Block Attachments" -QuarantineTag ContosoLimitedAccess ``` -This example modifies the existing safe attachment policy named Engineering Block Attachments to redirect detected malware attachments to admin@contoso.com. +This example modifies the existing safe attachment policy named Engineering Block Attachments to set the quarantine policy to ContosoLimitedAccess. ## PARAMETERS @@ -66,7 +64,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -78,14 +76,13 @@ Accept wildcard characters: False ### -Action The Action parameter specifies the action for the safe attachment policy. Valid values are: -- Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the admin center. +- Allow: Deliver the message if malware is detected in the attachment and track scanning results. This value corresponds to **Monitor** for the **Safe Attachments unknown malware response** property of the policy in the Microsoft Defender portal. - Block: Block the email message that contains the malware attachment. This is the default value. -- Replace: Deliver the email message, but remove the malware attachment and replace it with warning text. -- DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [How Dynamic Delivery works](https://docs.microsoft.com/microsoft-365/security/office-365-security/dynamic-delivery-and-previewing#how-dynamic-delivery-works). +- DynamicDelivery: Deliver the email message with a placeholder for each email attachment. The placeholder remains until a copy of the attachment is scanned and determined to be safe. For more information, see [Dynamic Delivery in Safe Attachments policies](https://learn.microsoft.com/defender-office-365/safe-attachments-about#dynamic-delivery-in-safe-attachments-policies). -The value of this parameter is meaningful only if the value of the Enable parameter is also $true (the default value is $false). +The value of this parameter is meaningful only when the value of the Enable parameter is $true (the default value is $false). -To specify no action for the safe attachment policy (corresponds to **Off** for the **Safe Attachments unknown malware response** property of the policy in admin center), use the Enable parameter with the value $false. +To specify no action for the safe attachment policy (corresponds to the value **Off** for the **Safe Attachments unknown malware response** policy setting in the Defender portal), use the value $false for the Enable parameter. The results of all actions are available in message trace. @@ -93,26 +90,7 @@ The results of all actions are available in message trace. Type: SafeAttachmentAction Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActionOnError -The ActionOnError parameter specifies the error handling option for Safe Attachments scanning (what to do if attachment scanning times out or an error occurs). Valid values are: - -- $true: This is the default value. The action specified by the Action parameter is applied to messages even when the attachments aren't successfully scanned. This value is required when the Redirect parameter value is $true. Otherwise, messages might be lost. -- $false: The action specified by the Action parameter isn't applied to messages when the attachments aren't successfully scanned. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -128,7 +106,7 @@ The AdminDisplayName parameter specifies a description for the policy. If the va Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -147,7 +125,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -160,15 +138,41 @@ Accept wildcard characters: False The Enable parameter works with the Action parameter to specify the action for the safe attachment policy. Valid values are: - $true: The Action parameter specifies the action for the safe attachment policy. -- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. This value corresponds to **Off** for **Safe Attachments unknown malware response** property of the policy in the admin center. +- $false: This is the default value. Attachments are not scanned by Safe Attachments, regardless of the value of the Action parameter. $false corresponds to the value **Off** for the **Safe Attachments unknown malware response** setting of the complete Safe Attachments policy in the Microsoft Defender portal (the combination of the rule and the corresponding associated policy in PowerShell). -To enable or disable a complete Safe Attachments policy in the admin center (the combination of the rule and the corresponding associated policy in PowerShell), use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. +To enable or disable an existing Safe Attachments policy, use the Enable-SafeAttachmentRule or Disable-SafeAttachmentRule cmdlets. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QuarantineTag +The QuarantineTag parameter specifies the quarantine policy that's used on messages that are quarantined as malware by Safe Attachments. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages based on why the message was quarantined and quarantine notification settings. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +The default value for this parameter is the built-in quarantine policy named AdminOnlyAccessPolicy. This quarantine policy enforces the historical capabilities for messages that were quarantined as malware by Safe Attachments as described in the table [here](https://learn.microsoft.com/defender-office-365/quarantine-end-user). + +To view the list of available quarantine policies, run the following command: `Get-QuarantinePolicy | Format-List Name,EndUser*,ESNEnabled`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -178,16 +182,16 @@ Accept wildcard characters: False ``` ### -Redirect -The Redirect parameter specifies whether to deliver messages that were identified by Safe Attachments as containing malware attachments to another email address. Valid values are: +The Redirect parameter specifies whether to deliver messages to an alternate email address if malware is detected in an attachment. Valid values are: -- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is required when the ActionOnError parameter value is $true. Otherwise, messages might be lost. +- $true: Messages that contain malware attachments are delivered to the email address specified by the RedirectAddress parameter. This value is meaningful only when the value of the Action parameter is Allow. - $false: Messages that contain malware attachments aren't delivered to another email address. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -197,13 +201,15 @@ Accept wildcard characters: False ``` ### -RedirectAddress -The RedirectAddress parameter specifies the email address to deliver messages that were identified by Safe Attachments as containing malware attachments when the Redirect parameter is set to the value $true. +The RedirectAddress parameter specifies the destination email address to deliver messages if malware is detected in an attachment. + +The value of this parameter is meaningful only when value of the Redirect parameter is $true and the value of the Action parameter is Allow. ```yaml Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -219,7 +225,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -233,12 +239,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md index fbaf110667..985e31a012 100644 --- a/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md +++ b/exchange/exchange-ps/exchange/Set-SafeAttachmentRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-safeattachmentrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-safeattachmentrule +applicable: Exchange Online title: Set-SafeAttachmentRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-SafeAttachmentRule cmdlet to modify safe attachment rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,11 +38,14 @@ Set-SafeAttachmentRule [-Identity] ``` ## DESCRIPTION -Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-attachments). +Safe Attachments is a feature in Microsoft Defender for Office 365 that opens email attachments in a special hypervisor environment to detect malicious activity. For more information, see [Safe Attachments in Defender for Office 365](https://learn.microsoft.com/defender-office-365/safe-attachments-about). A safe attachment policy can be assigned only to one safe attachment rule. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Safe Attachments policy settings](https://learn.microsoft.com/defender-office-365/safe-attachments-about#safe-attachments-policy-settings). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -70,7 +71,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -86,7 +87,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -105,7 +106,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -115,13 +116,13 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -146,7 +147,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -156,7 +157,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -173,7 +174,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -189,7 +190,7 @@ The Name parameter specifies a unique name for the safe attachment rule. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -213,7 +214,7 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -223,13 +224,13 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -253,7 +254,7 @@ You can't specify a safe attachment policy that's already associated with anothe Type: SafeAttachmentPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -278,7 +279,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -288,7 +289,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -305,7 +306,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -321,7 +322,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -335,12 +336,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md index 5c4a9648ad..4587cee20b 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-safelinkspolicy -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-safelinkspolicy +applicable: Exchange Online title: Set-SafeLinksPolicy schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-SafeLinksPolicy cmdlet to modify Safe Links policies in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,43 +26,39 @@ Set-SafeLinksPolicy [-Identity] [-AllowClickThrough ] [-Confirm] [-CustomNotificationText ] - [-DeliverMessageAfterScan - [-DoNotAllowClickThrough ] + [-DeliverMessageAfterScan ] + [-DisableUrlRewrite ] [-DoNotRewriteUrls ] - [-DoNotTrackUserClicks ] [-EnableForInternalSenders ] [-EnableOrganizationBranding ] + [-EnableSafeLinksForEmail ] + [-EnableSafeLinksForOffice ] [-EnableSafeLinksForTeams ] - [-ExcludedUrls ] - [-IsEnabled ] [-ScanUrls ] [-TrackClicks ] [-UseTranslatedNotificationText ] [-WhatIf] - [-WhiteListedUrls ] [] ``` ## DESCRIPTION -Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. +Safe Links is a feature in Microsoft Defender for Office 365 that checks links to see if they lead to malicious web sites. When a user clicks a link, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-SafeLinksPolicy -Identity "Engineering Block URL" -TrackClicks $true +Set-SafeLinksPolicy -Identity "Engineering Block URL" -AllowClickThrough $false ``` -This example modifies the existing Safe Links policy named Engineering Block URL to track user clicks on URLs in URL trace. +This example modifies the existing Safe Links policy named Engineering Block URL to not allow click through to the original URLs on warning pages. ## PARAMETERS ### -Identity -The Identity parameter specifies the Safe Links policy that you want to modify. - -You can use any value that uniquely identifies the policy. For example: +The Identity parameter specifies the Safe Links policy that you want to modify. You can use any value that uniquely identifies the policy. For example: - Name - Distinguished name (DN) @@ -74,7 +68,7 @@ You can use any value that uniquely identifies the policy. For example: Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -90,7 +84,7 @@ The AdminDisplayName parameter specifies a description for the policy. If the va Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -100,13 +94,18 @@ Accept wildcard characters: False ``` ### -AllowClickThrough -This parameter has been deprecated. Use the DoNotAllowClickThrough parameter instead. +The AllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: + +$true: The user is allowed to click through to the original URL. +$false: The user isn't allowed to click through to the original URL. + +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -125,7 +124,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -141,7 +140,7 @@ The custom notification text specifies the customized notification text to show Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -153,14 +152,14 @@ Accept wildcard characters: False ### -DeliverMessageAfterScan The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: -- $true: Wait until Safe Links scanning is complete before delivering the message. Messages that contain malicious links are not delivered. -- $false: If Safe Links scanning can't complete, deliver the message anyway. This is the default value. +- $true: Wait until Safe Links scanning is complete before delivering the message. This is the default value. Messages that contain malicious links are not delivered. +- $false: If Safe Links scanning can't complete, deliver the message anyway. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -169,17 +168,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DoNotAllowClickThrough -The DoNotAllowClickThrough parameter specifies whether to allow users to click through to the original URL on warning pages. Valid values are: +### -DisableUrlRewrite +The DisableUrlRewrite parameter specifies whether to rewrite (wrap) URLs in email messages. Valid values are: + +- $true: URLs in messages are not rewritten, but messages are still scanned by Safe Links prior to delivery. Time of click checks on links are done using the Safe Links API in supported Outlook clients (currently, Outlook for Windows and Outlook for Mac). +- $false: URLs in messages are rewritten. API checks still occur on unwrapped URLs in supported clients if the user is in a valid Safe Links policy. -- $true: The user isn't allowed to click through to the original URL. -- $false: The user is allowed to click through to the original URL. This is the default value. +In PowerShell, the default value is $false. In new Safe Links policies created in the Microsoft Defender portal, the default value is $true. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -193,32 +194,13 @@ The DoNotRewriteUrls parameter specifies the URLs that are not rewritten by Safe You can enter multiple values separated by commas. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. -For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://docs.microsoft.com/microsoft-365/security/office-365-security/atp-safe-links#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). +For details about the entry syntax, see [Entry syntax for the "Do not rewrite the following URLs" list](https://learn.microsoft.com/defender-office-365/safe-links-about#entry-syntax-for-the-do-not-rewrite-the-following-urls-list). ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoNotTrackUserClicks -The DoNotTrackUserClicks parameter specifies whether to track user clicks related to Safe Links protection of links in email messages. Valid values are: - -- $true: User clicks in email messages aren't tracked. -- $false: User clicks in email messages are tracked. This is the default value. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -230,14 +212,14 @@ Accept wildcard characters: False ### -EnableForInternalSenders The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization. Valid values are: -- $true: The policy is applied to internal and external senders. -- $false: The policy is applied only to external senders. This is the default value. +- $true: The policy is applied to internal and external senders. This is the default value. +- $false: The policy is applied only to external senders. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -249,14 +231,14 @@ Accept wildcard characters: False ### -EnableOrganizationBranding The EnableOrganizationBranding parameter specifies whether your organization's logo is displayed on Safe Links warning and notification pages. Valid values are: -- $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://docs.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. -- $false: Organization branding is not displayed on Safe Links warning and notification pages. +- $true: Organization branding is displayed on Safe Links warning and notification pages. Before you configure this value, you need to follow the instructions in [Customize the Microsoft 365 theme for your organization](https://learn.microsoft.com/microsoft-365/admin/setup/customize-your-organization-theme) to upload your company logo. +- $false: Organization branding is not displayed on Safe Links warning and notification pages. This is the default value. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -265,19 +247,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSafeLinksForTeams -**Note**: As of March 2020, this parameter is in Preview and is available or functional only for members of the Microsoft Teams Technology Adoption Program (TAP). - -The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: +### -EnableSafeLinksForEmail +The EnableSafeLinksForEmail parameter specifies whether to enable Safe Links protection for email messages. Valid values are: -- $true: Safe Links is enabled for Teams. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. -- $false: Safe Links isn't enabled for Teams. This is the default value. +- $true: Safe Links is enabled for email. This is the default value. When a user clicks a link in an email, the link will be checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for email. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -286,14 +266,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedUrls -This parameter has been deprecated. Use the DoNotRewriteUrls parameter instead. +### -EnableSafeLinksForOffice +The EnableSafeLinksForOffice parameter specifies whether to enable Safe Links protection for supported Office desktop, mobile, or web apps. Valid values are: + +- $true: Safe Links scanning is enabled in Office apps. This is the default value. When a user opens a file in a supported Office app and clicks a link in the file, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Office apps. + +Note that this protection applies to links in Office documents, not links in email messages. ```yaml -Type: String[] +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -302,17 +287,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsEnabled -The IsEnabled parameter specifies whether to enable Safe Links protection for email messages. Valid values are: +### -EnableSafeLinksForTeams +The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: -- $true: Enable Safe Links protection for email messages. Rewrite URLs and check against a list of known malicious links whenever a user clicks a link in an email message. -- $false: Disable Safe Links protection for email messages. Don't rewrite URLs and do not check clicked links in email messages. This is the default value. +- $true: Safe Links is enabled for Teams. This is the default value. When a user clicks a link in a Teams conversation, group chat, or from channels, the link is checked by Safe Links. If the link is found to be malicious, a warning page appears in the default web browser. +- $false: Safe Links isn't enabled for Teams. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -324,14 +309,14 @@ Accept wildcard characters: False ### -ScanUrls The ScanUrls parameter specifies whether to enable or disable real-time scanning of clicked links in email messages. Valid values are: -- $true: Real-time scanning of clicked links in email messages, including links that point to files, is enabled. -- $false: Real-time scanning of clicked links in email messages, including links that point to files, is disabled. This is the default value. +- $true: Real-time scanning of clicked links, including links that point to files, is enabled. This is the default value. +- $false: Real-time scanning of clicked links, including links that point to files, is disabled. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -341,13 +326,16 @@ Accept wildcard characters: False ``` ### -TrackClicks -This parameter is reserved for internal Microsoft use. +The TrackClicks parameter specifies whether to track user clicks related to Safe Links protection of links. Valid values are: + +- $true: User clicks are tracked. This is the default value. +- $false: User clicks aren't tracked. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -366,7 +354,7 @@ The UseTranslatedNotificationText specifies whether to use Microsoft Translator Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -382,23 +370,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhiteListedUrls -This parameter has been deprecated. Use the DoNotRewriteUrls parameter instead. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -412,12 +384,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md index 3f7da3b2c7..6db4b01eeb 100644 --- a/exchange/exchange-ps/exchange/Set-SafeLinksRule.md +++ b/exchange/exchange-ps/exchange/Set-SafeLinksRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-safelinksrule -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-safelinksrule +applicable: Exchange Online title: Set-SafeLinksRule schema: 2.0.0 author: chrisda @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Set-SafeLinksRule cmdlet to create Safe Links rules in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +40,10 @@ Set-SafeLinksRule [-Identity] ## DESCRIPTION Safe Links is a feature in Microsoft Defender for Office 365 that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites. Safe Links includes the URL trace reporting feature to help determine who has clicked through to a malicious web site. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +> [!IMPORTANT] +> Different types of recipient conditions use AND logic (the recipient must satisfy **all** specified conditions). Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Recipient filters in Safe Links policies](https://learn.microsoft.com/defender-office-365/safe-links-about#recipient-filters-in-safe-links-policies). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -51,7 +52,25 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Set-SafeLinksRule -Identity "Engineering Department URL Rule" -ExceptIfRecipientDomainIs fabrikam.com ``` -This example modifies the existing Safe Links Rule named Engineering Department URL Rule to exclude messages sent to the fabrikam.com domain. +This example modifies the existing Safe Links rule named Engineering Department URL Rule to exclude messages sent to recipients in the fabrikam.com domain. + +### Example 2 +```powershell +Set-SafeLinksRule -Identity "Contoso All" -RecipientDomainIs (Get-AcceptedDomain).Name +``` + +This example modifies the existing Safe Links rule named Contoso All to include messages sent to recipients in all accepted domains in the organization. + +### Example 3 +```powershell +$Data = Import-Csv -Path "C:\Data\SafeLinksDomains.csv" + +$SLDomains = $Data.Domains + +Set-SafeLinksRule -Identity "Contoso All" -RecipientDomainIs $SLDomains +``` + +This example is similar to Example 2, but in this example, the Safe Links rule includes messages sent to recipients in the accepted domains specified in a .csv file. ## PARAMETERS @@ -68,7 +87,7 @@ You can use any value that uniquely identifies the rule. For example: Type: RuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: True Position: 1 @@ -84,7 +103,7 @@ The Comments parameter specifies informative comments for the rule, such as what Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -103,7 +122,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -113,13 +132,13 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -144,7 +163,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -154,7 +173,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: +The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -171,7 +190,7 @@ If you remove the group after you create the rule, no exception is made for mess Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -187,7 +206,7 @@ The Name parameter specifies a unique name for the Safe Links rule. If the value Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -211,7 +230,7 @@ If you modify the priority value of a rule, the position of the rule in the list Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -221,13 +240,13 @@ Accept wildcard characters: False ``` ### -RecipientDomainIs -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. ```yaml Type: Word[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -251,7 +270,7 @@ You can't specify a Safe Attachments policy that's already associated with anoth Type: SafeLinksPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -276,7 +295,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -286,7 +305,7 @@ Accept wildcard characters: False ``` ### -SentToMemberOf -The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: +The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely identifies the group. For example: - Name - Alias @@ -303,7 +322,7 @@ If you remove the group after you create the rule, no action is taken on message Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -319,7 +338,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online Required: False Position: Named @@ -333,12 +352,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md b/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md index c5213748e5..4288a07794 100644 --- a/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md +++ b/exchange/exchange-ps/exchange/Set-SearchDocumentFormat.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-searchdocumentformat +online version: https://learn.microsoft.com/powershell/module/exchange/set-searchdocumentformat applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SearchDocumentFormat schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Set-SearchDocumentFormat cmdlet to enable or disable the file format for When you disable a file format for content indexing by Exchange Search, contents of the file become unsearchable by Exchange Search clients such as Outlook on the web, Microsoft Outlook in online mode and In-Place eDiscovery. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +31,9 @@ Set-SearchDocumentFormat [-Identity] -Enabled ``` ## DESCRIPTION -Exchange Search includes built-in support for indexing many file formats. If you disable indexing for a supported file format, items containing an attachment of that file type aren't considered unsearchable. When you perform an [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) search and you select the option to include unsearchable items, only items that are actually unsearchable are returned. Items that weren't searched because the associated file format is set as unsearchable aren't returned. +Exchange Search includes built-in support for indexing many file formats. If you disable indexing for a supported file format, items containing an attachment of that file type aren't considered unsearchable. When you perform an [In-Place eDiscovery search in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery) and you select the option to include unsearchable items, only items that are actually unsearchable are returned. Items that weren't searched because the associated file format is set as unsearchable aren't returned. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -141,12 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md b/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md index 0a6ae4f8c4..0c6e563991 100644 --- a/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md +++ b/exchange/exchange-ps/exchange/Set-SecOpsOverridePolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-secopsoverridepolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-secopsoverridepolicy +applicable: Exchange Online title: Set-SecOpsOverridePolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-SecOpsOverridePolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in the cloud-based service. -Use the Set-SecOpsOverridePolicy cmdlet to modify SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). +Use the Set-SecOpsOverridePolicy cmdlet to modify SecOps mailbox override policies to bypass Exchange Online Protection filtering. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,14 +25,16 @@ Set-SecOpsOverridePolicy [-Identity] [-AddSentTo ] [-Comment ] [-Confirm] + [-DomainController ] [-Enabled ] + [-Force] [-RemoveSentTo ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,7 +59,7 @@ The Identity parameter specifies the SecOps override policy that you want to mod Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: True Position: 0 @@ -75,7 +77,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -91,7 +93,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -110,7 +112,23 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -129,7 +147,25 @@ The Enabled parameter specifies whether the policy is enabled. Valid values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -147,7 +183,7 @@ You can specify multiple values separated by commas. Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -157,13 +193,15 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +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. + +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Exchange Online Required: False Position: Named @@ -177,12 +215,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SecOpsOverrideRule.md b/exchange/exchange-ps/exchange/Set-SecOpsOverrideRule.md deleted file mode 100644 index df00bcc935..0000000000 --- a/exchange/exchange-ps/exchange/Set-SecOpsOverrideRule.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-secopsoverriderule -applicable: Security & Compliance Center -title: Set-SecOpsOverrideRule -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-SecOpsOverrideRule - -## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). - -Use the Set-SecOpsOverrideRule cmdlet to modify SecOps mailbox override rules to bypass Exchange Online Protection filtering. For more information, see [Configure the delivery of third-party phishing simulations to users and unfiltered messages to SecOps mailboxes](https://docs.microsoft.com/microsoft-365/security/office-365-security/configure-advanced-delivery). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-SecOpsOverrideRule [-Identity] - [-AddSentTo ] - [-Comment ] - [-Confirm] - [-RemoveSentTo ] - [-WhatIf] - [] -``` - -## DESCRIPTION -You need to be assigned permissions in the Security & Compliance Center before you can use this cmdlet. For more information, see [Permissions in the Security & Compliance Center](https://docs.microsoft.com/microsoft-365/security/office-365-security/permissions-in-the-security-and-compliance-center). - -## EXAMPLES - -### Example 1 -```powershell -Set-SecOpsOverrideRule -Identity SecOpsOverrideRule6fed4b63-3563-495d-a481-b24a311f8329 -RemoveSentTo sceops2@contoso.com -``` - -This example modifies the SecOps mailbox override rule with the specified settings. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the SecOps override rule that you want to modify. You can use any value that uniquely identifies the rule. For example: - -- Name -- Id -- Distinguished name (DN) -- GUID - -```yaml -Type: ComplianceRuleIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -AddSentTo -The AddSentTo parameter specifies an entry to add to the existing list of SecOps mailbox email addresses. Groups are not allowed. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveSentTo -The RemoveSentTo parameter specifies an entry to remove from the existing list of SecOps mailbox email addresses. Groups are not allowed. - -You can specify multiple values separated by commas. - -```yaml -Type: MultiValuedProperty -Parameter Sets: (All) -Aliases: -Applicable: Security & Compliance Center - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Security & Compliance Center - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SendConnector.md b/exchange/exchange-ps/exchange/Set-SendConnector.md index 95e3b64d96..a8e6726d37 100644 --- a/exchange/exchange-ps/exchange/Set-SendConnector.md +++ b/exchange/exchange-ps/exchange/Set-SendConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-sendconnector +online version: https://learn.microsoft.com/powershell/module/exchange/set-sendconnector applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SendConnector schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SendConnector cmdlet to modify a Send connector. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -62,7 +62,7 @@ Set-SendConnector [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -115,7 +115,7 @@ If you specify a non-SMTP address space type on a Send connector configured in t - The SmartHosts parameter must be set to a value that specifies a smart host. - The DNSRoutingEnabled parameter must be set to $false. -Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://docs.microsoft.com/exchange/foreign-connectors-exchange-2013-help). +Although you can configure non-SMTP address spaces on a Send connector in the Transport service on a Mailbox server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors in the Transport service on a Mailbox server are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see [Foreign connectors](https://learn.microsoft.com/exchange/foreign-connectors-exchange-2013-help). ```yaml Type: MultiValuedProperty @@ -133,7 +133,7 @@ Accept wildcard characters: False ### -AuthenticationCredential The AuthenticationCredential parameter specifies the username and password that's required to use the connector. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -149,7 +149,7 @@ Accept wildcard characters: False ``` ### -CloudServicesMailEnabled -**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://docs.microsoft.com/exchange/hybrid-configuration-wizard). +**Note**: We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see [Hybrid Configuration wizard](https://learn.microsoft.com/exchange/hybrid-configuration-wizard). The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-\* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. @@ -350,7 +350,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -624,7 +626,7 @@ Accept wildcard characters: False ``` ### -SmartHosts -The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameteris required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart-host server. +The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameter is required if you set the DNSRoutingEnabled parameter to $false and it must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. If you enter an IP address, you must enter the IP address as a literal. For example, 10.10.1.1. The smart host identity can be the FQDN of a smart-host server, a mail exchanger (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart-host server. To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. @@ -793,12 +795,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md b/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md index cd62a22368..1b634750be 100644 --- a/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md +++ b/exchange/exchange-ps/exchange/Set-SenderFilterConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-senderfilterconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-senderfilterconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SenderFilterConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SenderFilterConfig cmdlet to modify the Sender Filter agent configuration. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Set-SenderFilterConfig [-Action ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -282,12 +282,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SenderIdConfig.md b/exchange/exchange-ps/exchange/Set-SenderIdConfig.md index 586a3e0bcf..eaeddca576 100644 --- a/exchange/exchange-ps/exchange/Set-SenderIdConfig.md +++ b/exchange/exchange-ps/exchange/Set-SenderIdConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-senderidconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-senderidconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SenderIdConfig schema: 2.0.0 @@ -16,12 +16,13 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SenderIdConfig cmdlet to modify the configuration of the Sender ID agent. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` -Set-SenderIdConfig [-BypassedRecipients ] +Set-SenderIdConfig + [-BypassedRecipients ] [-BypassedSenderDomains ] [-Confirm] [-DomainController ] @@ -35,7 +36,7 @@ Set-SenderIdConfig [-BypassedRecipients ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -221,12 +222,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md b/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md index 5a0e0777b9..610a9441ff 100644 --- a/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md +++ b/exchange/exchange-ps/exchange/Set-SenderReputationConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-senderreputationconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-senderreputationconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SenderReputationConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SenderReputationConfig cmdlet to modify the sender reputation configuration on Mailbox servers or Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +38,7 @@ Set-SenderReputationConfig [-Confirm] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -313,12 +313,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ServerComponentState.md b/exchange/exchange-ps/exchange/Set-ServerComponentState.md index 50c9dd1f38..11c76cf3c6 100644 --- a/exchange/exchange-ps/exchange/Set-ServerComponentState.md +++ b/exchange/exchange-ps/exchange/Set-ServerComponentState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-servercomponentstate +online version: https://learn.microsoft.com/powershell/module/exchange/set-servercomponentstate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ServerComponentState schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ServerComponentState cmdlet to configure and update Microsoft Exchange components and endpoints on servers you specify. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,17 +32,32 @@ Set-ServerComponentState [-Identity] -Component -Re ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-ServerComponentState -Component UMCallRouter -Identity MailboxServer01 -Requester Maintenance -State Active +Set-ServerComponentState -Identity MailboxServer01 -Component UMCallRouter -Requester Maintenance -State Active ``` This example sets the Unified Messaging (UM) component state to Active, as requested by maintenance mode. +### Example 2 +```powershell +Set-ServerComponentState -Identity Exch5 -Component ServerWideOffline -State Inactive -Requester Maintenance + +Set-ServerComponentState -Identity Exch5 -Component ServerWideOffline -State Active -Requester Maintenance +``` + +This example prepares the server for maintenance, such as installing a Security Update or Cumulative Update. + +The first command changes the state of all server components to Inactive. + +The second command changes the state to Active after the maintenance is over (required). + +**Note**: By design, the Microsoft Exchange IMAP4 and Microsoft Exchange POP3 services stop if the related `ImapProxy` and `PopProxy` components are in the Inactive state. You might need to manually restart the services after the related `ImapProxy` and `PopProxy` components are changed to the Active state. + ## PARAMETERS ### -Identity @@ -230,12 +245,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ServerMonitor.md b/exchange/exchange-ps/exchange/Set-ServerMonitor.md index 33b3b248ef..42b0c4a810 100644 --- a/exchange/exchange-ps/exchange/Set-ServerMonitor.md +++ b/exchange/exchange-ps/exchange/Set-ServerMonitor.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-servermonitor +online version: https://learn.microsoft.com/powershell/module/exchange/set-servermonitor applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ServerMonitor schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ServerMonitor cmdlet to edit or set a parameter on a single monitor on an Exchange server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Set-ServerMonitor [-Server] -Name -Repairing + [-Confirm] + [-DisplayName ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You can use this cmdlet to change the DisplayName only. If AppId/ObjectId is wrong, delete the service principal and create a new one. + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-ServicePrincipal -Identity dc873ad4-0397-4d74-b5c0-897cd3a94731 -DisplayName "Another App Name" +``` + +This example sets the service principal in Exchange Online with the specified display name. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to modify. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ObjectId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: True +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +The DisplayName parameter specifies the friendly name of the service principal. If the name contains spaces, enclose the name in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SettingOverride.md b/exchange/exchange-ps/exchange/Set-SettingOverride.md index 37ca3cc5c6..f038384c37 100644 --- a/exchange/exchange-ps/exchange/Set-SettingOverride.md +++ b/exchange/exchange-ps/exchange/Set-SettingOverride.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-settingoverride +online version: https://learn.microsoft.com/powershell/module/exchange/set-settingoverride applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SettingOverride schema: 2.0.0 @@ -18,7 +18,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SettingOverride cmdlet to modify setting overrides that store Exchange customizations in Active Directory instead of in text files on the server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ Set-SettingOverride [-Identity] ## DESCRIPTION Setting overrides configure and store Exchange server customizations in Active Directory. The settings can be organization-wide or server-specific, and they persist in Active Directory across Exchange Cumulative Updates (CUs). Exchange customizations in web.config or exe.config XML application configuration files are server-specific, and they're lost when you install the next Exchange CU. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -108,7 +108,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -237,12 +239,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SharingPolicy.md b/exchange/exchange-ps/exchange/Set-SharingPolicy.md index c291c20722..5f5182f760 100644 --- a/exchange/exchange-ps/exchange/Set-SharingPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SharingPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-sharingpolicy -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-sharingpolicy +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-SharingPolicy schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-SharingPolicy cmdlet to modify existing sharing policies that control how users inside your organization can share free/busy and contact information with users outside your organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ Set-SharingPolicy [-Identity] ## DESCRIPTION Users can only share free/busy and contact information after federation has been configured between Exchange organizations. After that, users can send sharing invitations to the external recipients as long as those invitations comply with the sharing policy. A sharing policy needs to be assigned to a mailbox to be effective. If a mailbox doesn't have a specific sharing policy assigned, a default policy enforces the sharing options for the mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,7 +74,7 @@ The Identity parameter specifies the identity of the sharing policy that you wan Type: SharingPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -93,7 +93,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -139,20 +139,22 @@ Accept wildcard characters: False ``` ### -Domains -The Domains parameter specifies domains to which this policy applies and the sharing policy action. Values for this parameter use the format `Domain:SharingPolicyAction`. +The Domains parameter specifies the domains and the associated sharing options for those domains in the sharing policy. Values for this parameter use the basic syntax: `'Domain: SharingPolicyAction'`. -The following SharingPolicyAction values can be used: +You can use the following values for `Domain`: -- CalendarSharingFreeBusySimple: Share free/busy hours only. -- CalendarSharingFreeBusyDetail: Share free/busy hours, subject, and location. -- CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location, and the body of the message or calendar item. -- ContactsSharing: Share contacts only. +- A domain: For example, `mail.contoso.com`. A domain doesn't include subdomains. You must configure each subdomain separately. +- \*: Share with external federated organizations. For example, another Microsoft 365 organization or an on-premises Exchange organization. +- Anonymous: Share with external, non-federated organizations and individuals with internet access. -To enter multiple values and overwrite any existing entries, use the following syntax: `Value1,Value2,...ValueN`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"Value1","Value2",..."ValueN"`. +You can use the following values for `SharingPolicyAction`: -To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. +- CalendarSharingFreeBusySimple: Share free/busy hours only +- CalendarSharingFreeBusyDetail: Share free/busy hours, subject and location +- CalendarSharingFreeBusyReviewer: Share free/busy hours, subject, location and the body of the message or calendar item +- ContactsSharing: Share contacts only -A domain doesn't include subdomains. You need to configure each subdomain separately. +You can specify multiple `'Domain: SharingPolicyAction'` values separated by commas, and you can specify multiple `SharingPolicyAction` values for the same domain separated by commas. For example, `'mail.contoso.com: CalendarSharingFreeBusySimple', 'mail.fabrikam.com: CalendarSharingFreeBusyDetail, ContactsSharing'`. ```yaml Type: MultiValuedProperty @@ -208,7 +210,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -222,12 +224,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SiteMailbox.md b/exchange/exchange-ps/exchange/Set-SiteMailbox.md index 77f68b1cb6..c9c67e224a 100644 --- a/exchange/exchange-ps/exchange/Set-SiteMailbox.md +++ b/exchange/exchange-ps/exchange/Set-SiteMailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-sitemailbox +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SiteMailbox schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Set-SiteMailbox ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. Use the Set-SiteMailbox cmdlet to change a site mailbox's settings, such as the Microsoft SharePoint URL. This cmdlet is primarily used by the SharePoint and Microsoft Exchange user interfaces, such as the SharePoint URL. This cmdlet should only be used for diagnostic and troubleshooting purposes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ Set-SiteMailbox [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -74,7 +74,7 @@ The Identity parameter specifies the identity of the site mailbox. You can use a Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -90,7 +90,7 @@ The Active parameter specifies whether to change the site mailbox's lifecycle st Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -109,7 +109,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -125,7 +125,7 @@ The DisplayName parameter specifies the display name of the site mailbox. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -135,8 +135,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -153,13 +151,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -188,7 +188,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -217,7 +217,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: RecipientIdParameter[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -233,7 +233,7 @@ The RemoveDuplicateMessages parameter specifies that when users post messages to Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -249,7 +249,7 @@ The SharePointUrl parameter specifies the URL of the SharePoint site, for exampl Type: Uri Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -267,7 +267,7 @@ The ShowInMyClient parameter specifies that the site mailbox folder will show in Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -286,7 +286,7 @@ The SyncEnabled parameter specifies whether to enable or disable synchronization Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -302,7 +302,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,12 +316,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md b/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md index b34b21c6fc..460a831c41 100644 --- a/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md +++ b/exchange/exchange-ps/exchange/Set-SiteMailboxProvisioningPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-sitemailboxprovisioningpolicy -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-sitemailboxprovisioningpolicy +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SiteMailboxProvisioningPolicy schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Set-SiteMailboxProvisioningPolicy ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. Use the Set-SiteMailboxProvisioningPolicy cmdlet to modify an existing site mailbox provisioning policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,7 +40,7 @@ Set-SiteMailboxProvisioningPolicy [-Identity] ## DESCRIPTION Site mailbox provisioning policies apply settings to new site mailboxes that you create. You can create multiple site mailbox provisioning policies, but only the default policy is followed when users create site mailboxes. The default site mailbox provisioning policy is named Default. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -78,7 +78,7 @@ The Identity parameter specifies the identity of the site mailbox provisioning p Type: MailboxPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -97,7 +97,7 @@ The AliasPrefix parameter specifies the custom text prefix to add to the aliases Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,7 +116,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -137,7 +137,7 @@ The value of this parameter is related to the value of the AliasPrefix parameter Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -147,8 +147,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -165,8 +163,6 @@ Accept wildcard characters: False ``` ### -IsDefault -This parameter is available only in on-premises Exchange. - The IsDefault switch specifies that the site mailbox provisioning policy is the default policy. You don't need to specify a value with this switch. You can have multiple policies, but only the default policy is followed when users create site mailboxes. @@ -185,8 +181,6 @@ Accept wildcard characters: False ``` ### -IssueWarningQuota -This parameter is available only in on-premises Exchange. - The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox. If the mailbox reaches or exceeds this size, the user receives a descriptive warning message. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -217,8 +211,6 @@ Accept wildcard characters: False ``` ### -MaxReceiveSize -This parameter is available only in on-premises Exchange. - The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the site mailbox. Messages larger than the maximum size are rejected. When you enter a value, qualify the value with one of the following units: @@ -246,8 +238,6 @@ Accept wildcard characters: False ``` ### -Name -This parameter is available only in on-premises Exchange. - The Name parameter specifies the unique name of the site mailbox provisioning policy. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). ```yaml @@ -264,8 +254,6 @@ Accept wildcard characters: False ``` ### -ProhibitSendReceiveQuota -This parameter is available only in on-premises Exchange. - The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox. A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. When you enter a number, you can qualify it with one of the following units: @@ -302,7 +290,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -316,12 +304,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SmimeConfig.md b/exchange/exchange-ps/exchange/Set-SmimeConfig.md index a9d77a923c..3b0f0fe2bb 100644 --- a/exchange/exchange-ps/exchange/Set-SmimeConfig.md +++ b/exchange/exchange-ps/exchange/Set-SmimeConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-smimeconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-smimeconfig applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-SmimeConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-SmimeConfig cmdlet to modify the S/MIME configuration for Outlook on the web (formerly known as Outlook Web App). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,6 +40,7 @@ Set-SmimeConfig [[-Identity] ] [-OWAIncludeCertificateChainAndRootCertificate ] [-OWAIncludeCertificateChainWithoutRootCertificate ] [-OWAIncludeSMIMECapabilitiesInMessage ] + [-OWANoSignOnReply ] [-OWAOnlyUseSmartCard ] [-OWASenderCertificateAttributesToDisplay ] [-OWASignedEmailCertificateInclusion ] @@ -55,7 +56,7 @@ Set-SmimeConfig [[-Identity] ] ## DESCRIPTION The Set-SmimeConfig cmdlet can change several important parameters than can reduce the overall level of message security. Review your organization's security policy before you make any changes. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -441,6 +442,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OWANoSignOnReply +This parameter is available only in the cloud-based service. + +{{ Fill OWANoSignOnReply Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OWAOnlyUseSmartCard The OWAOnlyUseSmartCard parameter specifies whether smartcard-based certificates are required for Outlook on the web message signing and decryption. Valid values are: @@ -556,7 +575,7 @@ The OWAUseKeyIdentifier parameter specifies whether a certificate's key identifi Valid input for this parameter is $true or $false. The default is $false. -By default, Outlook on the web encodes the asymmetrically encrypted token (sometimes called a lockbox) that's required to decrypt the rest of the message by indicating the issuer and serial number of each recipient's certificate. The issuer and serial number can then be used to locate the certificate and private key for decrypting the message. +By default, Outlook on the web encodes the asymmetrically encrypted token (sometimes called a Lockbox) that's required to decrypt the rest of the message by indicating the issuer and serial number of each recipient's certificate. The issuer and serial number can then be used to locate the certificate and private key for decrypting the message. This parameter causes the use of a certificate's key identifier when encoding the asymmetrically encrypted token. Because a key pair can be reused in new certificates, using the key identifier for encrypted email messages means that users need to keep only the most recent certificate and associated private key, rather than all old certificates. Because some email clients do not support finding certificates with a key identifier, Outlook on the web uses the issuer and serial number of each recipient's certificate by default. @@ -596,7 +615,7 @@ Accept wildcard characters: False ### -SMIMECertificateIssuingCA The SMIMECertificateIssuingCA parameter specifies the serialized certificate store (SST) that contains the Certificate Authority (CA) signing and intermediate certificate information. -You need to read the file to a byte-encoded object using the Get-Content cmdlet. For example: `-SMIMECertificateIssuingCA $([byte[]](Get-Content -Encoding byte -Path "C:\Temp\CACertificateSerializedStore.sst" -ReadCount 0)`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). Each certificate is checked, and if any certificates are expired, the operation will fail. @@ -634,12 +653,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md index 320d2515ab..ac5377657b 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewPolicyV2.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-supervisoryreviewpolicyv2 -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-supervisoryreviewpolicyv2 +applicable: Security & Compliance title: Set-SupervisoryReviewPolicyV2 schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-SupervisoryReviewPolicyV2 ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-SupervisoryReviewPolicyV2 cmdlet to modify supervisory review policies in the Microsoft 365 compliance center. +Use the Set-SupervisoryReviewPolicyV2 cmdlet to modify supervisory review policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -27,15 +27,19 @@ Set-SupervisoryReviewPolicyV2 [-Identity] [-Confirm] [-Enabled ] [-Force] + [-PolicyRBACScopes ] + [-PolicyTemplate ] + [-PreservationPeriodInDays ] [-RemoveReviewers ] [-RetentionPeriodInDays ] [-Reviewers ] + [-UserReportingWorkloads ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -59,7 +63,7 @@ The Identity parameter specifies the supervisory review policy that you want to Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -75,7 +79,7 @@ The AddReviewers parameter specifies the SMTP addresses of reviewers to add to t Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -91,7 +95,7 @@ The Comment parameter specifies an optional comment. If you specify a value that Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -110,7 +114,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -126,7 +130,7 @@ Accept wildcard characters: False Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -136,13 +140,63 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All)) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyTemplate +{{ Fill PolicyTemplate Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreservationPeriodInDays +{{ Fill PreservationPeriodInDays Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -158,7 +212,7 @@ The RemoveReviewers parameter specifies the SMTP addresses of reviewers to remov Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -174,7 +228,7 @@ The RetentionPeriodInDays parameter specifies the number of days that the messag Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -192,7 +246,23 @@ The reviewers that you specify with this parameter replace the existing reviewer Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserReportingWorkloads +{{ Fill UserReportingWorkloads Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -202,13 +272,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -222,12 +292,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md index 7820afe2e6..3b3c0210d9 100644 --- a/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md +++ b/exchange/exchange-ps/exchange/Set-SupervisoryReviewRule.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-supervisoryreviewrule -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-supervisoryreviewrule +applicable: Security & Compliance title: Set-SupervisoryReviewRule schema: 2.0.0 author: chrisda @@ -12,25 +12,43 @@ ms.reviewer: # Set-SupervisoryReviewRule ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Microsoft 365 compliance center. +Use the Set-SupervisoryReviewRule cmdlet to modify supervisory review rules in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-SupervisoryReviewRule [-Identity] + [-AdvancedRule ] + [-CcsiDataModelOperator ] [-Condition ] [-Confirm] + [-ContentContainsSensitiveInformation ] + [-ContentMatchesDataModel ] + [-ContentSources ] + [-DayXInsights ] + [-ExceptIfFrom ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRevieweeIs ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-From ] + [-IncludeAdaptiveScopes ] + [-InPurviewFilter ] + [-Ocr ] + [-PolicyRBACScopes ] [-SamplingRate ] + [-SentTo ] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -57,7 +75,7 @@ The Identity parameter specifies the supervisory review rule that you want to mo Type: ComplianceRuleIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -66,6 +84,38 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -AdvancedRule +{{ Fill AdvancedRule Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CcsiDataModelOperator +{{ Fill CcsiDataModelOperator Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Condition The Condition parameter specifies the conditions and exceptions for the rule. This parameter uses the following syntax: @@ -83,7 +133,7 @@ The Condition parameter specifies the conditions and exceptions for the rule. Th Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -102,7 +152,247 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentContainsSensitiveInformation +{{ Fill ContentContainsSensitiveInformation Description }} + +```yaml +Type: PswsHashtable[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentMatchesDataModel +{{ Fill ContentMatchesDataModel Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentSources +{{ Fill ContentSources Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DayXInsights +{{ Fill DayXInsights Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfFrom +{{ Fill ExceptIfFrom Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +{{ Fill ExceptIfRecipientDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRevieweeIs +{{ Fill ExceptIfRevieweeIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSenderDomainIs +{{ Fill ExceptIfSenderDomainIs Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +{{ Fill ExceptIfSentTo Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSubjectOrBodyContainsWords +{{ Fill ExceptIfSubjectOrBodyContainsWords Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -From +{{ Fill From Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: Default +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeAdaptiveScopes +{{ Fill IncludeAdaptiveScopes Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InPurviewFilter +{{ Fill InPurviewFilter Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ocr +{{ Fill Ocr Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyRBACScopes +{{ Fill PolicyRBACScopes Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -118,7 +408,23 @@ The SamplingRate parameter specifies the percentage of communications for review Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SentTo +{{ Fill SentTo Description }} + +```yaml +Type: MultiValuedProperty +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance Required: False Position: Named @@ -128,13 +434,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -148,12 +454,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SweepRule.md b/exchange/exchange-ps/exchange/Set-SweepRule.md index 26b0e3adbf..184a02c1af 100644 --- a/exchange/exchange-ps/exchange/Set-SweepRule.md +++ b/exchange/exchange-ps/exchange/Set-SweepRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-sweeprule +online version: https://learn.microsoft.com/powershell/module/exchange/set-sweeprule applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-SweepRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-SweepRule cmdlet to modify Sweep rules in mailboxes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ Set-SweepRule [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -161,6 +161,8 @@ Accept wildcard characters: False ``` ### -ExceptIfFlagged +This parameter is available only in on-premises Exchange. + The ExceptIfFlagged parameter specifies an exception for the Sweep rule that looks messages with a message flag applied. Valid values are: - $true: The rule action isn't applied to messages that have a message flag applied. @@ -184,7 +186,7 @@ The typical message flag values are: Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -194,6 +196,8 @@ Accept wildcard characters: False ``` ### -ExceptIfPinned +This parameter is available only in on-premises Exchange. + The PinMessage parameter specifies an exception for the Sweep rule that looks for pinned messages. Valid values are: - $true: The rule action isn't applied to messages that are pinned to the top of the Inbox. @@ -203,7 +207,7 @@ The PinMessage parameter specifies an exception for the Sweep rule that looks fo Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -427,12 +431,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-SystemMessage.md b/exchange/exchange-ps/exchange/Set-SystemMessage.md index ee4d0484b5..0cb1bfebec 100644 --- a/exchange/exchange-ps/exchange/Set-SystemMessage.md +++ b/exchange/exchange-ps/exchange/Set-SystemMessage.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-systemmessage +online version: https://learn.microsoft.com/powershell/module/exchange/set-systemmessage applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-SystemMessage schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-SystemMessage cmdlet to modify custom system messages. System messages are delivery status notifications (also known as DSNs, non-delivery reports, NDRs or bounce messages) and quota messages. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Set-SystemMessage [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -62,17 +62,17 @@ The Identity parameter specifies the custom system message that you want to modi The identity value of a system message uses one of these formats: - System messages for enhanced status codes: `Language\\DSNCode`. For example, `En\Internal\5.1.2` or `Ja\External\5.1.2`. -- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailBox`. +- System messages for quotas: `Language\QuotaMessageType`. For example, `En\ProhibitSendReceiveMailbox`. -Language: For the list of supported language codes, see [Supported languages for NDRs](https://docs.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). +\: For the list of supported language codes, see [Supported languages for NDRs](https://learn.microsoft.com/Exchange/mail-flow/non-delivery-reports-and-bounce-messages/ndr-procedures#supported-languages-for-ndrs). -DSNCode: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command Get-SystemMessage. To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. +\: Valid values are 4.x.y or 5.x.y where x and y are one to three digit numbers. To see the enhanced system codes that are currently used by custom system messages, run the command `Get-SystemMessage`. To generate a list of default enhanced status codes that are used by Exchange, run this command: `Get-SystemMessage -Original | Select-Object -Property Identity,DsnCode,Language,Text | ConvertTo-Html | Set-Content -Path "C:\My Documents\Default DSNs.html"`. -QuotaMessageType: Valid value are: +\: Valid value are: Mailbox size quotas: -- ProhibitSendReceiveMailBox: A mailbox exceeds its ProhibitSendReceiveQuota limit. +- ProhibitSendReceiveMailbox: A mailbox exceeds its ProhibitSendReceiveQuota limit. - ProhibitSendMailbox: A mailbox exceeds its ProhibitSendQuota limit. - WarningMailbox: A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. - WarningMailboxUnlimitedSize: A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured. @@ -201,9 +201,7 @@ The following HTML tags are available: - `` and `` (italic) - `
` (line break) - `

` and `

` (paragraph) -- `` and `` (hyperlink) - -You need to use single quotation marks (not double quotation marks) around the complete text string if you use the hyperlink tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). +- `` and `` (hyperlink). **Note**: You need to use single quotation marks (not double quotation marks) around the complete text string if you use this tag. Otherwise, you'll receive an error (because of the double quotation marks in the tag). Use the following escape codes for these special characters: @@ -250,12 +248,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md new file mode 100644 index 0000000000..65370a81b9 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicy.md @@ -0,0 +1,192 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-teamsprotectionpolicy +applicable: Exchange Online +title: Set-TeamsProtectionPolicy +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-TeamsProtectionPolicy + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-TeamsProtectionPolicy cmdlet to modify Microsoft Teams protection policies. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-TeamsProtectionPolicy [-Identity] + [-AdminDisplayName ] + [-Confirm] + [-HighConfidencePhishQuarantineTag ] + [-MalwareQuarantineTag ] + [-WhatIf] + [-ZapEnabled ] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-TeamsProtectionPolicy -Identity "Teams Protection Policy" -HighConfidencePhishQuarantineTag AdminOnlyWithNotifications +``` + +This example changes the quarantine policy that's used for high confidence phishing detections. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Teams protection policy that you want to modify. There's only one Teams protection policy in an organization named Teams Protection Policy. + +```yaml +Type: TeamsProtectionPolicyIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AdminDisplayName +The AdminDisplayName parameter specifies a description for the policy. If the value contains spaces, enclose the value in quotation marks ("). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighConfidencePhishQuarantineTag +The HighConfidencePhishQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as high confidence phishing by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MalwareQuarantineTag +The MalwareQuarantineTag parameter specifies the quarantine policy that's used for messages that are quarantined as malware by ZAP for Teams. You can use any value that uniquely identifies the quarantine policy. For example: + +- Name +- Distinguished name (DN) +- GUID + +Quarantine policies define what users are able to do to quarantined messages, and whether users receive quarantine notifications. For more information about quarantine policies, see [Quarantine policies](https://learn.microsoft.com/defender-office-365/quarantine-policies). + +If you don't use this parameter, the default quarantine policy that's used is named AdminOnlyAccessPolicy. For more information about this quarantine policy, see [Anatomy of a quarantine policy](https://learn.microsoft.com/defender-office-365/quarantine-policies#anatomy-of-a-quarantine-policy). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ZapEnabled +The ZapEnabled parameter specifies whether to enable zero-hour auto purge (ZAP) for malware and high confidence phishing messages in Teams messages. Valid values are: + +- $true: ZAP for malware and high confidence phishing messages in Teams is enabled. This is the default value. +- $false: ZAP for malware and high confidence phishing messages in Teams is disabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md new file mode 100644 index 0000000000..859d7e7ee7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Set-TeamsProtectionPolicyRule.md @@ -0,0 +1,279 @@ +--- +external help file: Microsoft.Exchange.TransportMailflow-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/set-teamsprotectionpolicyrule +applicable: Exchange Online +title: Set-TeamsProtectionPolicyRule +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Set-TeamsProtectionPolicyRule + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Set-TeamsProtectionPolicyRule cmdlet to modify Microsoft Teams protection policy rules. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Set-TeamsProtectionPolicyRule [-Identity] + [-Comments ] + [-Confirm] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] + [-WhatIf] + [] +``` + +## DESCRIPTION +> [!IMPORTANT] +> Different types of recipient exceptions use OR logic (the recipient must satisfy **any** of the specified exceptions). For more information, see [Configure ZAP for Teams protection in Defender for Office 365 Plan 2](https://learn.microsoft.com/defender-office-365/mdo-support-teams-about#configure-zap-for-teams-protection-in-defender-for-office-365-plan-2). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfRecipientDomainIs research.contoso.com +``` + +This example modifies the existing Teams protection policy rule by excluding recipients in the domain research.contoso.com from ZAP for Teams protection. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the Teams protection policy rule that you want to modify. There's only one Teams protection policy rule in an organization named Teams Protection Policy Rule. + +```yaml +Type: RuleIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Comments +The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfRecipientDomainIs +The ExceptIfRecipientDomainIs parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages with email addresses in the specified domains. + +To replace all existing domains with the values you specify, use the following syntax: `Domain1,Domain2,...DomainN`. + +To add domains without affecting other existing values, use the following syntax: + +`$DomainsAdd = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" | select -Expand ExceptIfRecipientDomainIs` + +`$DomainsAdd += "Domain1","Domain2",..."DomainN"` + +`Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfRecipientDomainIs $DomainsAdd` + +To remove domains without affecting other existing values, use the following syntax: + +- Run the following commands to see the existing list of values in order: + + `$x = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule"` + + `$d = [System.Collections.ArrayList]($x.ExceptIfRecipientDomainIs)` + + `$d` + + The first value in the list has the index number 0, the second has the index number 1, and so on. + +- Use the index number to specify the value to remove. For example, to remove the seventh value in the list, run the following commands: + + `$d.RemoveAt(6)` + + `Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfRecipientDomainIs $d` + +To empty the list, use the value $null for this parameter. + +```yaml +Type: Word[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentTo +The ExceptIfSentTo parameter specifies an exception to ZAP for Teams protection that looks for recipients of Teams messages. You can use any value that uniquely identifies the recipient. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To replace all existing recipients with the values you specify, use the following syntax: `"User1","User2",..."UserN"`. + +To add recipients without affecting other existing values, use the following syntax: + +`$UsersAdd = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" | select -Expand ExceptIfSentTo` + +`$UsersAdd += "User1","User2",..."UserN"` + +`Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfSentTo $UsersAdd` + +To remove recipients without affecting other existing values, use the following syntax: + +- Run the following commands to see the existing list of values in order: + + `$x = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule"` + + `$u = [System.Collections.ArrayList]($x.ExceptIfSentTo)` + + `$u` + + The first value in the list has the index number 0, the second has the index number 1, and so on. + +- Use the index number to specify the value to remove. For example, to remove the seventh value in the list, run the following commands: + + `$u.RemoveAt(6)` + + `Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfSentTo $u` + +To empty the list, use the value $null for this parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExceptIfSentToMemberOf +The ExceptIfSentToMemberOf parameter specifies an exception to ZAP for Teams protection that looks for Teams messages sent to members of distribution groups or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: + +- Name +- Alias +- Distinguished name (DN) +- Canonical DN +- Email address +- GUID + +To add groups without affecting other existing values, use the following syntax: + +`$GroupsAdd = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" | select -Expand ExceptIfSentToMemberOf` + +`$GroupsAdd += "Group1","Group2",..."GroupN"` + +`Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfSentToMemberOf $GroupsAdd` + +To remove groups without affecting other existing values, use the following syntax: + +- Run the following commands to see the existing list of values in order: + + `$x = Get-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule"` + + `$g = [System.Collections.ArrayList]($x.ExceptIfSentToMemberOf)` + + `$g` + + The first value in the list has the index number 0, the second has the index number 1, and so on. + +- Use the index number to specify the value to remove. For example, to remove the seventh value in the list, run the following commands: + + `$g.RemoveAt(6)` + + `Set-TeamsProtectionPolicyRule -Identity "Teams Protection Policy Rule" -ExceptIfSentTo $g` + +If you remove the group after you create the rule, no exception is made for ZAP for Teams for messages that are sent to members of the group. + +To empty the list, use the value $null for this parameter. + +```yaml +Type: RecipientIdParameter[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md index 04e055d7dc..843a7d4d31 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListItems.md @@ -1,97 +1,96 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-tenantallowblocklistitems -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-tenantallowblocklistitems +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Set-TenantAllowBlockListItems schema: 2.0.0 author: chrisda ms.author: chrisda ms.reviewer: -ROBOTS: NOINDEX --- # Set-TenantAllowBlockListItems ## SYNOPSIS -**Note**: The features described in this topic are in Preview, are subject to change, and are not available in all organizations. - This cmdlet is available only in the cloud-based service. -Use the Set-TenantAllowBlockListItems cmdlet to modify entries in the Tenant Allow/Block List in the Microsoft 365 Defender portal. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +Use the Set-TenantAllowBlockListItems cmdlet to modify entries in the Tenant Allow/Block List in the Microsoft Defender portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### Expiration +### Ids (Default) ``` Set-TenantAllowBlockListItems -Ids -ListType + [-Allow] [-Block] [-ExpirationDate ] + [-ListSubType ] + [-NoExpiration] [-Notes ] [-OutputJson] + [-RemoveAfter ] [] ``` -### NoExpiration +### Entries ``` -Set-TenantAllowBlockListItems -Ids -ListType +Set-TenantAllowBlockListItems -Entries -ListType + [-Allow] [-Block] + [-ExpirationDate ] + [-ListSubType ] [-NoExpiration] [-Notes ] [-OutputJson] + [-RemoveAfter ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +In most cases, you can't modify the sender, URL, file, or IP address values after you create the entry. The only exception is URL allow entries for phishing simulations (ListType = URL, ListSubType = AdvancedDelivery). For more information about allowing URLs for phishing simulations, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). + +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-TenantAllowBlockListItems -ListType Url -Ids "RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSRAAAA" -ExpirationDate (Get-Date "5/30/2020 9:30 AM").ToUniversalTime() +Set-TenantAllowBlockListItems -ListType Url -Ids "RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSRAAAA" -ExpirationDate (Get-Date "5/30/2021 9:30 AM").ToUniversalTime() ``` This example changes the expiration date of the specified entry. -## PARAMETERS +### Example 2 +```powershell +Set-TenantAllowBlockListItems -ListType Url -ListSubType AdvancedDelivery -Entries *.fabrikam.com -ExpirationDate 9/11/2021 +``` -### -Block -The Block switch specifies that this is a block entry for the values you specified by the ListType and Entries parameters. You don't need to specify a value with this switch. +This example changes the expiration date of the URL allow entry for the specified third-party phishing simulation URL. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection +## PARAMETERS -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Entries +The Entries parameter specifies the entries that you want to modify based on the ListType parameter value. Valid values are: -### -ExpirationDate -The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). +- FileHash: The exact SHA256 file hash value. +- Sender domains and email addresses: The exact domain or email address value. +- Url: The exact URL value. +- IP: IPv6 addresses only. Single IPv6 addresses in colon-hexadecimal or zero-compression format or CIDR IPv6 ranges from 1 to 128. -To specify a date/time value for this parameter, use either of the following options: +This value is shown in the Value property of the entry in the output of the Get-TenantAllowBlockListItems cmdlet. -- Specify the date/time value in UTC: For example, `"2021-05-06 14:30:00z"`. -- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). +You can't mix value types (sender, URL, file, or IP address) or allow and block actions in the same command. -You can't use this parameter with the NoExpiration switch. +You can't use this parameter with the Ids parameter. ```yaml -Type: DateTime -Parameter Sets: Expiration -Aliases: -Applicable: Exchange Online, Exchange Online Protection +Type: String[] +Parameter Sets: Entries +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -99,17 +98,17 @@ Accept wildcard characters: False ``` ### -Ids -The Ids parameter specifies the entry that you want to modify. To find this value, use the Get-TenantAllowBlockListItems cmdlet and the Entry property value (a URL or a file hash). +The Ids parameter specifies the entries that you want to modify. This value is shown in the Identity property in the output of the Get-TenantAllowBlockListItems cmdlet. An example value for this parameter is `RgAAAAAI8gSyI_NmQqzeh-HXJBywBwCqfQNJY8hBTbdlKFkv6BcUAAAl_QCZAACqfQNJY8hBTbdlKFkv6BcUAAAl_oSPAAAA0`. -You can specify multiple values separated by commas. +You can't use this parameter with the Entries parameter. ```yaml Type: String[] -Parameter Sets: (All) +Parameter Sets: Ids Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -119,16 +118,20 @@ Accept wildcard characters: False ``` ### -ListType -The ListType parameter specifies the type of entry. Valid values are: +The ListType parameter specifies the type of entry that you want to modify. Valid values are: - FileHash +- Sender - Url +- IP + +Use the Entries or Ids parameter with this parameter to identify the entry itself. ```yaml Type: ListType Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -140,13 +143,19 @@ Accept wildcard characters: False ### -NoExpiration The NoExpiration switch specifies that the entry should never expire. You don't need to specify a value with this switch. +This switch is available to use with the following types of entries: + +- Block entries. +- URL allow entries where the ListSubType parameter value is AdvancedDelivery. +- IP address allow entries. + You can't use this switch with the ExpirationDate parameter. ```yaml Type: SwitchParameter -Parameter Sets: NoExpiration +Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: Named @@ -155,6 +164,80 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Allow +The Allow switch specifies that you're modifying an allow entry. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Block +The Block switch specifies that you're modifying a block entry. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExpirationDate +The ExpirationDate parameter filters the results by expiration date in Coordinated Universal Time (UTC). + +To specify a date/time value for this parameter, use either of the following options: + +- Specify the date/time value in UTC: For example, `"2021-05-06 14:30:00z"`. +- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2020 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date). + +You can't use this parameter with the NoExpiration or RemoveAfter parameters. + +```yaml +Type: DateTime +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ListSubType +The ListSubType parameter further specifies the entry that you want to modify. Valid values are: + +- AdvancedDelivery: Use this value for phishing simulation URLs. For more information, see [Configure the advanced delivery policy for third-party phishing simulations and email delivery to SecOps mailboxes](https://learn.microsoft.com/defender-office-365/advanced-delivery-policy-configure). +- Tenant: This is the default value. + +```yaml +Type: ListSubType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Notes The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks ("). @@ -162,7 +245,7 @@ The Notes parameters specifies additional information about the object. If the v Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -180,7 +263,29 @@ You use this switch to prevent the command from halting on the first entry that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Exchange Online Protection +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoveAfter +The RemoveAfter parameter enables the **Remove on** \> **45 days after last used date** feature for an allow entry. The LastUsedDate property is populated when the bad entity in the allow entry is encountered by the filtering system during mail flow or time of click. The allow entry is kept for 45 days after the filtering system determines that the entity is clean. + +The only valid value for this parameter is 45. + +You can't use this parameter with the ExpirationDate or NoExpirationDate parameters. + +To change the allow entry to a static expiration date/time value that doesn't depend on the LastUsedDate property, run a Set-TenantAllowBlockListItems command with the ExpirationDate parameter. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -194,12 +299,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md index 52a62254f3..e410aa39ca 100644 --- a/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md +++ b/exchange/exchange-ps/exchange/Set-TenantAllowBlockListSpoofItems.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-tenantallowblocklistspoofitems -applicable: Exchange Online, Exchange Online Protection +online version: https://learn.microsoft.com/powershell/module/exchange/set-tenantallowblocklistspoofitems +applicable: Exchange Online, Security & Compliance, Exchange Online Protection title: Set-TenantAllowBlockListSpoofItems schema: 2.0.0 author: chrisda @@ -14,11 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in the cloud-based service. -Use the Set-TenantAllowBlockListSpoofItems cmdlet to modify spoof entries in the Tenant Allow/Block List. +Use the Set-TenantAllowBlockListSpoofItems cmdlet to modify spoofed sender entries in the Tenant Allow/Block List. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,21 +30,22 @@ Set-TenantAllowBlockListSpoofItems [-Identity] - [] -``` - -### TeamAnalytics -``` -Set-TenantAnalyticsConfig -MinTeamSize -TeamAnalyticsEnabled - [-MinRecipients ] - [] -``` - -## DESCRIPTION -This cmdlet has been deprecated and no longer used. - -## EXAMPLES - -### Example 1 -```powershell -Set-TenantAnalyticsConfig -``` - -This cmdlet has been deprecated and no longer used. - -## PARAMETERS - -### -MinRecipients -This cmdlet has been deprecated and no longer used. - -```yaml -Type: Int32 -Parameter Sets: MyAnalytics -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -```yaml -Type: Int32 -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -MinTeamSize -This cmdlet has been deprecated and no longer used. - -```yaml -Type: Int32 -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamAnalyticsEnabled -This cmdlet has been deprecated and no longer used. - -```yaml -Type: Boolean -Parameter Sets: TeamAnalytics -Aliases: -Applicable: Exchange 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/p/?LinkID=113216). - -## INPUTS - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md b/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md index 2c8883cabc..57563a2af1 100644 --- a/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md +++ b/exchange/exchange-ps/exchange/Set-TextMessagingAccount.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-textmessagingaccount +online version: https://learn.microsoft.com/powershell/module/exchange/set-textmessagingaccount applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-TextMessagingAccount schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. The Set-TextMessagingAccount cmdlet allows a user to configure the text messaging settings on their own mailbox. An administrator can't use this cmdlet to configure the text messaging settings on another user's mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ When text messaging notifications are enabled on a mailbox, you can configure ca To clear the text messaging settings from your own mailbox, use the Clear-TextMessagingAccount parameter. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -104,7 +104,7 @@ Accept wildcard characters: False ``` ### -CountryRegionId -The CountryRegionId parameter specifies the country that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): +The CountryRegionId parameter specifies the country/region that your mobile phone is registered in. Although this parameter accepts any valid ISO 3166-1 two-letter country code value (for example, AU for Australia), the following values correspond to the country/region selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): - US - CA @@ -144,9 +144,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -165,7 +165,7 @@ Accept wildcard characters: False ``` ### -MobileOperatorId -The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country and mobile operator selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): +The MobileOperatorId parameter specifies the mobile operator (carrier) for your phone. Although this parameter accepts any random number, the following values correspond to the country/region and mobile operator selections that are available in the text messaging settings in Outlook on the web (formerly known as Outlook Web App): United States: @@ -233,12 +233,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md index eb1b3c074c..aec6333325 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-throttlingpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-throttlingpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ThrottlingPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-ThrottlingPolicy cmdlet to modify the settings for a user throttling policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -173,17 +173,18 @@ Set-ThrottlingPolicy [-Identity] ## DESCRIPTION Throttling policy settings are stored in Active Directory. -By default, there is one default user throttling policy named GlobalThrottlingPolicy with a throttling scope of Global. Exchange Setup creates this policy as part of the Client Access server role. You shouldn't replace, re-create, or remove the existing default throttling policy. However, you can edit any additional throttling policies with the scope of Organization or Regular if you want to change your user throttling settings. You can create polices with the scope of Organization or Regular using the New-ThrottlingPolicy cmdlet. +By default, there is one default user throttling policy named GlobalThrottlingPolicy with a throttling scope of Global. Exchange Setup creates this policy as part of the Client Access server role. You shouldn't replace, re-create, or remove the existing default throttling policy. However, you can edit any additional throttling policies with the scope of Organization or Regular if you want to change your user throttling settings. You can create policies with the scope of Organization or Regular using the New-ThrottlingPolicy cmdlet. -For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). +For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $a = Get-ThrottlingPolicy RemoteSiteUserPolicy + $a | Set-ThrottlingPolicy -EwsMaxConcurrency 4 ``` @@ -651,7 +652,7 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxKeywords -The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://docs.microsoft.com/powershell/module/exchange/search-mailbox). +The DiscoveryMaxKeywords parameter specifies the maximum number of keywords that a user can include in a discovery search. For more information, see [Search-Mailbox](https://learn.microsoft.com/powershell/module/exchange/search-mailbox). ```yaml Type: Unlimited @@ -747,7 +748,7 @@ Accept wildcard characters: False ``` ### -DiscoveryMaxStatsSearchMailboxes -The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). +The DiscoveryMaxStatsSearchMailboxes parameter specifies the maximum number of mailboxes that a user can search in an In-Place eDiscovery search without being able to view the statistics. When the number of mailboxes configured with the DiscoveryMaxStatsSearchMailboxes parameter is exceeded, the user must copy the search results to a discovery mailbox to view the statistics for the discovery search. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). ```yaml Type: Unlimited @@ -1311,7 +1312,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -1461,13 +1464,11 @@ Accept wildcard characters: False ``` ### -IsServiceAccount -The IsServiceAccount switch specifies whether you want the user accounts associated with this policy to be moderated by the per-user thresholds specified by this policy, and also by additional throttling based on the health of system resources, such as overall CPU usage. - -This value is set to $false by default. +The IsServiceAccount switch specifies that the user accounts associated with this policy are moderated by per-user thresholds and the health of system resources (for example, overall CPU usage). You don't need to specify a value with this switch. -You may want to set this value to $true if you intend to associate this policy with user accounts that require higher throttling limits. An account that might require higher throttling limits is a service account that performs a lot of non-interactive work (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). +You might want to use this switch if you intend to associate this policy with user accounts that require higher throttling limits (for example, service accounts that perform IMAP mailbox migrations or nightly Windows PowerShell tasks). -By setting the IsServiceAccount switch to $true, work done by these accounts is moderated by the higher user throttling settings that you configure using the user throttling policy, but is slowed if resources start getting unhealthy. +By using this switch, work done by these accounts is moderated by the higher user throttling settings that you configure using the user throttling policy, but is slowed if resources start getting unhealthy. ```yaml Type: SwitchParameter @@ -2610,7 +2611,7 @@ The ThrottlingPolicyScope parameter specifies the scope of the throttling policy - Organization: This scope specifies a custom policy that applies to all users in your organization. - Global: This scope is reserved for the default throttling policy. -For more information about throttling policy scopes, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). +For more information about throttling policy scopes, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). ```yaml Type: ThrottlingPolicyScopeType @@ -2646,12 +2647,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md index 4db1bed11f..7179fe0d72 100644 --- a/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md +++ b/exchange/exchange-ps/exchange/Set-ThrottlingPolicyAssociation.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-throttlingpolicyassociation +online version: https://learn.microsoft.com/powershell/module/exchange/set-throttlingpolicyassociation applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-ThrottlingPolicyAssociation schema: 2.0.0 @@ -14,7 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available only in on-premises Exchange. -Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact or a computer account. +Use the Set-ThrottlingPolicyAssociation cmdlet to associate a throttling policy with a specific object. The object can be a user with a mailbox, a user without a mailbox, a contact, or a computer account. + +**Note**: Some parameters in the throttling policy (for example, MessageRateLimit) apply only to objects that have mailbox GUIDs (mailboxes or remote mailboxes) and don't apply to mail users. And, if you want to apply throttling policy to a remote mailbox, first populate the remote mailbox with an ExchangeGUID by using Set-RemoteMailbox -ExchangeGUID. For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). @@ -34,9 +36,9 @@ The Set-ThrottlingPolicyAssociation cmdlet defines quota limits for specific obj In data center deployments, the object referred to by the Identity and ThrottlingPolicy parameters must be in the same tenant. -For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://docs.microsoft.com/Exchange/server-health/workload-management). +For more information about how to control the resources consumed by individual users, see [User workload management in Exchange Server](https://learn.microsoft.com/Exchange/server-health/workload-management). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run the Set-ThrottlingPolicyAssociation cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,10 +52,11 @@ This example associates a user with a username of tonysmith to the throttling po ### Example 2 ```powershell $b = Get-ThrottlingPolicy ITStaffPolicy + Set-Mailbox -Identity tonysmith -ThrottlingPolicy $b ``` -You don't need to use the Set-ThrottlingPolicyAssociation cmdlet to associate a user with a policy. The following commands show another way to associate tonysmith to the throttling policy ITStaffPolicy. +You don't need to use the Set-ThrottlingPolicyAssociation cmdlet to associate a user with a policy. The following commands show another way to associate tonysmith with the throttling policy ITStaffPolicy. ## PARAMETERS @@ -111,7 +114,7 @@ Accept wildcard characters: False ``` ### -ThrottlingPolicy -The ThrottlingPolicy parameter specifies the throttling policy that you want to be associated with the object specified by the Identity parameter. +The ThrottlingPolicy parameter specifies the throttling policy that you want the object specified by the Identity parameter to be associated with. ```yaml Type: ThrottlingPolicyIdParameter @@ -147,12 +150,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-TransportAgent.md b/exchange/exchange-ps/exchange/Set-TransportAgent.md index c2b3f08b12..65fa73a458 100644 --- a/exchange/exchange-ps/exchange/Set-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Set-TransportAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-transportagent +online version: https://learn.microsoft.com/powershell/module/exchange/set-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-TransportAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-TransportAgent cmdlet to modify existing transport agents. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,13 +31,13 @@ Set-TransportAgent [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Set-TransportAgent "Test App" -Priority 3 -TransportService -FrontEnd +Set-TransportAgent "Test App" -Priority 3 -TransportService FrontEnd ``` This example modifies the priority of a fictitious agent named Test App in the Front End Transport service. @@ -156,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-TransportConfig.md b/exchange/exchange-ps/exchange/Set-TransportConfig.md index f4980c1dbf..57473281ff 100644 --- a/exchange/exchange-ps/exchange/Set-TransportConfig.md +++ b/exchange/exchange-ps/exchange/Set-TransportConfig.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-transportconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-transportconfig applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Set-TransportConfig schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-TransportConfig cmdlet to modify the transport configuration settings for the whole Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,6 +25,7 @@ Set-TransportConfig [[-Identity] ] [-AddressBookPolicyRoutingEnabled ] [-AgentGeneratedMessageLoopDetectionInSmtpEnabled ] [-AgentGeneratedMessageLoopDetectionInSubmissionEnabled ] + [-AllowLegacyTLSClients ] [-ClearCategories ] [-Confirm] [-ConvertDisclaimerWrapperToEml ] @@ -60,8 +61,14 @@ Set-TransportConfig [[-Identity] ] [-MaxRetriesForLocalSiteShadow ] [-MaxRetriesForRemoteSiteShadow ] [-MaxSendSize ] + [-MessageExpiration ] + [-PreventDuplicateJournalingEnabled ] [-QueueDiagnosticsAggregationInterval ] [-RejectMessageOnShadowFailure ] + [-ReplyAllStormBlockDurationHours ] + [-ReplyAllStormDetectionMinimumRecipients ] + [-ReplyAllStormDetectionMinimumReplies ] + [-ReplyAllStormProtectionEnabled ] [-Rfc2231EncodingEnabled ] [-SafetyNetHoldTime ] [-ShadowHeartbeatFrequency ] @@ -84,7 +91,7 @@ Set-TransportConfig [[-Identity] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -102,7 +109,7 @@ Set-TransportConfig -JournalingReportNdrTo journalingndr@contoso.com This example configures the Exchange organization to redirect all journaling reports that can't be delivered to the journaling mailbox to the email account journalingndr@contoso.com. -To avoid journaling issues, we recommend that you set JournalingReportNdrTo to a dedicated mailbox without any transport rule or mailbox rule. Or, set JournalingReportNdrTo to an external address. In Exchange Online, you can configure this setting by using the Microsoft 365 admin center or Exchange Online PowerShell. In on-premises Exchange Server, you can configure this setting by using the Exchange Management Shell. For more information, see [KB2829319](https://support.microsoft.com/help/2829319). +To avoid journaling issues, we recommend that you set JournalingReportNdrTo to an external address. Like the journaling mailbox, the alternate journaling mailbox can't be an Exchange Online mailbox. In Exchange Online, you can configure this setting by using the Microsoft 365 admin center or Exchange Online PowerShell. In on-premises Exchange Server, you can configure this setting by using the Exchange Management Shell. For more information, see [KB2829319](https://support.microsoft.com/help/2829319). ## PARAMETERS @@ -127,7 +134,7 @@ Accept wildcard characters: False ### -AddressBookPolicyRoutingEnabled The AddressBookPolicyRoutingEnabled parameter controls how recipients are resolved in an organization that uses address book policies to create separate virtual organizations within the same Exchange organization. Specifically, the global address list (GAL) that's specified in the user's address book policy controls how recipients are resolved. When the value of this parameter is $true, users that are assigned different GALs appear as external recipients. When the value of this parameter is $false, users that are assigned different GALs appear as internal recipients. -The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see [Address book policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). +The default value is $false. Note that this parameter has no effect if your organization doesn't use address book policies, or if the address book policy routing agent isn't installed and enabled. Also note that changing the value of this parameter may take up to 30 minutes to take effect. For more information about address book policies, see [Address book policies in Exchange Server](https://learn.microsoft.com/Exchange/email-addresses-and-address-books/address-book-policies/address-book-policies). ```yaml Type: Boolean @@ -186,6 +193,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowLegacyTLSClients +This parameter is available only in the cloud-based service. + +{{ Fill AllowLegacyTLSClients Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ClearCategories The ClearCategories parameter keeps or removes Microsoft Outlook message categories during content conversion. Valid input for this parameter is $true or $false. The default value is $true. This means that by default, Outlook message categories are removed during content conversion. @@ -284,12 +309,14 @@ Accept wildcard characters: False ``` ### -DSNConversionMode -The DSNConversionMode parameter controls how Exchange handles delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) that are generated by earlier versions of Exchange or other messaging systems. Valid values are: +The DSNConversionMode parameter controls how Exchange handles delivery status notifications (also known as DSNs, non-delivery reports, NDRs, or bounce messages) that are generated by earlier versions of Exchange or other email systems. Valid values are: - DoNotConvert: DSNs aren't modified. The DSN is delivered as a standard message. -- PreserveDSNBody: DSNs are converted to the Exchange 2010 or later format, and the text in the body of the DSN message is retained. This is the default value. +- PreserveDSNBody: DSNs are converted to the Exchange 2010 or later format, and the text in the body of the DSN message is retained. - UseExchangeDSNs: DSNs are converted to the Exchange 2010 or later format. However, any customized text or attachments that were associated with the original DSN are overwritten. +The default value in Exchange 2010 and Exchange 2013 is UseExchangeDSNs. Otherwise, the default value is PreserveDSNBody. + ```yaml Type: DSNConversionOption Parameter Sets: (All) @@ -443,7 +470,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -668,7 +697,7 @@ Accept wildcard characters: False ``` ### -JournalingReportNdrTo -The JournalingReportNdrTo parameter specifies the email address to which journal reports are sent if the journaling mailbox is unavailable. By default, if this parameter is left empty, Exchange continues to try to deliver the journal report to the journaling mailbox. We recommended that you use a dedicated (non-user) mailbox as the value for this parameter. +The JournalingReportNdrTo parameter specifies the email address to which journal reports are sent if the journaling mailbox is unavailable. By default, if this parameter is left empty, Exchange continues to try to deliver the journal report to the journaling mailbox. We recommended that you use a dedicated (non-user) mailbox as the value for this parameter. Like the journaling mailbox, the alternate journaling mailbox can't be an Exchange Online mailbox. ```yaml Type: SmtpAddress @@ -744,7 +773,7 @@ Accept wildcard characters: False ### -MaxDumpsterSizePerDatabase This parameter is available only in on-premises Exchange. -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The MaxDumpsterSizePerDatabase parameter specifies the maximum size of the transport dumpster on a Hub Transport server for each database. The default value is 18 MB. The valid input range for this parameter is from 0 through 2147483647 KB. @@ -778,7 +807,7 @@ Accept wildcard characters: False ### -MaxDumpsterTime This parameter is available only in on-premises Exchange. -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The MaxDumpsterTime parameter specifies how long an email message should remain in the transport dumpster on a Hub Transport server. The default value is seven days. @@ -841,7 +870,7 @@ The MaxRecipientEnvelopeLimit parameter specifies the maximum number of recipien In on-premises Exchange, the default value is 500. The valid input range for this parameter is from 0 through 2147483647. If you enter a value of Unlimited, no limit is imposed on the number of recipients in a message. -In Exchange Online, the default value is Unlimited, which means the organizational limit of 1000 is used. You can enter a custom value up to 1000. For more information, see [Sending limits](https://docs.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1) in the Microsoft 365 service description. +In Exchange Online, the default value is Unlimited, which means the organizational limit of 1000 is used. You can enter a custom value up to 1000. For more information, see [Sending limits](https://learn.microsoft.com/office365/servicedescriptions/exchange-online-service-description/exchange-online-limits#sending-limits-1) in the Microsoft 365 service description. ```yaml Type: Unlimited @@ -937,6 +966,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessageExpiration +This parameter is available only in the cloud-based service. + +The MessageExpiration parameter specifies the message expiration timeout interval for the organization. + +To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. + +The default value is 1.00:00:00 or 1 day. + +A valid value is from 12 hours (0.12:00:00) to 24 hours (1.00:00:00). + +Queued messages typically expire after 24 hours, resulting in an NDR for failed delivery. If you change this value, the NDR will be sent at the new applicable time. + +```yaml +Type: EnhancedTimeSpan +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PreventDuplicateJournalingEnabled +This parameter is available only in the cloud-based service. + +The PreventDuplicateJournalingEnabled parameter prevents duplicate journaling reports that can occur when messages are processed by both on-premises and cloud journaling agents. Valid values are: + +- $true: Ensure that journaling messages aren't duplicated in hybrid environments. +- $false: Journaling messages might be duplicated in hybrid environments. This is the default value. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -QueueDiagnosticsAggregationInterval This parameter is available only in on-premises Exchange. @@ -980,6 +1056,78 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReplyAllStormBlockDurationHours +This parameter is available only in the cloud-based service. + +{{ Fill ReplyAllStormBlockDurationHours Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyAllStormDetectionMinimumRecipients +This parameter is available only in the cloud-based service. + +{{ Fill ReplyAllStormDetectionMinimumRecipients Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyAllStormDetectionMinimumReplies +This parameter is available only in the cloud-based service. + +{{ Fill ReplyAllStormDetectionMinimumReplies Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplyAllStormProtectionEnabled +This parameter is available only in the cloud-based service. + +{{ Fill ReplyAllStormProtectionEnabled Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Rfc2231EncodingEnabled The Rfc2231EncodingEnabled parameter specifies whether the RFC 2231 encoding of MIME parameters for outbound messages is enabled in your organization. Valid input for this parameter is $true or $false. The default value is $false. @@ -1043,7 +1191,7 @@ Accept wildcard characters: False ### -ShadowHeartbeatRetryCount This parameter is available only in on-premises Exchange. -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The ShadowHeartbeatRetryCount parameter specifies the number of time-outs a server waits before deciding that a primary server has failed and assumes ownership of shadow messages in the shadow queue for the primary server that's unreachable. Valid input for this parameter is an integer between 1 and 15. The default value is 12. @@ -1065,7 +1213,7 @@ Accept wildcard characters: False ### -ShadowHeartbeatTimeoutInterval This parameter is available only in on-premises Exchange. -This parameter isn't used by Microsoft Exchange Server 2016. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. +This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. The ShadowHeartbeatTimeoutInterval parameter specifies the amount of time a server waits before establishing a connection to a primary server to query the discard status of shadow messages. @@ -1287,7 +1435,7 @@ Accept wildcard characters: False ### -TransportRuleAttachmentTextScanLimit This parameter is available only in on-premises Exchange. -The TransportRuleAttachmentTextScanLimit parameter specifies the maximum size of text to extract from attachments for scanning by attachment scanning predicates in transport rules and data loss prevention (DLP) policies. The default value is 150 kilobytes (KB). +The TransportRuleAttachmentTextScanLimit parameter specifies the maximum size of text to extract from attachments for scanning by attachment scanning predicates in transport rules and data loss prevention (DLP) policies. When you enter a value, qualify the value with one of the following units: @@ -1298,6 +1446,8 @@ When you enter a value, qualify the value with one of the following units: Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte. +In Exchange Online, Exchange 2019, and Exchange 2016, the default value is 1 MB (1,048,576 bytes). In Exchange 2013, the default value is 150 KB (153,600 bytes). + If the amount of text in the attachment is larger than the value of this parameter, only the specified amount of text is scanned. For example, if a 5 megabyte attachment contains 300 kilobytes of text, and the value of TransportRuleAttachmentTextScanLimit is 150 kilobytes, only the first 150 kilobytes of text are extracted and scanned. ```yaml @@ -1336,7 +1486,7 @@ Accept wildcard characters: False ``` ### -VoicemailJournalingEnabled -This parameter is available or functional only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The VoicemailJournalingEnabled parameter specifies whether Unified Messaging voice mail messages are journaled by the Journaling agent. Valid input for this parameter is $true or $false. The default value is $true. @@ -1392,12 +1542,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-TransportRule.md b/exchange/exchange-ps/exchange/Set-TransportRule.md index 0b1d126621..d5e0d7dd39 100644 --- a/exchange/exchange-ps/exchange/Set-TransportRule.md +++ b/exchange/exchange-ps/exchange/Set-TransportRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-transportrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-transportrule applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-TransportRule schema: 2.0.0 @@ -16,9 +16,13 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-TransportRule cmdlet to modify existing transport rules (mail flow rules) in your organization. -If you delete all conditions and exceptions from a rule, the rule action is applied to all messages. This can have unintended consequences. For example, if the rule action is to delete the message, removing the conditions and exceptions could cause the rule to delete all inbound and outbound messages for the entire organization. +**Note**: -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +- The action of a rule without conditions or exceptions is applied to all messages, which could have unintended consequences. For example, if the rule action deletes messages, the rule without conditions or exceptions might delete all inbound and outbound messages for the entire organization. + +- Rules that use Active Directory or Microsoft Entra ID properties as conditions or exceptions work only on senders or recipients in the organization. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,15 +32,15 @@ Set-TransportRule [-Identity] [-ADComparisonAttribute ] [-ADComparisonOperator ] [-AddManagerAsRecipientType ] - [-AddToRecipients ] - [-AnyOfCcHeader ] - [-AnyOfCcHeaderMemberOf ] - [-AnyOfRecipientAddressContainsWords ] - [-AnyOfRecipientAddressMatchesPatterns ] - [-AnyOfToCcHeader ] - [-AnyOfToCcHeaderMemberOf ] - [-AnyOfToHeader ] - [-AnyOfToHeaderMemberOf ] + [-AddToRecipients ] + [-AnyOfCcHeader ] + [-AnyOfCcHeaderMemberOf ] + [-AnyOfRecipientAddressContainsWords ] + [-AnyOfRecipientAddressMatchesPatterns ] + [-AnyOfToCcHeader ] + [-AnyOfToCcHeaderMemberOf ] + [-AnyOfToHeader ] + [-AnyOfToHeaderMemberOf ] [-ApplyClassification ] [-ApplyHtmlDisclaimerFallbackAction ] [-ApplyHtmlDisclaimerLocation ] @@ -44,93 +48,93 @@ Set-TransportRule [-Identity] [-ApplyOME ] [-ApplyRightsProtectionCustomizationTemplate ] [-ApplyRightsProtectionTemplate ] - [-AttachmentContainsWords ] - [-AttachmentExtensionMatchesWords ] + [-AttachmentContainsWords ] + [-AttachmentExtensionMatchesWords ] [-AttachmentHasExecutableContent ] [-AttachmentIsPasswordProtected ] [-AttachmentIsUnsupported ] - [-AttachmentMatchesPatterns ] - [-AttachmentNameMatchesPatterns ] + [-AttachmentMatchesPatterns ] + [-AttachmentNameMatchesPatterns ] [-AttachmentProcessingLimitExceeded ] - [-AttachmentPropertyContainsWords ] + [-AttachmentPropertyContainsWords ] [-AttachmentSizeOver ] - [-BetweenMemberOf1 ] - [-BetweenMemberOf2 ] - [-BlindCopyTo ] + [-BetweenMemberOf1 ] + [-BetweenMemberOf2 ] + [-BlindCopyTo ] [-Comments ] [-Confirm] - [-ContentCharacterSetContainsWords ] - [-CopyTo ] + [-ContentCharacterSetContainsWords ] + [-CopyTo ] [-DeleteMessage ] [-Disconnect ] [-DlpPolicy ] [-DomainController ] [-ExceptIfADComparisonAttribute ] [-ExceptIfADComparisonOperator ] - [-ExceptIfAnyOfCcHeader ] - [-ExceptIfAnyOfCcHeaderMemberOf ] - [-ExceptIfAnyOfRecipientAddressContainsWords ] - [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] - [-ExceptIfAnyOfToCcHeader ] - [-ExceptIfAnyOfToCcHeaderMemberOf ] - [-ExceptIfAnyOfToHeader ] - [-ExceptIfAnyOfToHeaderMemberOf ] - [-ExceptIfAttachmentContainsWords ] - [-ExceptIfAttachmentExtensionMatchesWords ] + [-ExceptIfAnyOfCcHeader ] + [-ExceptIfAnyOfCcHeaderMemberOf ] + [-ExceptIfAnyOfRecipientAddressContainsWords ] + [-ExceptIfAnyOfRecipientAddressMatchesPatterns ] + [-ExceptIfAnyOfToCcHeader ] + [-ExceptIfAnyOfToCcHeaderMemberOf ] + [-ExceptIfAnyOfToHeader ] + [-ExceptIfAnyOfToHeaderMemberOf ] + [-ExceptIfAttachmentContainsWords ] + [-ExceptIfAttachmentExtensionMatchesWords ] [-ExceptIfAttachmentHasExecutableContent ] [-ExceptIfAttachmentIsPasswordProtected ] [-ExceptIfAttachmentIsUnsupported ] - [-ExceptIfAttachmentMatchesPatterns ] - [-ExceptIfAttachmentNameMatchesPatterns ] + [-ExceptIfAttachmentMatchesPatterns ] + [-ExceptIfAttachmentNameMatchesPatterns ] [-ExceptIfAttachmentProcessingLimitExceeded ] - [-ExceptIfAttachmentPropertyContainsWords ] + [-ExceptIfAttachmentPropertyContainsWords ] [-ExceptIfAttachmentSizeOver ] - [-ExceptIfBetweenMemberOf1 ] - [-ExceptIfBetweenMemberOf2 ] - [-ExceptIfContentCharacterSetContainsWords ] - [-ExceptIfFrom ] - [-ExceptIfFromAddressContainsWords ] - [-ExceptIfFromAddressMatchesPatterns ] - [-ExceptIfFromMemberOf ] + [-ExceptIfBetweenMemberOf1 ] + [-ExceptIfBetweenMemberOf2 ] + [-ExceptIfContentCharacterSetContainsWords ] + [-ExceptIfFrom ] + [-ExceptIfFromAddressContainsWords ] + [-ExceptIfFromAddressMatchesPatterns ] + [-ExceptIfFromMemberOf ] [-ExceptIfFromScope ] [-ExceptIfHasClassification ] [-ExceptIfHasNoClassification ] [-ExceptIfHasSenderOverride ] [-ExceptIfHeaderContainsMessageHeader ] - [-ExceptIfHeaderContainsWords ] + [-ExceptIfHeaderContainsWords ] [-ExceptIfHeaderMatchesMessageHeader ] - [-ExceptIfHeaderMatchesPatterns ] - [-ExceptIfManagerAddresses ] + [-ExceptIfHeaderMatchesPatterns ] + [-ExceptIfManagerAddresses ] [-ExceptIfManagerForEvaluatedUser ] - [-ExceptIfMessageContainsDataClassifications ] + [-ExceptIfMessageContainsDataClassifications ] [-ExceptIfMessageSizeOver ] [-ExceptIfMessageTypeMatches ] - [-ExceptIfRecipientADAttributeContainsWords ] - [-ExceptIfRecipientADAttributeMatchesPatterns ] - [-ExceptIfRecipientAddressContainsWords ] - [-ExceptIfRecipientAddressMatchesPatterns ] - [-ExceptIfRecipientDomainIs ] - [-ExceptIfRecipientInSenderList ] + [-ExceptIfRecipientADAttributeContainsWords ] + [-ExceptIfRecipientADAttributeMatchesPatterns ] + [-ExceptIfRecipientAddressContainsWords ] + [-ExceptIfRecipientAddressMatchesPatterns ] + [-ExceptIfRecipientDomainIs ] + [-ExceptIfRecipientInSenderList ] [-ExceptIfSCLOver ] - [-ExceptIfSenderADAttributeContainsWords ] - [-ExceptIfSenderADAttributeMatchesPatterns ] - [-ExceptIfSenderDomainIs ] - [-ExceptIfSenderInRecipientList ] + [-ExceptIfSenderADAttributeContainsWords ] + [-ExceptIfSenderADAttributeMatchesPatterns ] + [-ExceptIfSenderDomainIs ] + [-ExceptIfSenderInRecipientList ] [-ExceptIfSenderIpRanges ] [-ExceptIfSenderManagementRelationship ] - [-ExceptIfSentTo ] - [-ExceptIfSentToMemberOf ] + [-ExceptIfSentTo ] + [-ExceptIfSentToMemberOf ] [-ExceptIfSentToScope ] - [-ExceptIfSubjectContainsWords ] - [-ExceptIfSubjectMatchesPatterns ] - [-ExceptIfSubjectOrBodyContainsWords ] - [-ExceptIfSubjectOrBodyMatchesPatterns ] + [-ExceptIfSubjectContainsWords ] + [-ExceptIfSubjectMatchesPatterns ] + [-ExceptIfSubjectOrBodyContainsWords ] + [-ExceptIfSubjectOrBodyMatchesPatterns ] [-ExceptIfWithImportance ] [-ExpiryDate ] - [-From ] - [-FromAddressContainsWords ] - [-FromAddressMatchesPatterns ] - [-FromMemberOf ] + [-From ] + [-FromAddressContainsWords ] + [-FromAddressMatchesPatterns ] + [-FromMemberOf ] [-FromScope ] [-GenerateIncidentReport ] [-GenerateNotification ] @@ -138,52 +142,53 @@ Set-TransportRule [-Identity] [-HasNoClassification ] [-HasSenderOverride ] [-HeaderContainsMessageHeader ] - [-HeaderContainsWords ] + [-HeaderContainsWords ] [-HeaderMatchesMessageHeader ] - [-HeaderMatchesPatterns ] - [-IncidentReportContent ] + [-HeaderMatchesPatterns ] + [-IncidentReportContent ] [-IncidentReportOriginalMail ] [-LogEventText ] - [-ManagerAddresses ] + [-ManagerAddresses ] [-ManagerForEvaluatedUser ] - [-MessageContainsDataClassifications ] + [-MessageContainsDataClassifications ] [-MessageSizeOver ] [-MessageTypeMatches ] [-Mode ] [-ModerateMessageByManager ] - [-ModerateMessageByUser ] + [-ModerateMessageByUser ] [-Name ] [-NotifySender ] [-PrependSubject ] [-Priority ] [-Quarantine ] - [-RecipientADAttributeContainsWords ] - [-RecipientADAttributeMatchesPatterns ] - [-RecipientAddressContainsWords ] - [-RecipientAddressMatchesPatterns ] + [-RecipientADAttributeContainsWords ] + [-RecipientADAttributeMatchesPatterns ] + [-RecipientAddressContainsWords ] + [-RecipientAddressMatchesPatterns ] [-RecipientAddressType ] - [-RecipientDomainIs ] - [-RecipientInSenderList ] - [-RedirectMessageTo ] + [-RecipientDomainIs ] + [-RecipientInSenderList ] + [-RedirectMessageTo ] [-RejectMessageEnhancedStatusCode ] [-RejectMessageReasonText ] [-RemoveHeader ] [-RemoveOME ] [-RemoveOMEv2 ] + [-RemoveRMSAttachmentEncryption ] [-RouteMessageOutboundConnector ] [-RouteMessageOutboundRequireTls ] [-RuleErrorAction ] [-RuleSubType ] [-SCLOver ] - [-SenderADAttributeContainsWords ] - [-SenderADAttributeMatchesPatterns ] + [-SenderADAttributeContainsWords ] + [-SenderADAttributeMatchesPatterns ] [-SenderAddressLocation ] - [-SenderDomainIs ] - [-SenderInRecipientList ] + [-SenderDomainIs ] + [-SenderInRecipientList ] [-SenderIpRanges ] [-SenderManagementRelationship ] - [-SentTo ] - [-SentToMemberOf ] + [-SentTo ] + [-SentToMemberOf ] [-SentToScope ] [-SetAuditSeverity ] [-SetHeaderName ] @@ -192,10 +197,10 @@ Set-TransportRule [-Identity] [-SmtpRejectMessageRejectStatusCode ] [-SmtpRejectMessageRejectText ] [-StopRuleProcessing ] - [-SubjectContainsWords ] - [-SubjectMatchesPatterns ] - [-SubjectOrBodyContainsWords ] - [-SubjectOrBodyMatchesPatterns ] + [-SubjectContainsWords ] + [-SubjectMatchesPatterns ] + [-SubjectOrBodyContainsWords ] + [-SubjectOrBodyMatchesPatterns ] [-WhatIf] [-WithImportance ] [] @@ -206,7 +211,7 @@ In on-premises Exchange organizations, rules created on Mailbox servers are stor The search for words or text patterns in the subject or other header fields in the message occurs after the message has been decoded from the MIME content transfer encoding method that was used to transmit the binary message between SMTP servers in ASCII text. You can't use conditions or exceptions to search for the raw (typically, Base64) encoded values of the subject or other header fields in messages. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -217,8 +222,6 @@ Set-TransportRule "Sales Team Disclaimer" -FromMemberOf "Sales Department" This example modifies the existing rule named Sales Team Disclaimer transport rule by adding the condition that the sender of the message is a member of the Sales Department group. -This example sets the FromMemberOf parameter to a value of Sales-Group, which specifies that the rule is applied if the sender of the message is a member of the Sales-Group distribution group. - ## PARAMETERS ### -Identity @@ -244,7 +247,7 @@ Accept wildcard characters: False ### -ActivationDate The ActivationDate parameter specifies when the rule starts processing messages. The rule won't take any action on messages until the specified date/time. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -262,7 +265,7 @@ Accept wildcard characters: False ### -ADComparisonAttribute This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ADComparisonAttribute parameter specifies a condition that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. @@ -314,7 +317,7 @@ Accept wildcard characters: False ### -ADComparisonOperator This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ADComparisonOperator parameter specifies the comparison operator for the ADComparisonAttribute parameter. Valid values are: @@ -337,7 +340,7 @@ Accept wildcard characters: False ### -AddManagerAsRecipientType This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The AddManagerAsRecipientType parameter specifies an action that delivers or redirects messages to the user that's defined in the sender's Manager attribute. Valid values are: @@ -393,7 +396,7 @@ Accept wildcard characters: False ### -AnyOfCcHeader This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfCcHeader parameter specifies a condition that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: @@ -426,7 +429,7 @@ Accept wildcard characters: False ### -AnyOfCcHeaderMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfCcHeaderMemberOf parameter specifies a condition that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. For example: @@ -507,7 +510,7 @@ Accept wildcard characters: False ### -AnyOfToCcHeader This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfToCcHeader parameter specifies a condition that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. For example: @@ -540,7 +543,7 @@ Accept wildcard characters: False ### -AnyOfToCcHeaderMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfToCcHeaderMemberOf parameter specifies a condition that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. For example: @@ -573,7 +576,7 @@ Accept wildcard characters: False ### -AnyOfToHeader This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfToHeader parameter specifies a condition that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. For example: @@ -606,7 +609,7 @@ Accept wildcard characters: False ### -AnyOfToHeaderMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AnyOfToHeaderMemberOf parameter specifies a condition that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. For example: @@ -639,7 +642,7 @@ Accept wildcard characters: False ### -ApplyClassification This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ApplyClassification parameter specifies an action that applies a message classification to messages. Use the Get-MessageClassification cmdlet to see the message classification objects that are available. @@ -661,13 +664,20 @@ Accept wildcard characters: False ### -ApplyHtmlDisclaimerFallbackAction This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. + +The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be applied to a message (for example, encrypted or signed messages where the contents can't be altered). Valid values are: -The ApplyHtmlDisclaimerFallbackAction parameter specifies what to do if the HTML disclaimer can't be added to a message. Valid values are: +- Wrap: This is the default value. A new message is created and the original message is added to it as an attachment. The disclaimer text is added to the new message, which is delivered to the recipients. -- Wrap: The original message is wrapped in a new message envelope, and the disclaimer is used as the message body for the new message. This is the default value. Subsequent mail flow rules are applied to the new message envelope, not to the original message. Therefore, configure a rule with this action at a lower priority (a higher priority number) than other rules. If the original message can't be wrapped in a new message envelope, the original message isn't delivered. The message is returned to the sender in an non-delivery report (also known as an NDR or bounce message). -- Ignore: The rule is ignored and the message is delivered without the disclaimer. -- Reject: The message is rejected. + If you want other rules to examine and act on the original message (which is now an attachment in the new message), make sure those rules are applied _before_ the disclaimer rule by using a lower priority for the disclaimer rule and higher priority for other rules. + + If the process of inserting the original message as an attachment in the new message fails, the original message isn't delivered. The original message is returned to the sender in an NDR. + + In Microsoft 365, don't use this value in rules that affect incoming messages from external senders. Use the value Reject instead. The effects of the value Wrap interfere with Safe Attachments scanning of messages from external senders. + +- Ignore: The rule is ignored and the original message is delivered without the disclaimer. +- Reject: The original message is returned to the sender in an NDR. If you don't use this parameter with the ApplyHtmlDisclaimerText parameter, the default value Wrap is used. @@ -687,7 +697,7 @@ Accept wildcard characters: False ### -ApplyHtmlDisclaimerLocation This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ApplyHtmlDisclaimerLocation parameter specifies where to insert the HTML disclaimer text in the body of messages. Valid values are: @@ -712,10 +722,38 @@ Accept wildcard characters: False ### -ApplyHtmlDisclaimerText This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ApplyHtmlDisclaimerText parameter specifies an action that adds the disclaimer text to messages. Disclaimer text can include HTML tags and inline cascading style sheet (CSS) tags. You can add images using the IMG tag. +This parameter also supports the following tokens that use values from the sender: + +- %%City%% +- %%Company%% +- %%CountryOrRegion%% +- %%Department%% +- %%DisplayName%% +- %%Fax%% +- %%FirstName%% +- %%HomePhone%% +- %%Initials%% +- %%LastName%% +- %%Manager%% +- %%MobilePhone%% +- %%Notes%% +- %%Office%% +- %%Pager%% +- %%Phone%% +- %%PostalCode%% +- %%PostOfficeBox%% +- %%StateOrProvince%% +- %%StreetAddress%% +- %%Title%% +- %%UserPrincipalName%% +- %%WindowsEmailAddress%% + +The maximum number of characters is 5000. + You use the ApplyHtmlDisclaimerLocation parameter to specify where to insert the text in the message body (the default value is Append), and the ApplyHtmlDisclaimerFallbackAction parameter to specify what to do if the disclaimer can't be added to the message (the default value is Wrap). ```yaml @@ -777,7 +815,7 @@ Accept wildcard characters: False ### -ApplyRightsProtectionTemplate This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ApplyRightsProtectionTemplate parameter specifies an action that applies rights management service (RMS) templates to messages. You identify the RMS template by name. If the name contains spaces, enclose the name in quotation marks ("). @@ -785,7 +823,7 @@ To use this action, you need to have an Active Directory Rights Management Servi Use the Get-RMSTemplate cmdlet to see the RMS templates that are available. -For more information, see [Transport protection rules](https://docs.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). +For more information, see [Transport protection rules](https://learn.microsoft.com/exchange/transport-protection-rules-exchange-2013-help). ```yaml Type: RmsTemplateIdParameter @@ -803,7 +841,7 @@ Accept wildcard characters: False ### -AttachmentContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentContainsWords parameter specifies a condition that looks for words in message attachments. Only supported attachment types are checked. @@ -825,10 +863,12 @@ Accept wildcard characters: False ### -AttachmentExtensionMatchesWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentExtensionMatchesWords parameter specifies a condition that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. +**Note:** Nested attachment extensions (files inside the original attachments) are also inspected. To see all attachment extensions that were evaluated for a specific message, use the Test-TextExtraction cmdlet. + ```yaml Type: Word[] Parameter Sets: (All) @@ -845,13 +885,15 @@ Accept wildcard characters: False ### -AttachmentHasExecutableContent This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. -The AttachmentHasExecutableContent parameter specifies a condition that looks for executable content in message attachments. Valid values are: +The AttachmentHasExecutableContent parameter specifies a condition that inspects messages where an attachment is an executable file. Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + ```yaml Type: Boolean Parameter Sets: (All) @@ -868,9 +910,9 @@ Accept wildcard characters: False ### -AttachmentIsPasswordProtected This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. -The AttachmentIsPasswordProtected parameter specifies a condition that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The AttachmentIsPasswordProtected parameter specifies a condition that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z), and .pdf files. Valid values are: - $true: Look for password protected attachments. - $false: Don't look for password protected attachments. @@ -891,14 +933,18 @@ Accept wildcard characters: False ### -AttachmentIsUnsupported This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. -The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: +The AttachmentIsUnsupported parameter specifies a condition that looks for unsupported file types in messages. Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. -For more information, see [Register Filter Pack IFilters with Exchange 2013](https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the AttachmentIsUnsupported condition is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exchange 2010, to extend the list of supported file types, see [Register Filter Pack IFilters](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean @@ -916,7 +962,7 @@ Accept wildcard characters: False ### -AttachmentMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentMatchesPatterns parameter specifies a condition that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. @@ -940,7 +986,7 @@ Accept wildcard characters: False ### -AttachmentNameMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentNameMatchesPatterns parameter specifies a condition that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -960,7 +1006,7 @@ Accept wildcard characters: False ### -AttachmentProcessingLimitExceeded This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentProcessingLimitExceeded parameter specifies a condition that looks for messages where attachment scanning didn't complete. Valid values are: @@ -985,7 +1031,7 @@ Accept wildcard characters: False ### -AttachmentPropertyContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The AttachmentPropertyContainsWords parameter specifies a condition that looks for words in the properties of attached Office documents. This condition helps integrate mail flow rules (transport rules) with the File Classification Infrastructure (FCI) in Windows Server 2012 R2 or later, SharePoint, or a third-party classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: @@ -1056,7 +1102,7 @@ Accept wildcard characters: False ### -BetweenMemberOf1 This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The BetweenMemberOf1 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. For example: @@ -1085,7 +1131,7 @@ Accept wildcard characters: False ### -BetweenMemberOf2 This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The BetweenMemberOf2 parameter specifies a condition that looks for messages that are sent between group members. You need to use this parameter with the BetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. For example: @@ -1178,7 +1224,7 @@ Accept wildcard characters: False ### -ContentCharacterSetContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ContentCharacterSetContainsWords parameter specifies a condition that looks for character set names in messages. @@ -1250,7 +1296,7 @@ Accept wildcard characters: False ``` ### -Disconnect -This parameter is available or functional only on Edge Transport servers in on-premises Exchange. +This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -1273,7 +1319,9 @@ Accept wildcard characters: False ``` ### -DlpPolicy -The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). +**Note**: This parameter is functional only in on-premises Exchange. + +The DlpPolicy parameter specifies the data loss prevention (DLP) policy that's associated with the rule. Each DLP policy is enforced using a set of mail flow rules (transport rules). To learn more about DLP, see [Data loss prevention in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/data-loss-prevention). ```yaml Type: String @@ -1309,9 +1357,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonAttribute -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfADComparisonAttribute parameter specifies an exception that compares an Active Directory attribute between the sender and all recipients of the message. This parameter works when the recipients are individual users. This parameter doesn't work with distribution groups. @@ -1361,9 +1409,9 @@ Accept wildcard characters: False ``` ### -ExceptIfADComparisonOperator -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfADComparisonOperator parameter specifies the comparison operator for the ExceptIfADComparisonAttribute parameter. Valid values are: @@ -1384,9 +1432,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfCcHeader parameter specifies an exception that looks for recipients in the Cc field of messages. You can use any value that uniquely identifies the recipient. For example: @@ -1417,9 +1465,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfCcHeaderMemberOf parameter specifies an exception that looks for group members in the Cc field of messages. You can use any value that uniquely identifies the group. For example: @@ -1450,7 +1498,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1474,7 +1522,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1498,9 +1546,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfToCcHeader parameter specifies an exception that looks for recipients in the To or Cc fields of messages. You can use any value that uniquely identifies the recipient. For example: @@ -1531,9 +1579,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToCcHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfToCcHeaderMemberOf parameter specifies an exception that looks for group members in the To and Cc fields of messages. You can use any value that uniquely identifies the group. For example: @@ -1564,9 +1612,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfToHeader parameter specifies an exception that looks for recipients in the To field of messages. You can use any value that uniquely identifies the recipient. For example: @@ -1597,9 +1645,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAnyOfToHeaderMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAnyOfToHeaderMemberOf parameter specifies an exception that looks for group members in the To field of messages. You can use any value that uniquely identifies the group. For example: @@ -1630,9 +1678,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentContainsWords parameter specifies an exception that looks for words in message attachments. Only supported attachment types are checked. @@ -1652,12 +1700,14 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentExtensionMatchesWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentExtensionMatchesWords parameter specifies an exception that looks for words in the file name extensions of message attachments. You can specify multiple words separated by commas. +**Note:** Nested attachment extensions (files inside the original attachments) are also inspected. To see all attachment extensions that were evaluated for a specific message, use the Test-TextExtraction cmdlet. + ```yaml Type: Word[] Parameter Sets: (All) @@ -1672,15 +1722,17 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentHasExecutableContent -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that looks for executable content in message attachments. Valid values are: +The ExceptIfAttachmentHasExecutableContent parameter specifies an exception that inspects messages where an attachment is an executable file. Valid values are: - $true: Look for executable content in message attachments. - $false: Don't look for executable content in message attachments. +The system inspects the file properties rather than relying on the file extension. For more information, see [Supported executable file types for mail flow rule inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-executable-file-types-for-mail-flow-rule-inspection). + ```yaml Type: Boolean Parameter Sets: (All) @@ -1695,11 +1747,11 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsPasswordProtected -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection only works for Office documents and .zip files. Valid values are: +The ExceptIfAttachmentIsPasswordProtected parameter specifies an exception that looks for password protected files in messages (because the contents of the file can't be inspected). Password detection works for Office documents, compressed files (.zip, .7z), and .pdf files. Valid values are: - $true: Look for password protected attachments. - $false: Don't look for password protected attachments. @@ -1718,16 +1770,20 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentIsUnsupported -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Unsupported file types are message attachments that aren't natively recognized by Exchange, and the required IFilter isn't installed. Valid values are: +The ExceptIfAttachmentIsUnsupported parameter specifies an exception that looks for unsupported file types in messages. Valid values are: - $true: Look for unsupported file types in messages. - $false: Don't look for unsupported file types in messages. -For more information, see [Register Filter Pack IFilters with Exchange 2013](https://docs.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). +Rules can inspect the content of supported file types only. If the rule finds an attachment file type that isn't supported, the ExceptIfAttachmentIsUnsupported exception is triggered. + +For the list of supported file types, see [Supported file types for mail flow rule content inspection](https://learn.microsoft.com/exchange/security-and-compliance/mail-flow-rules/inspect-message-attachments#supported-file-types-for-mail-flow-rule-content-inspection). + +In Exchange 2010, to extend the list of supported file types, see [Register Filter Pack IFilters](https://learn.microsoft.com/exchange/register-filter-pack-ifilters-with-exchange-2013-exchange-2013-help). ```yaml Type: Boolean @@ -1743,9 +1799,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentMatchesPatterns parameter specifies an exception that looks for text patterns in the content of message attachments by using regular expressions. Only supported attachment types are checked. @@ -1767,9 +1823,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentNameMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentNameMatchesPatterns parameter specifies an exception that looks for text patterns in the file name of message attachments by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -1787,9 +1843,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentProcessingLimitExceeded -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentProcessingLimitExceeded parameter specifies an exception that looks for messages where attachment scanning didn't complete. Valid values are: @@ -1812,9 +1868,9 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentPropertyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfAttachmentPropertyContainsWords parameter specifies an exception that looks for words in the properties of attached Office documents. This condition helps integrate rules with the File Classification Infrastructure (FCI) in Windows Server 2018 R2 or later, SharePoint, or a third-party classification system. Valid values are a built-in document property, or a custom property. The built-in document properties are: @@ -1851,7 +1907,7 @@ Accept wildcard characters: False ``` ### -ExceptIfAttachmentSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -1881,9 +1937,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf1 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfBetweenMemberOf1 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf2 parameter. You can use any value that uniquely identifies the group. For example: @@ -1910,9 +1966,9 @@ Accept wildcard characters: False ``` ### -ExceptIfBetweenMemberOf2 -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfBetweenMemberOf2 parameter specifies an exception that looks for messages that are sent between group members. You need to use this parameter with the ExceptIfBetweenMemberOf1 parameter. You can use any value that uniquely identifies the group. For example: @@ -1939,9 +1995,9 @@ Accept wildcard characters: False ``` ### -ExceptIfContentCharacterSetContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfContentCharacterSetContainsWords parameter specifies an exception that looks for character set names in messages. @@ -1961,9 +2017,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFrom -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfFrom parameter specifies an exception that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: @@ -1992,7 +2048,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2014,7 +2070,7 @@ Accept wildcard characters: False ``` ### -ExceptIfFromAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2022,6 +2078,8 @@ The ExceptIfFromAddressMatchesPatterns parameter specifies an exception that loo You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). +**Note**: Trying to search for empty From addresses using this parameter doesn't work. + ```yaml Type: Pattern[] Parameter Sets: (All) @@ -2036,9 +2094,9 @@ Accept wildcard characters: False ``` ### -ExceptIfFromMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfFromMemberOf parameter specifies an exception that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: @@ -2067,13 +2125,13 @@ Accept wildcard characters: False ``` ### -ExceptIfFromScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfFromScope parameter specifies an exception that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -2090,9 +2148,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfHasClassification parameter specifies an exception that looks for messages with the specified message classification. @@ -2116,9 +2174,9 @@ Accept wildcard characters: False ``` ### -ExceptIfHasNoClassification -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfHasNoClassification parameter specifies an exception that looks for messages with or without any message classifications. Valid values are: @@ -2139,9 +2197,11 @@ Accept wildcard characters: False ``` ### -ExceptIfHasSenderOverride -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +**Note:** This parameter is functional only in on-premises Exchange. -In on-premises Exchange, this exception is only available on Mailbox servers. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. + +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfHasSenderOverride parameter specifies an exception that looks for messages where the sender chose to override a DLP policy. Valid values are: @@ -2162,7 +2222,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2182,7 +2242,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2206,7 +2266,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesMessageHeader -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2226,7 +2286,7 @@ Accept wildcard characters: False ``` ### -ExceptIfHeaderMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2248,9 +2308,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerAddresses -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. For example: @@ -2279,9 +2339,9 @@ Accept wildcard characters: False ``` ### -ExceptIfManagerForEvaluatedUser -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfManagerForEvaluatedUser parameter specifies an exception that looks for users in the Manager attribute of senders or recipients. Valid values are: @@ -2304,15 +2364,17 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageContainsDataClassifications -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +**Note:** This parameter is functional only in on-premises Exchange. + +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfMessageContainsDataClassifications parameter specifies an exception that looks for sensitive information types in the body of messages, and in any attachments. This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. -For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). +For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). ```yaml Type: Hashtable[] @@ -2328,7 +2390,7 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageSizeOver -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2358,17 +2420,17 @@ Accept wildcard characters: False ``` ### -ExceptIfMessageTypeMatches -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfMessageTypeMatches parameter specifies an exception that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). -- Encrypted: Encrypted messages. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this exception **will not** match during mail flow rule evaluation. +- Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. -- PermissionControlled: Messages that have specific permissions configured. +- PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). - Voicemail: Voice mail messages forwarded by Unified Messaging service. - Signed: Digitally signed messages. - ApprovalRequest: Moderation request messages sent to moderators. @@ -2388,9 +2450,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfRecipientADAttributeContainsWords parameter specifies an exception that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -2444,9 +2506,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfRecipientADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -2498,9 +2560,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfRecipientAddressContainsWords parameter specifies an exception that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -2518,9 +2580,9 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientAddressMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfRecipientAddressMatchesPatterns parameter specifies an exception that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -2540,13 +2602,13 @@ Accept wildcard characters: False ``` ### -ExceptIfRecipientDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. -The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the ExceptIfRecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". ```yaml Type: Word[] @@ -2580,11 +2642,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSCLOver -This parameter is available or functional only in on-premises Exchange. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. - -This condition is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSCLOver parameter specifies an exception that looks for the SCL value of messages. Valid values are: @@ -2607,9 +2667,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderADAttributeContainsWords parameter specifies an exception that looks for words in Active Directory attributes of message senders. @@ -2663,9 +2723,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderADAttributeMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderADAttributeMatchesPatterns parameter specifies an exception that looks for text patterns in Active Directory attributes of message senders by using regular expressions. @@ -2717,13 +2777,13 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderDomainIs -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderDomainIs parameter specifies an exception that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This exception matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -2759,9 +2819,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderIpRanges -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderIpRanges parameter specifies an exception that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: @@ -2771,6 +2831,8 @@ The ExceptIfSenderIpRanges parameter specifies an exception that looks for sende You can specify multiple values separated by commas. +In Exchange Online, the IP address that's used during evaluation of this exception is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -2785,9 +2847,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSenderManagementRelationship -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSenderManagementRelationship parameter specifies an exception that looks for the relationship between the sender and recipients in messages. Valid values are: @@ -2808,9 +2870,9 @@ Accept wildcard characters: False ``` ### -ExceptIfSentTo -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: @@ -2837,7 +2899,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToMemberOf -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of groups. You can use any value that uniquely identifies the group. For example: @@ -2864,16 +2926,16 @@ Accept wildcard characters: False ``` ### -ExceptIfSentToScope -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfSentToScope parameter specifies an exception that looks for the location of a recipient. Valid values are: -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. ```yaml Type: ToUserScope @@ -2889,13 +2951,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSubjectContainsWords parameter specifies an exception that looks for words in the Subject field of messages. -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. ```yaml Type: Word[] @@ -2911,7 +2975,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2931,13 +2995,15 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyContainsWords -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. The ExceptIfSubjectOrBodyContainsWords parameter specifies an exception that looks for words in the Subject field or body of messages. -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. ```yaml Type: Word[] @@ -2953,7 +3019,7 @@ Accept wildcard characters: False ``` ### -ExceptIfSubjectOrBodyMatchesPatterns -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. In on-premises Exchange, this exception is available on Mailbox servers and Edge Transport servers. @@ -2973,9 +3039,9 @@ Accept wildcard characters: False ``` ### -ExceptIfWithImportance -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. -In on-premises Exchange, this exception is only available on Mailbox servers. +In on-premises Exchange, this exception is available only on Mailbox servers. The ExceptIfWithImportance parameter specifies an exception that looks for messages with the specified importance level. Valid values are: @@ -2997,11 +3063,11 @@ Accept wildcard characters: False ``` ### -ExpiryDate -This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition doesn't include the ExceptIf prefix. +This parameter specifies an exception or part of an exception for the rule. The name of the corresponding condition parameter doesn't include the ExceptIf prefix. The ExpiryDate parameter specifies when this rule will stop processing messages. The rule won't take any action on messages after the specified date/time. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -3019,7 +3085,7 @@ Accept wildcard characters: False ### -From This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The From parameter specifies a condition that looks for messages from specific senders. You can use any value that uniquely identifies the sender. For example: @@ -3078,6 +3144,8 @@ The FromAddressMatchesPatterns parameter specifies a condition that looks for te You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). +**Note**: Trying to search for empty From addresses using this parameter doesn't work. + ```yaml Type: Pattern[] Parameter Sets: (All) @@ -3094,7 +3162,7 @@ Accept wildcard characters: False ### -FromMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The FromMemberOf parameter specifies a condition that looks for messages sent by group members. You can use any value that uniquely identifies the group. For example: @@ -3129,7 +3197,7 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The FromScope parameter specifies a condition that looks for the location of message senders. Valid values are: -- InOrganization: The sender is a mailbox, mail user, group, or mail-enabled public folder in your organization or The sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. +- InOrganization: The message was sent or received over an authenticated connection **AND** the sender meets at least one of the following criteria: The sender is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the sender's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. - NotInOrganization: The sender's email address isn't in an accepted domain or the sender's email address is in an accepted domain that's configured as an external relay domain. ```yaml @@ -3148,7 +3216,7 @@ Accept wildcard characters: False ### -GenerateIncidentReport This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The GenerateIncidentReport parameter specifies where to send the incident report that's defined by the IncidentReportContent parameter. You can use any value that uniquely identifies the recipient. For example: @@ -3159,7 +3227,7 @@ The GenerateIncidentReport parameter specifies where to send the incident report - Email address - GUID -An incident report is generated for messages that violate a DLP policy in your organization. +**Note**: An incident report isn't generated for notifications or other incident reports that are generated by DLP or mail flow rules. ```yaml Type: RecipientIdParameter @@ -3177,9 +3245,9 @@ Accept wildcard characters: False ### -GenerateNotification This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. -The GenerateNotification parameter specifies an action that sends a notification message to recipients. For example, you can use this parameter to notify recipients that a message was rejected by the rule, or marked as spam and delivered to their Junk Email folder. +The GenerateNotification parameter specifies an action that sends a notification message to recipients that match the conditions of the rule. For example, you can use this parameter to notify recipients that a message was rejected by the rule, or marked as spam and delivered to their Junk Email folder. Each matched recipient receives a separate notification. This parameter supports plain text, HTML tags and the following keywords that use values from the original message: @@ -3190,6 +3258,8 @@ This parameter supports plain text, HTML tags and the following keywords that us - %%Headers%% - %%MessageDate%% +The maximum number of characters is 5120. + ```yaml Type: DisclaimerText Parameter Sets: (All) @@ -3206,7 +3276,7 @@ Accept wildcard characters: False ### -HasClassification This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The HasClassification parameter specifies a condition that looks for messages with the specified message classification. @@ -3232,7 +3302,7 @@ Accept wildcard characters: False ### -HasNoClassification This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The HasNoClassification parameter specifies a condition that looks for messages with or without any message classifications. Valid values are: @@ -3253,9 +3323,11 @@ Accept wildcard characters: False ``` ### -HasSenderOverride +**Note:** This parameter is functional only in on-premises Exchange. + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The HasSenderOverride parameter specifies a condition that looks for messages where the sender chose to override a DLP policy. Valid values are: @@ -3364,9 +3436,9 @@ Accept wildcard characters: False ### -IncidentReportContent This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. -The IncidentReportContent parameter specifies the message properties that are included in the incident report that's generated when a message violates a DLP policy. Valid values are: +The IncidentReportContent parameter specifies the message properties that are included in the incident report. Valid values are: - Sender: The sender of the message. - Recipients: The recipients in the To field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. @@ -3374,10 +3446,8 @@ The IncidentReportContent parameter specifies the message properties that are in - CC: The recipients in the Cc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. - BCC: The recipients in the Bcc field of the message. Only the first 10 recipients are displayed in the incident report. If there are more than 10 recipients, the remaining number of recipients will be displayed. - Severity: The audit severity of the rule that was triggered. If the message was processed by more than one rule, the highest severity is displayed. -- Override: The override if the sender chose to override a PolicyTip. If the sender provided a justification, the first 100 characters of the justification is also included. - RuleDetections: The list of rules that the message triggered. - FalsePositive: The false positive if the sender marked the message as a false positive for a PolicyTip. -- DataClassifications: The list of sensitive information types that were detected in the message. - IdMatch: The sensitive information type that was detected, the exact matched content from the message, and the 150 characters before and after the matched sensitive information. - AttachOriginalMail: The entire original message as an attachment. @@ -3407,7 +3477,7 @@ This parameter has been deprecated and is no longer used. Use the IncidentReport This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The IncidentReportOriginalMail parameter specifies whether to include the original message with the incident report. This parameter is used together with the GenerateIncidentReport parameter. Valid values are: @@ -3428,7 +3498,7 @@ Accept wildcard characters: False ``` ### -LogEventText -This parameter is available or functional only on Edge Transport servers in on-premises Exchange. +This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -3458,7 +3528,7 @@ Accept wildcard characters: False ### -ManagerAddresses This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ManagerAddresses parameter specifies the users (managers) for the ExceptIfManagerForEvaluatedUser parameter. You can use any value that uniquely identifies the user. For example: @@ -3489,7 +3559,7 @@ Accept wildcard characters: False ### -ManagerForEvaluatedUser This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The ManagerForEvaluatedUser parameter specifies a condition that looks for users in the Manager attribute of senders or recipients. Valid values are: @@ -3512,15 +3582,17 @@ Accept wildcard characters: False ``` ### -MessageContainsDataClassifications +**Note:** This parameter is functional only in on-premises Exchange. + This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The MessageContainsDataClassifications parameter specifies a condition that looks for sensitive information types in the body of messages, and in any attachments. This parameter uses the syntax `@{SensitiveInformationType1},@{SensitiveInformationType2},...@{SensitiveInformationTypeN}`. For example, to look for content that contains at least two credit card numbers, and at least one ABA routing number, use the value @{Name="Credit Card Number"; minCount="2"},@{Name="ABA Routing Number"; minCount="1"}. -For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). +For a list of sensitive information types available, see [Sensitive information types in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/data-loss-prevention/sensitive-information-types). You can specify the notification options by using the NotifySender parameter. @@ -3570,15 +3642,15 @@ Accept wildcard characters: False ### -MessageTypeMatches This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The MessageTypeMatches parameter specifies a condition that looks for messages of the specified type. Valid values are: - OOF: Auto-reply messages configured by the user. -- AutoForward: Messages automatically forwarded to an alternative recipient (by Exchange, not by auto-forwarding rules that users configure in Outlook on the web or Outlook). -- Encrypted: Encrypted messages. +- AutoForward: Messages automatically forwarded to an alternative recipient. In Exchange Online, if the message has been forwarded using [mailbox forwarding](https://learn.microsoft.com/exchange/recipients-in-exchange-online/manage-user-mailboxes/configure-email-forwarding) (also known as SMTP forwarding), this condition **will not** match during mail flow rule evaluation. +- Encrypted: S/MIME encrypted messages. In thin clients like Outlook on the web, encryption as a message type is currently not supported. - Calendaring: Meeting requests and responses. -- PermissionControlled: Messages that have specific permissions configured. +- PermissionControlled: Messages that have specific permissions configured using Office 365 Message Encryption (OME), Rights Management, and sensitivity labels (with encryption). - Voicemail: Voice mail messages forwarded by Unified Messaging service. - Signed: Digitally signed messages. - ApprovalRequest: Moderation request messages sent to moderators. @@ -3600,8 +3672,8 @@ Accept wildcard characters: False ### -Mode The Mode parameter specifies how the rule operates. Valid values are: -- Audit: The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery. -- AuditAndNotify: The rule operates the same as in Audit mode, but notifications are also enabled. +- Audit: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport action occurs. +- AuditAndNotify: The actions that the rule would have taken are written to the message tracking log, but no action that impacts message delivery is taken on the message. The GenerateIncidentReport and GenerateNotification actions occur. - Enforce: All actions specified in the rule are taken. This is the default value. ```yaml @@ -3620,7 +3692,7 @@ Accept wildcard characters: False ### -ModerateMessageByManager This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ModerateMessageByManager parameter specifies an action that forwards messages for approval to the user that's specified in the sender's Manager attribute. After the manager approves the message, it's delivered to the recipients. Valid values are: @@ -3645,7 +3717,7 @@ Accept wildcard characters: False ### -ModerateMessageByUser This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The ModerateMessageByUser parameter specifies an action that forwards messages for approval to the specified users. After one of the users approves the message, it's delivered to the recipients. You can use ay value that uniquely identifies the user. For example: @@ -3690,9 +3762,11 @@ Accept wildcard characters: False ``` ### -NotifySender +**Note:** This parameter is functional only in on-premises Exchange. + This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The NotifySender parameter specifies an action that notifies the sender when messages violate DLP policies. Valid values are: @@ -3706,6 +3780,8 @@ For all values except NotifyOnly, you can specify an enhanced status code and a If you use this parameter, you also need to specify a condition that looks for sensitive information types in messages by using the MessageContainsDataClassifications parameter. +This action is applicable to messages sent by internal users only. External senders will not receive notifications. + ```yaml Type: NotifySenderType Parameter Sets: (All) @@ -3775,6 +3851,8 @@ The Quarantine parameter specifies an action that quarantines messages. - In on-premises Exchange, messages are delivered to the quarantine mailbox that you've configured as part of Content filtering. If the quarantine mailbox isn't configured, the message is returned to the sender in an NDR. - In Microsoft 365, messages are delivered to the hosted quarantine. +If this action is in a rule that's not the last rule in the list, rule evaluation stops after this rule is run. When the message is released from quarantine, the remaining rules in the list aren't evaluated. + ```yaml Type: Boolean Parameter Sets: (All) @@ -3791,7 +3869,7 @@ Accept wildcard characters: False ### -RecipientADAttributeContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The RecipientADAttributeContainsWords parameter specifies a condition that looks for words in the Active Directory attributes of recipients. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -3847,7 +3925,7 @@ Accept wildcard characters: False ### -RecipientADAttributeMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The RecipientADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in the Active Directory attributes of recipients by using regular expressions. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -3901,7 +3979,7 @@ Accept wildcard characters: False ### -RecipientAddressContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The RecipientAddressContainsWords parameter specifies a condition that looks for words in recipient email addresses. You can specify multiple words separated by commas. This parameter works when the recipient is an individual user. This parameter doesn't work with distribution groups. @@ -3921,7 +3999,7 @@ Accept wildcard characters: False ### -RecipientAddressMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The RecipientAddressMatchesPatterns parameter specifies a condition that looks for text patterns in recipient email addresses by using regular expressions. You can specify multiple text patterns by using the following syntax: `"Regular expression1","Regular expression2",..."Regular expressionN"`. @@ -3945,8 +4023,8 @@ This parameter is available only in the cloud-based service. The RecipientAddressType parameter specifies how conditions and exceptions check recipient email addresses. Valid values are: -- Original: The rule checks only the recipient's primary SMTP email address. -- Resolved: The rule checks the recipient's primary SMTP email address and all proxy addresses. This is the default value +- Original: The rule checks the original address in the To field of the message. +- Resolved: The rule checks the recipient's primary SMTP email address without checking any proxy addresses. This is the default value. ```yaml Type: RecipientAddressType @@ -3964,11 +4042,11 @@ Accept wildcard characters: False ### -RecipientDomainIs This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. -The RecipientDomainIs parameter specifies a condition that looks for recipients with email address in the specified domains. You can specify multiple domains separated by commas. +The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas. -If you want to look for recipient email addresses that contain the specified domain (for example, any subdomain of a domain), use the RecipientAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". ```yaml Type: Word[] @@ -4033,7 +4111,7 @@ Accept wildcard characters: False ### -RejectMessageEnhancedStatusCode This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The RejectMessageEnhancedStatusCode parameter specifies the enhanced status code that's used when the rule rejects messages. Valid values are 5.7.1 or between 5.7.900 and 5.7.999. @@ -4059,10 +4137,14 @@ Accept wildcard characters: False ### -RejectMessageReasonText This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The RejectMessageReasonText parameter specifies the explanation text that's used when the rule rejects messages. If the value contains spaces, enclose the value in quotation marks ("). +In Exchange 2013 or later, the maximum number of characters is 256. + +In the cloud-based service, the maximum number of characters is 1024. + You can use this parameter with the NotifySender parameter for a custom non-delivery report (also known as an NDR or bounce message). If you use this parameter with the RejectMessageEnhancedStatusCode parameter, the custom explanation text value is set to "Delivery not authorized, message refused". @@ -4148,6 +4230,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoveRMSAttachmentEncryption +This parameter is available only in the cloud-based service. + +This parameter specifies an action or part of an action for the rule. + +The RemoveRMSAttachmentEncryption parameter specifies an action that removes Microsoft Purview Message Encryption from encrypted attachments in email. The attachments were already encrypted before they were attached to the message. The message itself doesn't need to be encrypted. Valid values are: + +- $true: The encrypted attachments are decrypted. +- $false: The encrypted attachments aren't decrypted. + + This parameter also requires the value $true for the RemoveOMEv2 parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RouteMessageOutboundConnector This parameter is available only in the cloud-based service. @@ -4175,7 +4282,7 @@ Accept wildcard characters: False ### -RouteMessageOutboundRequireTls This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The RouteMessageOutboundRequireTls parameter specifies an action that uses Transport Layer Security (TLS) encryption to deliver messages outside your organization. Valid values are: @@ -4217,8 +4324,8 @@ Accept wildcard characters: False ### -RuleSubType The RuleSubType parameter specifies the rule type. Valid values are: -- Dlp: The rule is associated with a DLP policy. -- None: The rule is a regular rule that isn't associated with a DLP policy. +- Dlp: The rule is associated with a DLP policy. This value is meaningful only in on-premises Exchange. +- None: The rule is a regular transport rule. This is the default value. ```yaml Type: RuleSubType @@ -4234,11 +4341,9 @@ Accept wildcard characters: False ``` ### -SCLOver -This parameter is available or functional only in on-premises Exchange. - This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -This condition is available on Mailbox servers and Edge Transport servers. This condition is not available or functional in the cloud-based service due to how the service filtering stack works. +In on-premises Exchange, this condition is available on Mailbox servers and Edge Transport servers. The SCLOver parameter specifies a condition that looks for the SCL value of messages. Valid values are: @@ -4263,7 +4368,7 @@ Accept wildcard characters: False ### -SenderADAttributeContainsWords This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderADAttributeContainsWords parameter specifies a condition that looks for words in Active Directory attributes of message senders. @@ -4319,7 +4424,7 @@ Accept wildcard characters: False ### -SenderADAttributeMatchesPatterns This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderADAttributeMatchesPatterns parameter specifies a condition that looks for text patterns in Active Directory attributes of message senders by using regular expressions. @@ -4373,11 +4478,11 @@ Accept wildcard characters: False ### -SenderAddressLocation The SenderAddressLocation parameter specifies where to look for sender addresses in conditions and exceptions that examine sender email addresses. Valid values are: -- Header: Only examine senders in the message headers (for example, the From, Sender, or Reply-To fields). This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). +- Header: Only examine senders in the message headers. For example, in on-premises Exchange the the From, Sender, or Reply-To fields. In Exchange Online, the From field only. This is the default value, and is the way rules worked before Exchange 2013 Cumulative Update 1 (CU1). - Envelope: Only examine senders from the message envelope (the MAIL FROM value that was used in the SMTP transmission, which is typically stored in the Return-Path field). - HeaderOrEnvelope: Examine senders in the message header and the message envelope. -Note that message envelope searching is only available for the following conditions and exceptions: +Message envelope searching is available only for the following conditions and exceptions: - From and ExceptIfFrom - FromAddressContainsWords and ExceptIfFromAddressContainsWords @@ -4401,11 +4506,11 @@ Accept wildcard characters: False ### -SenderDomainIs This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderDomainIs parameter specifies a condition that looks for senders with email address in the specified domains. You can specify multiple domains separated by commas. -If you want to look for sender email addresses that contain the specified domain (for example, any subdomain of a domain), use the FromAddressMatchesPatterns parameter, and specify the domain by using the syntax '@domain\\.com$'. +This condition matches domains and subdomains. For example, "contoso.com" matches both "contoso.com" and "subdomain.contoso.com". You can use SenderAddressLocation parameter to specify where to look for the sender's email address (message header, message envelope, or both). @@ -4443,7 +4548,7 @@ Accept wildcard characters: False ### -SenderIpRanges This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderIpRanges parameter specifies a condition that looks for senders whose IP addresses matches the specified value, or fall within the specified ranges. Valid values are: @@ -4453,6 +4558,8 @@ The SenderIpRanges parameter specifies a condition that looks for senders whose You can specify multiple values separated by commas. +In Exchange Online, the IP address that's used during evaluation of this condition is the address of the last hop before reaching the service. This IP address is not guaranteed to be the original sender's IP address, especially if third-party software is used during message transport. + ```yaml Type: MultiValuedProperty Parameter Sets: (All) @@ -4469,7 +4576,7 @@ Accept wildcard characters: False ### -SenderManagementRelationship This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SenderManagementRelationship parameter specifies a condition that looks for the relationship between the sender and recipients in messages. Valid values are: @@ -4492,7 +4599,7 @@ Accept wildcard characters: False ### -SentTo This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example: @@ -4521,7 +4628,7 @@ Accept wildcard characters: False ### -SentToMemberOf This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, dynamic distribution groups, or mail-enabled security groups. You can use any value that uniquely identifies the group. For example: @@ -4552,14 +4659,14 @@ Accept wildcard characters: False ### -SentToScope This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The SentToScope parameter specifies a condition that looks for the location of recipients. Valid values are: -- InOrganization: The recipient is a mailbox, mail user, group, or mail-enabled public folder in your organization or the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain, and the message was sent or received over an authenticated connection. -- NotInOrganization: The recipients are outside your organization. The recipient's email address isn't in an accepted domain or the recipient's email address is in an accepted domain that's configured as an external relay domain. -- ExternalPartner: The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. This value is only available in on-premises Exchange. -- ExternalNonPartner: The recipients are external to your organization, and the organization isn't a partner organization. This value is only available in on-premises Exchange. +- InOrganization: The message was sent or received over an authenticated connection **AND** the recipient meets at least one of the following criteria: The recipient is a mailbox, mail user, group, or mail-enabled public folder in the organization, **OR** the recipient's email address is in an accepted domain that's configured as an authoritative domain or an internal relay domain in the organization. +- NotInOrganization: The recipients are outside the organization. The recipient's email address isn't in an accepted domain or is in an accepted domain that's configured as an external relay domain in the organization. +- ExternalPartner: This value is available only in on-premises Exchange. The recipients are in a partner organization where you've configured Domain Security (mutual TLS authentication) to send mail. +- ExternalNonPartner: This value is available only in on-premises Exchange. The recipients are external to your organization, and the organization isn't a partner organization. ```yaml Type: ToUserScope @@ -4577,7 +4684,7 @@ Accept wildcard characters: False ### -SetAuditSeverity This parameter specifies an action or part of an action for the rule. -In on-premises Exchange, this action is only available on Mailbox servers. +In on-premises Exchange, this action is available only on Mailbox servers. The SetAuditSeverity parameter specifies an action that sets the severity level of the incident report and the corresponding entry that's written to the message tracking log when messages violate DLP policies. Valid values are: @@ -4663,7 +4770,7 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectStatusCode -This parameter is available or functional only on Edge Transport servers in on-premises Exchange. +This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4685,7 +4792,7 @@ Accept wildcard characters: False ``` ### -SmtpRejectMessageRejectText -This parameter is available or functional only on Edge Transport servers in on-premises Exchange. +This parameter is functional only on Edge Transport servers in on-premises Exchange. This parameter specifies an action or part of an action for the rule. @@ -4736,7 +4843,9 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The SubjectContainsWords parameter specifies a condition that looks for words in the Subject field of messages. -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. ```yaml Type: Word[] @@ -4778,7 +4887,9 @@ In on-premises Exchange, this condition is available on Mailbox servers and Edge The SubjectOrBodyContainsWords parameter specifies a condition that looks for words in the Subject field or body of messages. -To specify multiple words or phrases, this parameter uses the syntax: Word1,"Phrase with spaces",word2,...wordN. Don't use leading or trailing spaces. +To specify multiple words or phrases, use the following syntax: `Word1,"Phrase with spaces",word2,...wordN`. Don't use leading or trailing spaces. + +The maximum length of this parameter is 128 characters. ```yaml Type: Word[] @@ -4832,7 +4943,7 @@ Accept wildcard characters: False ### -WithImportance This parameter specifies a condition or part of a condition for the rule. The name of the corresponding exception parameter starts with ExceptIf. -In on-premises Exchange, this condition is only available on Mailbox servers. +In on-premises Exchange, this condition is available only on Mailbox servers. The WithImportance parameter specifies a condition that looks for messages with the specified importance level. Valid values are: @@ -4858,12 +4969,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-TransportServer.md b/exchange/exchange-ps/exchange/Set-TransportServer.md index 54848dff2f..f9958ab658 100644 --- a/exchange/exchange-ps/exchange/Set-TransportServer.md +++ b/exchange/exchange-ps/exchange/Set-TransportServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-transportserver +online version: https://learn.microsoft.com/powershell/module/exchange/set-transportserver applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-TransportServer schema: 2.0.0 @@ -18,7 +18,7 @@ Use the Set-TransportServer cmdlet to modify settings that are associated with t **Note**: In Exchange 2013 or later, use the Set-TransportService cmdlet instead. If you have scripts that use Set-TransportServer, update them to use Set-TransportService. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -122,7 +122,7 @@ Set-TransportServer [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -526,7 +526,7 @@ Accept wildcard characters: False ``` ### -ContentConversionTracingEnabled -The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: +The ContentConversionTracingEnabled parameter specifies whether content conversion tracing is enabled. Content conversion tracing captures content conversion failures that occur in the Transport service on a Mailbox server or on the Edge server. The default value is $false. Content conversion tracing captures a maximum of 128 MB of content conversion failures. When the 128 MB limit is reached, no more content conversion failures are captured. Content conversion tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control - Network Service: Full Control @@ -1063,7 +1063,7 @@ Accept wildcard characters: False ``` ### -MaxPerDomainOutboundConnections -The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 20. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. +The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 40. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. ```yaml Type: Unlimited @@ -1099,7 +1099,7 @@ Accept wildcard characters: False ``` ### -MessageRetryInterval -The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 15 minutes. +The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -1311,7 +1311,7 @@ Accept wildcard characters: False ``` ### -PickupDirectoryMaxRecipientsPerMessage -The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an message. The default value is 100. The valid input range for this parameter is from 1 through 10000. +The PickupDirectoryMaxRecipientsPerMessage parameter specifies the maximum number of recipients that can be included on an message. The default value is 100. The valid input range for this parameter is from 1 through 10000. ```yaml Type: Int32 @@ -1368,7 +1368,7 @@ The path must be local to the Exchange server. Setting the value of this parameter to $null disables pipeline tracing. However, setting this parameter to $null when the value of the PipelineTracingEnabled attribute is $true generates event log errors. The preferred method to disable pipeline tracing is to use the PipelineTracingEnabled parameter. -Pipeline tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: +Pipeline tracing captures the complete contents of messages to the path specified by the PipelineTracingPath parameter. Make sure that you restrict access to this directory. The permissions required on the directory specified by the PipelineTracingPath parameter are as follows: - Administrators: Full Control - Network Service: Full Control @@ -1388,7 +1388,7 @@ Accept wildcard characters: False ``` ### -PipelineTracingSenderAddress -The PipelineTracingSenderAddress parameter specifies the sender address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. +The PipelineTracingSenderAddress parameter specifies the sender address that invokes pipeline tracing. Only messages from this address generate pipeline tracing output. The address can be either inside or outside the Exchange organization. Depending on your requirements, you may have to set this parameter to different sender addresses and send new messages to start the transport agents or routes that you want to test. The default value of this parameter is $null. ```yaml Type: SmtpAddress @@ -1859,7 +1859,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxAge -This parameter is available or functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. +This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxAge parameter specifies the maximum duration that the server statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. @@ -1881,7 +1881,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxDirectorySize -This parameter is available or functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. +This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the server statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. When you enter a value, qualify the value with one of the following: @@ -1909,7 +1909,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxFileSize -This parameter is available or functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. +This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogMaxFileSize parameter specifies the maximum file size for the server statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. When you enter a value, qualify the value with one of the following: @@ -1937,7 +1937,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogPath -This parameter is available or functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. +This parameter is functional only in Exchange Server 2010 and Exchange 2013 CU6 or earlier. The ServerStatisticsLogPath parameter specifies the location of the server statistics log. The default location depends on your version of Exchange: @@ -2100,12 +2100,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-TransportService.md b/exchange/exchange-ps/exchange/Set-TransportService.md index a081f2aa1f..c6c5a3fe45 100644 --- a/exchange/exchange-ps/exchange/Set-TransportService.md +++ b/exchange/exchange-ps/exchange/Set-TransportService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-transportservice +online version: https://learn.microsoft.com/powershell/module/exchange/set-transportservice applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-TransportService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-TransportService cmdlet to modify the settings of the Transport service on Exchange 2013 or later Mailbox servers or Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -164,7 +164,7 @@ Set-TransportService [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -1103,7 +1103,7 @@ Accept wildcard characters: False ``` ### -MaxPerDomainOutboundConnections -The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 20. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. +The MaxPerDomainOutboundConnections parameter specifies the maximum number of concurrent connections to any single domain. The default value is 40. The valid input range for this parameter is from 1 through 2147483647. If you enter a value of unlimited, no limit is imposed on the number of outbound connections per domain. The value of the MaxPerDomainOutboundConnections parameter must be less than or equal to the value of the MaxOutboundConnections parameter. ```yaml Type: Unlimited @@ -1139,7 +1139,7 @@ Accept wildcard characters: False ``` ### -MessageRetryInterval -The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 15 minutes. +The MessageRetryInterval parameter specifies the retry interval for individual messages after a connection failure with a remote server. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds. @@ -2066,7 +2066,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxAge -This parameter is available or functional only in Exchange Server 2013 CU6 or earlier. +This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxAge parameter specifies the maximum duration that the server statistics log files are kept. Log files older than the specified value are deleted. The default value is 30 days. @@ -2088,7 +2088,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxDirectorySize -This parameter is available or functional only in Exchange Server 2013 CU6 or earlier. +This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxDirectorySize parameter specifies the cap on the size of the server statistics log directory. When the maximum directory size is reached, the server deletes the oldest log files first. The minimum value is 1 MB. The default value is 250 MB. @@ -2118,7 +2118,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogMaxFileSize -This parameter is available or functional only in Exchange Server 2013 CU6 or earlier. +This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogMaxFileSize parameter specifies the maximum file size for the server statistics log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB. @@ -2148,7 +2148,7 @@ Accept wildcard characters: False ``` ### -ServerStatisticsLogPath -This parameter is available or functional only in Exchange Server 2013 CU6 or earlier. +This parameter is functional only in Exchange Server 2013 CU6 or earlier. The ServerStatisticsLogPath parameter specifies the location of server statistics log storage. The default location is %ExchangeInstallPath%TransportRoles\\Logs\\Hub\\ServerStats. Setting the value of this parameter to $null disables server statistics logging. @@ -2850,12 +2850,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md b/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md index 56b50b8cc9..c224bb9dc4 100644 --- a/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md +++ b/exchange/exchange-ps/exchange/Set-UMAutoAttendant.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-umautoattendant +online version: https://learn.microsoft.com/powershell/module/exchange/set-umautoattendant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMAutoAttendant schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMAutoAttendant cmdlet to modify an existing Unified Messaging (UM) auto attendant. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -74,7 +74,7 @@ The Set-UMAutoAttendant cmdlet changes or modifies the settings of an existing U After this task is completed, the parameters and values specified are configured on the UM auto attendant. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -87,10 +87,10 @@ This example configures the UM auto attendant MySpeechEnabledAA to fall back to ### Example 2 ```powershell -Set-UMAutoAttendant -Identity MyUMAutoAttendant -BusinessHoursSchedule 0.10:45-0.13:15,1.09:00-1.17:00,6.09:00-6.16:30 -HolidaySchedule "New Year,newyrgrt.wav,1/2/2013","Building Closed for Construction,construction.wav,4/24/2013,4/28/2013" +Set-UMAutoAttendant -Identity MyUMAutoAttendant -BusinessHoursSchedule 0.10:45-0.13:15,1.09:00-1.17:00,6.09:00-6.16:30 -HolidaySchedule "New Year,newyrgrt.wav,1/2/2014","Building Closed for Construction,construction.wav,4/24/2014,4/28/2014" ``` -This example configures the UM auto attendant MyUMAutoAttendant that has business hours configured to be 10:45 to 13:15 (Sunday), 09:00 to 17:00 (Monday), and 09:00 to 16:30 (Saturday) and holiday times and their associated greetings configured to be "New Year" on January 2, 2013, and "Building Closed for Construction" from April 24, 2013 through April 28, 2013. +This example configures the UM auto attendant MyUMAutoAttendant that has business hours configured to be 10:45 to 13:15 (Sunday), 09:00 to 17:00 (Monday), and 09:00 to 16:30 (Saturday) and holiday times and their associated greetings configured to be "New Year" on January 2, 2014, and "Building Closed for Construction" from April 24, 2014 through April 28, 2014. ### Example 3 ```powershell @@ -606,7 +606,7 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM auto attendant object is upgraded. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -630,7 +630,7 @@ The HolidaySchedule parameter specifies the holiday schedule for the organizatio The following is an example: -"Christmas, Christmas.wav, 12/25/2013". +"Christmas, Christmas.wav, 12/25/2014". ```yaml Type: MultiValuedProperty @@ -897,12 +897,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md b/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md index b78568a707..f5a3f24afa 100644 --- a/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md +++ b/exchange/exchange-ps/exchange/Set-UMCallAnsweringRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-umcallansweringrule +online version: https://learn.microsoft.com/powershell/module/exchange/set-umcallansweringrule applicable: Exchange Server 2013, Exchange Server 2016 title: Set-UMCallAnsweringRule schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMCallAnsweringRule cmdlet to change properties of an existing UM call answering rule. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -54,7 +54,7 @@ You can also specify the following actions: After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -373,12 +373,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md b/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md index fbc8087f33..e2d42d19d4 100644 --- a/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md +++ b/exchange/exchange-ps/exchange/Set-UMCallRouterSettings.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-umcallroutersettings +online version: https://learn.microsoft.com/powershell/module/exchange/set-umcallroutersettings applicable: Exchange Server 2013, Exchange Server 2016 title: Set-UMCallRouterSettings schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMCallRouterSettings cmdlet to modify the configuration of the Microsoft Exchange Unified Messaging Call Router service. This service exists on Exchange servers that have the Client Access server role installed, and is used by telephony clients to connect to Exchange. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Set-UMCallRouterSettings [[-Server] ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -256,12 +256,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMDialPlan.md b/exchange/exchange-ps/exchange/Set-UMDialPlan.md index 984df6589b..0255771570 100644 --- a/exchange/exchange-ps/exchange/Set-UMDialPlan.md +++ b/exchange/exchange-ps/exchange/Set-UMDialPlan.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-umdialplan +online version: https://learn.microsoft.com/powershell/module/exchange/set-umdialplan applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMDialPlan schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMDialPlan cmdlet to set various properties on a Unified Messaging (UM) dial plan. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -82,7 +82,7 @@ UM dial plans are important to the operation of Unified Messaging. Modifications After this task is completed, the parameters and values specified are configured on the UM dial plan. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -103,7 +103,9 @@ This example configures the UM dial plan MyDialPlan to use a welcome greeting. ### Example 3 ```powershell $csv=import-csv "C:\MyInCountryGroups.csv" + Set-UMDialPlan -Identity MyDialPlan -ConfiguredInCountryOrRegionGroups $csv + Set-UMDialPlan -Identity MyDialPlan -AllowedInCountryOrRegionGroups "local, long distance" ``` @@ -525,7 +527,7 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM dial plan object is upgraded. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -951,12 +953,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMIPGateway.md b/exchange/exchange-ps/exchange/Set-UMIPGateway.md index 796fb698fc..af9d1ffda1 100644 --- a/exchange/exchange-ps/exchange/Set-UMIPGateway.md +++ b/exchange/exchange-ps/exchange/Set-UMIPGateway.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-umipgateway +online version: https://learn.microsoft.com/powershell/module/exchange/set-umipgateway applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMIPGateway schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMIPGateway cmdlet to modify the configuration settings for a single Unified Messaging (UM) IP gateway or to return a list of configuration settings that can be modified on a specified UM IP gateway. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ It's possible that modifications to the UM IP gateway settings may disrupt commu After this task is completed, the parameters and values specified are configured on the UM IP gateway. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -163,7 +163,7 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether you're prompted for confirmation before a UM IP gateway object is upgraded. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -319,12 +319,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMMailbox.md b/exchange/exchange-ps/exchange/Set-UMMailbox.md index 9d3a777f22..7e179f4bc5 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailbox.md +++ b/exchange/exchange-ps/exchange/Set-UMMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ummailbox +online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailbox applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMMailbox cmdlet to set the Unified Messaging (UM) properties for a user who is currently UM-enabled. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -52,7 +52,7 @@ The Set-UMMailbox cmdlet sets UM properties associated with a user who has been After this task is completed, the parameters and values specified are configured on the UM mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -81,7 +81,7 @@ This example prevents the user tony@contoso.com from accessing his calendar and ## PARAMETERS ### -Identity -The Identity parameter specifies the mailbox tht you want to modify. You can use any value that uniquely identifies the mailbox. For example: +The Identity parameter specifies the mailbox that you want to modify. You can use any value that uniquely identifies the mailbox. For example: - Name - Alias @@ -239,9 +239,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -267,7 +267,7 @@ Valid values are: - $true: The user's Lync or Skype for Business contact list is stored in their Exchange 2016 mailbox. This prevents you from migrating the mailbox back to an Exchange 2010 server. - $false: The user's Lync or Skype for Business contact list is stored on a Lync or Skype for Business server. This doesn't prevent you from migrating the mailbox back to an Exchange 2010 server. This is the default value. -Lync Server 2013 and Skype for Business Server 2015 support storing the user's contact list in their Exchange 2016 mailbox. This feature is known as the unified contact store (UCS), and it allows applications to show a consistent, up-to-date contact list. However, Exchange 2010 doesn't support the unified contact store. Therefore, before you migrate a user's Exchange 2016 mailbox back to Exchange 2010, you need to move the user's Lync or Skype for Business contact list from the unified contact store back to a Lync 2013 or Skype for Business server. For more information, see [Configuring Microsoft Lync Server 2013 to use the unified contact store](https://docs.microsoft.com/lyncserver/lync-server-2013-configuring-lync-server-to-use-the-unified-contact-store). +Lync Server 2013 and Skype for Business Server 2015 support storing the user's contact list in their Exchange 2016 mailbox. This feature is known as the unified contact store (UCS), and it allows applications to show a consistent, up-to-date contact list. However, Exchange 2010 doesn't support the unified contact store. Therefore, before you migrate a user's Exchange 2016 mailbox back to Exchange 2010, you need to move the user's Lync or Skype for Business contact list from the unified contact store back to a Lync 2013 or Skype for Business server. For more information, see [Configuring Microsoft Lync Server 2013 to use the unified contact store](https://learn.microsoft.com/lyncserver/lync-server-2013-configuring-lync-server-to-use-the-unified-contact-store). If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's Lync or Skype for Business contact list is stored in the unified contact store, the user could permanently lose access to those contacts. After you verify the user's Lync or Skype for Business contact list has been moved back to a Lync 2013 or Skype for Business server, you should be able to complete the mailbox migration. If you need to migrate the mailbox despite the potential for data loss, you can manually set the ImListMigrationCompleted parameter to $false. @@ -483,12 +483,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md b/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md index 9fc1c9e405..bec81a4cf6 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md +++ b/exchange/exchange-ps/exchange/Set-UMMailboxPIN.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ummailboxpin +online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailboxpin applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMMailboxPIN schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMMailboxPIN cmdlet to reset the PIN for a Unified Messaging (UM)-enabled mailbox. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -39,7 +39,7 @@ The Set-UMMailboxPIN cmdlet is used when a UM-enabled user has been locked out o After this task is completed, the PIN on a UM-enabled mailbox is set. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -136,9 +136,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -273,12 +273,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md b/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md index e349491859..789aabc713 100644 --- a/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md +++ b/exchange/exchange-ps/exchange/Set-UMMailboxPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-ummailboxpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/set-ummailboxpolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Set-UMMailboxPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMMailboxPolicy cmdlet to modify a Unified Messaging (UM) mailbox policy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -78,7 +78,7 @@ When the Set-UMMailboxPolicy cmdlet is used to modify UM mailbox policy objects, After this task is completed, the parameters and values specified are configured on the UM mailbox policy. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -511,7 +511,7 @@ Accept wildcard characters: False ``` ### -FaxServerURI -The FaxServerURI parameter specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) for the fax solution that serves the UM-enabled users associated with the UM mailbox policy. This fax product or fax service accepts incoming fax calls that were redirected from Exchange Server 2016 Mailbox servers and creates inbound fax messages for the UM-enabled users associated with the UM mailbox policy. Although you can enter more than one fax server URI, only one URI will be used by Mailbox servers running UM services. +The FaxServerURI parameter specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) for the fax solution that serves the UM-enabled users associated with the UM mailbox policy. This fax product or fax service accepts incoming fax calls that were redirected from Exchange Unified Messaging servers and creates inbound fax messages for the UM-enabled users associated with the UM mailbox policy. Although you can enter more than one fax server URI, only one URI will be used by the Unified Messaging server. ```yaml Type: String @@ -527,7 +527,7 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -899,12 +899,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UMService.md b/exchange/exchange-ps/exchange/Set-UMService.md index 497bbbdcf6..51772cc547 100644 --- a/exchange/exchange-ps/exchange/Set-UMService.md +++ b/exchange/exchange-ps/exchange/Set-UMService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-umservice +online version: https://learn.microsoft.com/powershell/module/exchange/set-umservice applicable: Exchange Server 2013, Exchange Server 2016 title: Set-UMService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-UMService cmdlet to modify the properties of the Microsoft Exchange Unified Messaging service on Exchange 2013 or Exchange 2016 Mailbox servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +42,7 @@ Set-UMService [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -438,12 +438,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UmServer.md b/exchange/exchange-ps/exchange/Set-UmServer.md index 035feab84b..6fa2f340bf 100644 --- a/exchange/exchange-ps/exchange/Set-UmServer.md +++ b/exchange/exchange-ps/exchange/Set-UmServer.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-umserver +online version: https://learn.microsoft.com/powershell/module/exchange/set-umserver applicable: Exchange Server 2010 title: Set-UmServer schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Set-UMServer cmdlet to modify settings that are associated with the Unified Messaging (UM) server role. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +47,7 @@ The Set-UMServer cmdlet sets specific properties on a Unified Messaging server. After this task is completed, the cmdlet sets the parameters and the values specified. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -426,12 +426,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md index bb31582e67..b54bb64a99 100644 --- a/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md +++ b/exchange/exchange-ps/exchange/Set-UnifiedAuditLogRetentionPolicy.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-unifiedauditlogretentionpolicy -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/set-unifiedauditlogretentionpolicy +applicable: Security & Compliance title: Set-UnifiedAuditLogRetentionPolicy schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Set-UnifiedAuditLogRetentionPolicy ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Set-UnifiedAuditLogRetentionPolicy cmdlet to modify audit log retention policies in the Microsoft 365 Defender portal or the Microsoft 365 compliance center. +Use the Set-UnifiedAuditLogRetentionPolicy cmdlet to modify audit log retention policies in the Microsoft Defender portal or the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,9 +32,9 @@ Set-UnifiedAuditLogRetentionPolicy [-Identity] -Priority [-GrantSendOnBehalfTo ] [-HiddenFromAddressListsEnabled ] [-HiddenFromExchangeClientsEnabled] + [-InformationBarrierMode ] + [-IsMemberAllowedToEditContent ] [-Language ] [-MailboxRegion ] [-MailTip ] @@ -85,9 +85,10 @@ Set-UnifiedGroup [-Identity] ## DESCRIPTION Microsoft 365 Groups are group objects that are available across Microsoft 365 services. -The HiddenGroupMembershipEnabled parameter is only available on the New-UnifiedGroup cmdlet. You can't change this setting on an existing Microsoft 365 Group group. +> [!NOTE] +> You can't change the HiddenGroupMembershipEnabled setting on an existing Microsoft 365 Group. The setting is available only during new group creation. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,7 +125,7 @@ The Identity parameter specifies the Microsoft 365 Group that you want to modify Type: UnifiedGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: True Position: 1 @@ -155,7 +156,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -168,7 +169,7 @@ Accept wildcard characters: False The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Valid values are: - Public: The group content and conversations are available to everyone, and anyone can join the group without approval from a group owner. -- Private: The group content and conversations are only available to members of the group, and joining the group requires approval from a group owner. +- Private: The group content and conversations are available only to members of the group, and joining the group requires approval from a group owner. **Note**: Although a user needs to be a member to participate in a private group, anyone can send email to a private group, and receive replies from the private group. @@ -176,7 +177,7 @@ The AccessType parameter specifies the privacy type for the Microsoft 365 Group. Type: ModernGroupTypeInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -186,15 +187,20 @@ Accept wildcard characters: False ``` ### -Alias -The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. +The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the Microsoft 365 Group. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value. The maximum length is 64 characters. + +The Alias value can contain letters, numbers and the following characters: -The value of Alias can contain letters, numbers and the following characters: !, #, $, %, &, ', \*, +, -, /, =, ?, ^, \_, \`, {, }, |, and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters. +- !, #, %, \*, +, -, /, =, ?, ^, \_, and ~. +- $, &, ', \`, {, }, and \| need to be escaped (for example ``-Alias what`'snew``) or the entire value enclosed in single quotation marks (for example, `-Alias 'what'snew'`). The & character is not supported in the Alias value for Microsoft Entra Connect synchronization. +- Periods (.) must be surrounded by other valid characters (for example, `help.desk`). +- Unicode characters U+00A1 to U+00FF. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -213,11 +219,13 @@ Group members can change their own subscription settings, which can override you The AutoSubscribeNewMembers switch overrides this switch. +**Note**: This property is evaluated only when you add internal members from your organization. Guest user accounts are always subscribed when added as a member. You can manually remove subscriptions for guest users by using the Remove-UnifiedGroupLinks cmdlet. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -237,7 +245,7 @@ For example, to specify 60 days for this parameter, use 60.00:00:00. Type: EnhancedTimeSpan Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -250,13 +258,15 @@ Accept wildcard characters: False The AutoSubscribeNewMembers switch specifies whether to automatically subscribe new members that are added to the Microsoft 365 Group to conversations and calendar events. Only users that are added to the group after you enable this setting are automatically subscribed to the group. - To subscribe new members to conversations and calendar events, use the AutoSubscribeNewMembers switch without a value. -- If you don't want to subscribe new members to conversations and calendar events, use this exact syntax: -AutoSubscribeNewMembers:$false. +- If you don't want to subscribe new members to conversations and calendar events, use this exact syntax: `-AutoSubscribeNewMembers:$false`. + +**Note**: This property is evaluated only when you add internal members from your organization. Guest user accounts are always subscribed when added as a member. You can manually remove subscriptions for guest users by using the Remove-UnifiedGroupLinks cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -269,7 +279,7 @@ Accept wildcard characters: False The CalendarMemberReadOnly switch specifies whether to set read-only Calendar permissions to the Microsoft 365 Group for members of the group. - To set read-only Calendar permissions, use the CalendarMemberReadOnly switch without a value. -- To remove read-only Calendar permissions, use this exact syntax: -CalendarMemberReadOnly:$false. +- To remove read-only Calendar permissions, use this exact syntax: `-CalendarMemberReadOnly:$false`. To view the current value of the CalendarMemberReadOnly property on a Microsoft 365 Group, replace `` with the email address of the group, and run this command: `Get-UnifiedGroup -Identity -IncludeAllProperties | Format-List *Calendar*`. @@ -277,7 +287,7 @@ To view the current value of the CalendarMemberReadOnly property on a Microsoft Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -287,13 +297,13 @@ Accept wildcard characters: False ``` ### -Classification -The Classification parameter specifies the classification for the Microsoft 365 Group. You need to configure the list of available classifications in Azure Active Directory before you can specify a value for this parameter. For more information, see [Azure Active Directory cmdlets for configuring group settings](https://docs.microsoft.com/azure/active-directory/users-groups-roles/groups-settings-cmdlets). +The Classification parameter specifies the classification for the Microsoft 365 Group. You need to configure the list of available classifications in Microsoft Entra ID before you can specify a value for this parameter. For more information, see [Microsoft Entra cmdlets for configuring group settings](https://learn.microsoft.com/azure/active-directory/users-groups-roles/groups-settings-cmdlets). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -312,7 +322,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -325,7 +335,7 @@ Accept wildcard characters: False The ConnectorsEnabled specifies whether to enable the ability to use connectors for the Microsoft 365 Group. - To enable connectors, use the ConnectorsEnabled switch without a value. -- To disable connectors, use this exact syntax: -ConnectorsEnabled:$false. +- To disable connectors, use this exact syntax: `-ConnectorsEnabled:$false`. To use this switch, the value of the ConnectorsEnabled parameter on the Set-OrganizationConfig cmdlet must be set to $true (which is the default value). @@ -335,7 +345,7 @@ For more information about connectors for Microsoft 365 Groups, see [Connect app Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -351,7 +361,7 @@ This parameter specifies a value for the CustomAttribute1 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -367,7 +377,7 @@ This parameter specifies a value for the CustomAttribute10 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -383,7 +393,7 @@ This parameter specifies a value for the CustomAttribute11 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -399,7 +409,7 @@ This parameter specifies a value for the CustomAttribute12 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -415,7 +425,7 @@ This parameter specifies a value for the CustomAttribute13 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -431,7 +441,7 @@ This parameter specifies a value for the CustomAttribute14 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -447,7 +457,7 @@ This parameter specifies a value for the CustomAttribute15 property on the recip Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -463,7 +473,7 @@ This parameter specifies a value for the CustomAttribute2 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -479,7 +489,7 @@ This parameter specifies a value for the CustomAttribute3 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -495,7 +505,7 @@ This parameter specifies a value for the CustomAttribute4 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -511,7 +521,7 @@ This parameter specifies a value for the CustomAttribute5 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -527,7 +537,7 @@ This parameter specifies a value for the CustomAttribute6 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -543,7 +553,7 @@ This parameter specifies a value for the CustomAttribute7 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -559,7 +569,7 @@ This parameter specifies a value for the CustomAttribute8 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -575,7 +585,7 @@ This parameter specifies a value for the CustomAttribute9 property on the recipi Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -597,7 +607,7 @@ To remove an existing policy, use the value $null. Type: DataEncryptionPolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -613,7 +623,7 @@ The DisplayName parameter specifies the name of the Microsoft 365 Group. The dis Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -623,16 +633,15 @@ Accept wildcard characters: False ``` ### -EmailAddresses -The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see [Email address policies in Exchange Server](https://docs.microsoft.com/Exchange/email-addresses-and-address-books/email-address-policies/email-address-policies). +The EmailAddresses parameter specifies all email addresses (proxy addresses) for the Microsoft 365 Group, including the primary SMTP address. In cloud-based organizations, the primary SMTP address and other proxy addresses for Microsoft 365 Groups are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the Microsoft 365 Group. -Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type value specifies the type of email address. Examples of valid values include: +Valid syntax for this parameter is `"Type:EmailAddress1","Type:EmailAddress2",..."Type:EmailAddressN"`. The optional `Type` value specifies the type of email address. Examples of valid values include: - SMTP: The primary SMTP address. You can use this value only once in a command. - smtp: Other SMTP email addresses. -- X400: X.400 addresses in on-premises Exchange. -- X500: X.500 addresses in on-premises Exchange. +- SPO: SharePoint email address. -If you don't include a Type value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. +If you don't include a Type value for an email address, the address is assumed to be an SMTP email address. The syntax of SMTP email addresses is validated, but the syntax of other email address types isn't validated. Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: @@ -648,7 +657,7 @@ To add or remove specify proxy addresses without affecting other existing values Type: ProxyAddressCollection Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -668,7 +677,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -688,7 +697,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -708,7 +717,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -728,7 +737,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -748,7 +757,7 @@ To add or remove one or more values without affecting any existing entries, use Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -758,13 +767,13 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -793,13 +802,13 @@ To enter multiple values and overwrite any existing entries, use the following s To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="Value1","Value2"...; Remove="Value3","Value4"...}`. -By default, this parameter is blank, which means no one else has permission to send on behalf of this Microsoft 365 Group group. +By default, this parameter is blank, which means no one else has permission to send on behalf of this Microsoft 365 Group. ```yaml Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -818,7 +827,7 @@ The HiddenFromAddressListsEnabled parameter specifies whether the Microsoft 365 Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -830,14 +839,52 @@ Accept wildcard characters: False ### -HiddenFromExchangeClientsEnabled The HiddenFromExchangeClientsEnabled switch specifies whether the Microsoft 365 Group is hidden from Outlook clients connected to Microsoft 365. -- To enable this setting, you don't need to specify a value with this switch. The Microsoft 365 Group is hidden from Outlook experiences. The group isn't visible in the Outlook left-hand navigation and isn't be visible in the global address list (GAL). The group name won't resolve during the creation a new message in Outlook. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users also can't find the group by using the Discover option in Outlook on the web. Additionally, the HiddenFromAddressListsEnabled property will also be set to true to prevent the group from showing in the GAL and in the Offline Address Book (OAB). -- To disable this setting, use this exact syntax: -HiddenFromExchangeClientsEnabled:$false. The Microsoft 365 Group is not hidden from Outlook experiences. The group will be visible in the GAL and other address lists. This is the default value. +- To enable this setting, you don't need to specify a value with this switch. The Microsoft 365 Group is hidden from Outlook experiences. The group isn't visible in the Outlook left-hand navigation and isn't visible in the global address list (GAL). The group name doesn't resolve during the creation of a new message in Outlook. The group can still receive messages, but users can't search for or browse to the group in Outlook or Outlook on the web. Users can't find the group by using the Discover option in Outlook on the web. The HiddenFromAddressListsEnabled property is set to the value True to prevent the group from showing in the GAL and in the Offline Address Book (OAB). +- To disable this setting, use this exact syntax: `-HiddenFromExchangeClientsEnabled:$false`. The Microsoft 365 Group isn't hidden from Outlook experiences. The group will be visible in the GAL and other address lists. This is the default value. +- If Microsoft 365 Groups are hidden from Exchange clients, users don't see the option to subscribe or unsubscribe to a Microsoft 365 Group. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InformationBarrierMode +The InformationBarrierMode parameter specifies the information barrier mode for the Microsoft 365 Group. Valid values are: + +- Explicit +- Implicit +- Open +- OwnerModerated + +```yaml +Type: GroupInformationBarrierMode +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsMemberAllowedToEditContent +{{ Fill IsMemberAllowedToEditContent Description }} + +```yaml +Type: System.Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -849,13 +896,13 @@ Accept wildcard characters: False ### -Language The Language parameter specifies language preference for the Microsoft 365 Group. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -865,13 +912,13 @@ Accept wildcard characters: False ``` ### -MailboxRegion -This parameter is reserved for internal Microsoft use. +The MailboxRegion parameter specifies the preferred data location (PDL) for the Microsoft 365 Group in multi-geo environments. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -892,7 +939,7 @@ When you add a MailTip to a recipient, two things happen: Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -916,7 +963,7 @@ For example, suppose this recipient currently has the MailTip text: "This mailbo Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -945,7 +992,7 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -974,7 +1021,7 @@ Base64 encoding increases the size of messages by approximately 33%, so specify Type: Unlimited Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1001,7 +1048,7 @@ You need to use this parameter to specify at least one moderator when you set th Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1022,7 +1069,7 @@ You use the ModeratedBy parameter to specify the moderators. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1038,7 +1085,7 @@ The Notes parameter specifies the description of the Microsoft 365 Group. If the Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1054,7 +1101,7 @@ The PrimarySmtpAddress parameter specifies the primary return email address that Type: SmtpAddress Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1089,7 +1136,7 @@ By default, this parameter is blank ($null), which allows this recipient to acce Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1108,7 +1155,7 @@ The RequireSenderAuthenticationEnabled parameter specifies whether to accept mes Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1118,15 +1165,15 @@ Accept wildcard characters: False ``` ### -SensitivityLabelId -This parameter is available only in the cloud-based service. +The SensitivityLabelId parameter specifies the GUID value of the sensitivity label that's assigned to the Microsoft 365 Group. -{{ Fill SensitivityLabelId Description }} +**Note**: In the output of the Get-UnifiedGroup cmdlet, this property is named SensitivityLabel, not SensitivityLabelId. ```yaml Type: System.Guid Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1136,16 +1183,20 @@ Accept wildcard characters: False ``` ### -SubscriptionEnabled -The SubscriptionEnabled switch specifies whether subscriptions to conversations and calendar events are enabled for the Microsoft 365 Group. +The SubscriptionEnabled switch specifies whether the group owners can enable subscription to conversations and calendar events on the groups they own. This option can be set only in Exchange Online PowerShell. - To change the value to $true, use this switch without a value. -- To change the value to $false, use this exact syntax: -SubscriptionEnabled:$false. +- To change the value to $false, use this exact syntax: `-SubscriptionEnabled:$false`. The value of the AutoSubscribeNewMembers parameter must also be $false before you can use the value $false for this switch. + +**Note**: You should use the value $false for this switch only if you intend to disable group owner ability to change subscription options on the group. Group owners will not be able to enable subscription options on the group settings using Outlook on the web or Outlook desktop. Group owners might see the error, "The group update is in progress" error when they try to enable Subscription option. Admins trying to enable Subscription from Microsoft admin center might also see error, "Can't save 'Send copies of group conversations and events to group member's inboxes' Either your assigned product license doesn't include Exchange Online or you have recently created this group and it's still not ready for management". + +**Note**: This property is evaluated only when you add internal members from your organization. Guest user accounts are always subscribed when added as a member. You can manually remove subscriptions for guest users by using the Remove-UnifiedGroupLinks cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1158,7 +1209,9 @@ Accept wildcard characters: False The UnifiedGroupWelcomeMessageEnabled switch specifies whether to enable or disable sending system-generated welcome messages to users who are added as members to the Microsoft 365 Group. - To enable this setting, you don't need to specify a value with this switch. -- To disable this setting, use this exact syntax: -UnifiedGroupWelcomeMessageEnabled:$false. +- To disable this setting, use this exact syntax: `-UnifiedGroupWelcomeMessageEnabled:$false`. + +This setting only controls email send by the Microsoft 365 Group. It doesn't control email sent by connected products (for example, Teams or Viva Engage). This setting is enabled by default. @@ -1166,7 +1219,7 @@ This setting is enabled by default. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1182,7 +1235,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Online, Exchange Online Protection Required: False Position: Named @@ -1196,12 +1249,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-User.md b/exchange/exchange-ps/exchange/Set-User.md index bfd3fa3aeb..09606906d6 100644 --- a/exchange/exchange-ps/exchange/Set-User.md +++ b/exchange/exchange-ps/exchange/Set-User.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-user +online version: https://learn.microsoft.com/powershell/module/exchange/set-user applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Set-User schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Set-User cmdlet to modify user attributes. You can use this cmdlet to modify all objects that have user accounts (for example, user mailboxes, mail users, and user accounts). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,24 +30,31 @@ Set-User [-Identity] [-CanHaveCloudCache ] [-CertificateSubject ] [-City ] + [-ClearDataEncryptionPolicy] [-Company ] [-Confirm] [-CountryOrRegion ] [-CreateDTMFMap ] [-Department ] + [-DesiredWorkloads ] [-DisplayName ] [-DomainController ] + [-EXOModuleEnabled ] [-Fax ] [-FirstName ] [-Force] [-GeoCoordinates ] [-HomePhone ] [-IgnoreDefaultScope] + [-IsShadowMailbox ] [-Initials ] [-LastName ] [-LinkedCredential ] [-LinkedDomainController ] [-LinkedMasterAccount ] + [-MailboxRegion ] + [-MailboxRegionSuffix ] + [-ManagedOnboardingType ] [-Manager ] [-MobilePhone ] [-Name ] @@ -88,7 +95,7 @@ Set-User [-Identity] ## DESCRIPTION The Set-User cmdlet contains no mail-related properties for mailboxes or mail users. To modify the mail-related properties for a user, you need to use the corresponding cmdlet based on the object type (for example, Set-Mailbox or Set-MailUser). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -114,6 +121,7 @@ Performing this procedure on a linked mailbox removes all permissions on the mai The Identity parameter specifies the user that you want to modify. You can use any value that uniquely identifies the user. For example: - Name +- User principal name (UPN) - Distinguished name (DN) - Canonical DN - GUID @@ -280,6 +288,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ClearDataEncryptionPolicy +This parameter is available only in the cloud-based service. + +{{ Fill ClearDataEncryptionPolicy Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Company The Company parameter specifies the user's company. @@ -372,6 +398,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DesiredWorkloads +This parameter is available only in the cloud-based service. + +{{ Fill DesiredWorkloads Description }} + +```yaml +Type: Microsoft.Exchange.Data.MailboxWorkloadFlags +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName The DisplayName parameter specifies the display name of the user. The display name is visible in the Exchange admin center and in Active Directory. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). @@ -406,6 +450,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EXOModuleEnabled +This parameter is available only in the cloud-based service. + +The EXOModuleEnabled parameter specifies whether the user can connect to Exchange Online PowerShell in Microsoft 365 organizations using the Exchange Online PowerShell V3 module. Valid values are: + +- $true: The user can connect to Exchange Online PowerShell. +- $false: The user can't connect to Exchange Online PowerShell. + +The default value depends on the management roles that are assigned to the user. + + Access to Exchange Online PowerShell is also required for other features (for example, the ability to open the Exchange admin center (EAC)). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Fax The Fax parameter specifies the user's fax number. @@ -441,7 +510,9 @@ Accept wildcard characters: False ### -Force This parameter is available only in the cloud-based service. -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -462,6 +533,8 @@ The GeoCoordinates parameter specifies the user's location in latitude, longitud - Latitude and longitude: For example, "47.644125;-122.122411" - Latitude, longitude, and altitude: For example, "47.644125;-122.122411;161.432" +**Note**: If period separators don't work for you, use commas instead. + ```yaml Type: GeoCoordinates Parameter Sets: (All) @@ -494,9 +567,9 @@ Accept wildcard characters: False ### -IgnoreDefaultScope This parameter is available only in on-premises Exchange. -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -530,6 +603,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsShadowMailbox +This parameter is available only in the cloud-based service. + +{{ Fill IsShadowMailbox Description }} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LastName The LastName parameter specifies the user's last name. @@ -551,7 +642,7 @@ This parameter is available only in on-premises Exchange. The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). You can only use the LinkedCredential parameter with a linked user. @@ -619,6 +710,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MailboxRegion +This parameter is available only in the cloud-based service. + +{{ Fill MailboxRegion Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailboxRegionSuffix +This parameter is available only in the cloud-based service. + +{{ Fill MailboxRegionSuffix Description }} + +```yaml +Type: MailboxRegionSuffixValue +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ManagedOnboardingType +This parameter is available only in the cloud-based service. + +{{ Fill ManagedOnboardingType Description }} + +```yaml +Type: ManagedOnboardingType +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Manager The Manager parameter specifies the user's manager. @@ -638,7 +783,7 @@ Accept wildcard characters: False ### -MobilePhone The MobilePhone parameter specifies the user's primary mobile phone number. -**Note**: In Exchange Online, you can't use this parameter. Instead, use the Mobile parameter on the Set-AzureAdUser cmdlet in Azure AD PowerShell. +**Note**: In Exchange Online, you can't use this parameter. Instead, use the MobilePhone parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: String @@ -766,13 +911,13 @@ Accept wildcard characters: False ``` ### -PermanentlyClearPreviousMailboxInfo -This parameter is available or functional only in on-premise Exchange. +This parameter is functional only in the cloud-based service. -The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Exchange mailbox attributes on a user. You don't need to specify a value with this switch. +The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Exchange Online mailbox attributes on a user. You don't need to specify a value with this switch. Clearing these attributes might be required in mailbox move and re-licensing scenarios between on-premises Exchange and Microsoft 365. For more information, see [Permanently Clear Previous Mailbox Info](https://techcommunity.microsoft.com/t5/exchange-team-blog/permanently-clear-previous-mailbox-info/ba-p/607619). -**Caution**: This switch permanently deletes the existing cloud mailbox and its associated archive, prevents you from reconnecting to the mailbox, and prevents you from recovering content from the mailbox. +**Caution**: This switch prevents you from reconnecting to the mailbox and prevents you from recovering content from the mailbox. ```yaml Type: SwitchParameter @@ -790,7 +935,7 @@ Accept wildcard characters: False ### -Phone The Phone parameter specifies the user's office telephone number. -**Note**: In Exchange Online, you can't use this parameter. Instead, use the TelephoneNumber parameter on the Set-AzureAdUser cmdlet in Azure AD PowerShell. +**Note**: In Exchange Online, you can't use this parameter. Instead, use the BusinessPhones parameter on the [Update-MgUser](https://learn.microsoft.com/powershell/module/microsoft.graph.users/update-mguser) cmdlet in Microsoft Graph PowerShell. ```yaml Type: String @@ -872,13 +1017,19 @@ Accept wildcard characters: False ``` ### -RemotePowerShellEnabled -The RemotePowerShellEnabled parameter specifies whether the user has access to remote PowerShell. Remote PowerShell access is required to open the Exchange Management Shell or the Exchange admin center (EAC), even if you're trying to open the Exchange Management Shell or the EAC on the local Mailbox server. Valid values are: +**Note**: In cloud-based environments, this parameter is being deprecated, so use the EXOModuleEnabled parameter instead. -- $true: The user has access to remote PowerShell. -- $false: The user doesn't have access to remote PowerShell. +The RemotePowerShellEnabled parameter specifies whether the user has access to Exchange PowerShell. Valid values are: + +- $true: The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). +- $false: The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC. The default value depends on the management roles that are assigned to the user. +Access to Exchange PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server. + +A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them. + ```yaml Type: Boolean Parameter Sets: (All) @@ -1040,7 +1191,7 @@ This parameter is available only in the cloud-based service. The StsRefreshTokensValidFrom specifies the date-time that the user's STS refresh tokens are valid from. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -1163,7 +1314,7 @@ The VIP parameter specifies whether the user is a priority account. Valid values - $true: The user is a priority account. - $false: The user is not a priority account. -For more information about priority accounts, see [Manage and monitor priority accounts](https://docs.microsoft.com/microsoft-365/admin/setup/priority-accounts). +For more information about priority accounts, see [Manage and monitor priority accounts](https://learn.microsoft.com/microsoft-365/admin/setup/priority-accounts). ```yaml Type: Boolean @@ -1236,12 +1387,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-UserAnalyticsConfig.md b/exchange/exchange-ps/exchange/Set-UserAnalyticsConfig.md deleted file mode 100644 index 2450be9ae5..0000000000 --- a/exchange/exchange-ps/exchange/Set-UserAnalyticsConfig.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-useranalyticsconfig -applicable: Exchange Online -title: Set-UserAnalyticsConfig -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-UserAnalyticsConfig - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -**Note**: This cmdlet has been replaced by the **Set-MyAnalyticsFeatureConfig** cmdlet in the Exchange Online PowerShell V2 module version 2.0.4 or later. For connection instructions using the module, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -Use the Set-UserAnalyticsConfig cmdlet to modify the MyAnalytics privacy settings for cloud-based users. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-UserAnalyticsConfig -Identity -PrivacyMode [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-UserAnalyticsConfig -Identity "Kathleen Reiter" -PrivacyMode Opt-In -``` - -This example sets the MyAnalytics privacy setting to Opt-In for the user named Kathleen Reiter. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the user that you want to modify. You can use any value that uniquely identifies the user. For example: For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: RecipientIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -PrivacyMode -The PrivacyMode parameter specifies the MyAnalytics privacy setting for the user. Valid values are: - -- Excluded -- Opt-In -- Opt-Out - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: True -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md index f10cafc5e3..d036882c11 100644 --- a/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md +++ b/exchange/exchange-ps/exchange/Set-UserBriefingConfig.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/set-userbriefingconfig +online version: https://learn.microsoft.com/powershell/module/exchange/set-userbriefingconfig applicable: Exchange Online title: Set-UserBriefingConfig schema: 2.0.0 @@ -12,27 +12,33 @@ ms.author: chrisda # Set-UserBriefingConfig ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -Use the Set-UserBriefingConfig cmdlet to enable or disable the Briefing for a user. For more details about configuring the Briefing, see [Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin). +Use the Set-UserBriefingConfig cmdlet to enable or disable the Briefing email for a user. For more details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/Briefing/be-admin). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Set-UserBriefingConfig -Identity -Enabled [-ResultSize ] + [] ``` ## DESCRIPTION -This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator - Exchange Administrator - Insights Administrator -To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. ## EXAMPLES @@ -97,16 +103,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -## INPUTS +### 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 ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin) +[Configure Briefing email](https://learn.microsoft.com/Briefing/be-admin) diff --git a/exchange/exchange-ps/exchange/Set-UserPhoto.md b/exchange/exchange-ps/exchange/Set-UserPhoto.md index 630db5dfee..d2c06bedea 100644 --- a/exchange/exchange-ps/exchange/Set-UserPhoto.md +++ b/exchange/exchange-ps/exchange/Set-UserPhoto.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-userphoto -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/set-userphoto +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-UserPhoto schema: 2.0.0 author: chrisda @@ -12,11 +12,13 @@ ms.reviewer: # Set-UserPhoto ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +This cmdlet is available only in on-premises Exchange. -Use the Set-UserPhoto cmdlet to configure the user photos feature that allows users to associate a picture with their account. User photos appear in on-premises and cloud-based client applications, such as Outlook on the web, Lync, Skype for Business, and SharePoint. +Use the Set-UserPhoto cmdlet to configure the user photos feature that allows users to associate a picture with their account. User photos appear in client applications, such as Outlook, Microsoft Teams, and SharePoint. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +**Note**: In Microsoft 365, you can manage user photos in Microsoft Graph PowerShell. For instructions, see [Manage user photos in Microsoft Graph PowerShell](https://learn.microsoft.com/microsoft-365/admin/add-users/change-user-profile-photos#manage-user-photos-in-microsoft-graph-powershell). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,6 +31,7 @@ Set-UserPhoto [-Identity] [-DomainController ] [-IgnoreDefaultScope] [-PhotoType ] + [-UseCustomRouting] [-WhatIf] [] ``` @@ -41,6 +44,7 @@ Set-UserPhoto [-Identity] -PictureData [-GroupMailbox] [-IgnoreDefaultScope] [-PhotoType ] + [-UseCustomRouting] [-WhatIf] [] ``` @@ -56,6 +60,7 @@ Set-UserPhoto [-Identity] [-GroupMailbox] [-IgnoreDefaultScope] [-PhotoType ] + [-UseCustomRouting] [-WhatIf] [] ``` @@ -68,6 +73,7 @@ Set-UserPhoto [-Identity] -PictureStream [-GroupMailbox] [-IgnoreDefaultScope] [-PhotoType ] + [-UseCustomRouting] [-WhatIf] [] ``` @@ -81,18 +87,19 @@ Set-UserPhoto [-Identity] [-GroupMailbox] [-IgnoreDefaultScope] [-PhotoType ] + [-UseCustomRouting] [-WhatIf] [] ``` ## DESCRIPTION -The user photos feature allows users to associate a picture with their account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox. Administrators use the Set-UserPhoto cmdlet to configure user photos. Users can upload, preview, and save a user photo to their account by using the Outlook on the web Options page. When a user uploads a photo, a preview of the photo is displayed on the Outlook on the web Options page. This is the preview state, and creates the same result as running the Set-UserPhoto cmdlet using the Preview parameter. If the user clicks Save, the preview photo is saved as the user's photo. This is the same result as running the Set-UserPhoto -Save command or running both the Set-UserPhoto -Preview and Set-UserPhoto -Save commands. If the user cancels the preview photo on the Outlook on the web Options page, then the Set-UserPhoto -Cancel command is called. +The user photos feature allows users to associate a picture with their account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox. Administrators use the Set-UserPhoto cmdlet to configure user photos. Users can upload, preview, and save a user photo to their account in the Options page in Outlook on the web. When a user uploads a photo, a preview of the photo is displayed on the Options page in Outlook on the web. This is the preview state, and creates the same result as running the Set-UserPhoto cmdlet using the Preview parameter. If the user clicks Save, the preview photo is saved as the user's photo. This is the same result as running the `Set-UserPhoto -Save` command or running both the `Set-UserPhoto -Preview` and `Set-UserPhoto -Save` commands. If the user cancels the preview photo on the Options page in Outlook on the web, then the `Set-UserPhoto -Cancel` command is called. A user photo must be set for a user before you can run the Get-UserPhoto cmdlet to view information about the user's photo. Otherwise, you'll get an error message saying the user photo doesn't exist for the specified user. Alternatively, you can run the `Get-UserPhoto -Preview` command to view information about a preview photo. -**Note**: Changes to the user photo won't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. +**Notes**: Changes to the user photo won't appear in SharePoint until the affected user visits their profile page (My Site) or any SharePoint page that shows their large thumbnail image. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -106,6 +113,7 @@ This example uploads and saves a photo to Paul Cannon's user account using a sin ### Example 2 ```powershell Set-UserPhoto -Identity "Ann Beebe" -PictureData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\AnnBeebe.jpg")) -Preview + Set-UserPhoto "Ann Beebe" -Save ``` @@ -138,7 +146,7 @@ The Identity parameter specifies the identity of the user. You can use any value Type: MailboxIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -148,7 +156,7 @@ Accept wildcard characters: False ``` ### -Cancel -The Cancel switch parameter deletes the photo that's currently uploaded as the preview photo. You don't need to specify a value with this switch. +The Cancel switch deletes the photo that's currently uploaded as the preview photo. You don't need to specify a value with this switch. To delete the photo that's currently associated with a user's account, use the Remove-UserPhoto cmdlet. The Cancel switch only deletes the preview photo. @@ -156,7 +164,7 @@ To delete the photo that's currently associated with a user's account, use the R Type: SwitchParameter Parameter Sets: CancelPhoto Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -168,13 +176,13 @@ Accept wildcard characters: False ### -PictureData The PictureData parameter specifies the photo file that will be uploaded to the user's account. -This parameter uses the syntax: `([System.IO.File]::ReadAllBytes(""))`. For example `([System.IO.File]::ReadAllBytes("C:\Documents\Pictures\MyPhoto.jpg"))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] Parameter Sets: UploadPhotoData Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -187,7 +195,7 @@ Accept wildcard characters: False Type: Byte[] Parameter Sets: UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -203,7 +211,7 @@ The PictureStream parameter specifies the photo that will be uploaded to the use Type: Stream Parameter Sets: UploadPhotoStream Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -216,7 +224,7 @@ Accept wildcard characters: False Type: Stream Parameter Sets: UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -228,13 +236,13 @@ Accept wildcard characters: False ### -Preview The Preview switch uploads a preview photo for the user account. You don't need to specify a value with this switch. -A preview photo is the photo object that is uploaded to the user's account, but isn't saved. For example, if a user uploads a photo in Outlook on the web Options to preview before saving it. If you use the Preview switch to upload a preview photo, you need to run the command Set-UserPhoto -Save to save it as the user's photo. +A preview photo is the photo object that is uploaded to the user's account, but isn't saved. For example, if a user uploads a photo in Outlook on the web Options to preview before saving it. If you use the Preview switch to upload a preview photo, you need to run the command `Set-UserPhoto -Save` to save it as the user's photo. ```yaml Type: SwitchParameter Parameter Sets: UploadPreview Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -250,7 +258,7 @@ The Save switch specifies that the photo that's uploaded to the user's account w Type: SwitchParameter Parameter Sets: SavePhoto Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: Named @@ -265,11 +273,13 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho - 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`. - 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. +This cmdlet has a built-in pause, so use `-Confirm:$false` to skip the confirmation. + ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -279,8 +289,6 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. - The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml @@ -303,7 +311,7 @@ The GroupMailbox switch is required to modify Microsoft 365 Groups. You don't ne Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -313,9 +321,9 @@ Accept wildcard characters: False ``` ### -IgnoreDefaultScope -The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope. +The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. -Using the IgnoreDefaultScope switch introduces the following restrictions: +This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions: - You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically. - You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted. @@ -324,7 +332,7 @@ Using the IgnoreDefaultScope switch introduces the following restrictions: Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -340,7 +348,7 @@ This parameter is reserved for internal Microsoft use. Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -356,7 +364,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -370,12 +378,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md b/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md index 7c5dfa3699..d794753e4e 100644 --- a/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md +++ b/exchange/exchange-ps/exchange/Set-VivaInsightsSettings.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml Module Name: ExchangeOnlineManagement -online version: https://docs.microsoft.com/powershell/module/exchange/set-vivainsightssettings +online version: https://learn.microsoft.com/powershell/module/exchange/set-vivainsightssettings applicable: Exchange Online title: Set-VivaInsightsSettings schema: 2.0.0 @@ -12,13 +12,13 @@ ms.author: chrisda # Set-VivaInsightsSettings ## SYNOPSIS -This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [About the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2). +This cmdlet is available only in the Exchange Online PowerShell module. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module). -**Note**: This cmdlet is available only in version 2.0.5-Preview2 or later of the EXO V2 module. +**Note**: This cmdlet is available only in version 2.0.5 or later of the module. Use the Set-VivaInsightsSettings cmdlet to control user access to features in Viva Insights. Only users with provisioned Exchange Online mailboxes can access features within the Viva Insights app in Teams. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,13 +29,18 @@ Set-VivaInsightsSettings -Identity -Enabled -Feature ``` ## DESCRIPTION -This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: +This cmdlet requires the .NET Framework 4.7.2 or later. + +To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization: - Global Administrator - Exchange Administrator - Teams Administrator -To learn more about administrator role permissions in Azure Active Directory, see [Role template IDs](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference#role-template-ids). +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. ## EXAMPLES @@ -84,9 +89,10 @@ Accept wildcard characters: False ``` ### -Feature -The Feature parameter specifies feature of Microsoft Viva Insights in Microsoft Teams for the user. Current valid values are: +The Feature parameter specifies the feature of Microsoft Viva Insights in Microsoft Teams for the user. Valid values are: -- headspace: Represents all features of Headspace. +- Headspace: Represents all features of Headspace. +- MeetingEffectivenessSurvey: This value is available only in version 2.0.6-Preview2 of the module as part of a Private Preview. ```yaml Type: String @@ -123,12 +129,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md b/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md index eed59d61f6..09636df6f4 100644 --- a/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md +++ b/exchange/exchange-ps/exchange/Set-WebServicesVirtualDirectory.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-webservicesvirtualdirectory +online version: https://learn.microsoft.com/powershell/module/exchange/set-webservicesvirtualdirectory applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-WebServicesVirtualDirectory schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-WebServicesVirtualDirectory cmdlet to modify existing Exchange Web Services virtual directories that are used in Internet Information Services (IIS) on Microsoft Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ Set-WebServicesVirtualDirectory [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -265,7 +265,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -358,7 +360,7 @@ Accept wildcard characters: False ### -MRSProxyMaxConnections This parameter is available only in Exchange Server 2010. -The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). +The MRSProxyMaxConnections parameter specifies the maximum number of simultaneous move sessions that an instance of MRSProxy will accept. This setting accepts values from 0 to unlimited. The default value is 100. For more information about MRSProxy, see [Understanding Move Requests](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd298174(v=exchg.141)). ```yaml Type: Unlimited @@ -451,12 +453,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md b/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md index dc0d5deb7b..30872ecd30 100644 --- a/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md +++ b/exchange/exchange-ps/exchange/Set-X400AuthoritativeDomain.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-x400authoritativedomain +online version: https://learn.microsoft.com/powershell/module/exchange/set-x400authoritativedomain applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Set-X400AuthoritativeDomain schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Set-X400AuthoritativeDomain cmdlet to edit an existing X.400 authoritative domain for your organization. The X.400 authoritative domain defines the standard fields for the namespace appended to the recipient identity for all mailboxes assigned an X.400 address. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -66,7 +66,7 @@ organizational unit name - Abbreviation: OU1 to OU4 - Maximum character length: 32 -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -83,7 +83,7 @@ This example makes the following changes to an existing X.400 authoritative doma ## PARAMETERS ### -Identity -The Identity parameter specifies the X.400 authoritative domain tht you want to modify. You can use any value that uniquely identifies the domain. For example: +The Identity parameter specifies the X.400 authoritative domain that you want to modify. You can use any value that uniquely identifies the domain. For example: - Name - Distinguished name (DN) @@ -199,7 +199,7 @@ Accept wildcard characters: False ``` ### -X400ExternalRelay -The X400ExternalRelay parameter specifies whether this authoritative domain is an external relay domain. If you set the X400ExternalRelay parameter to $true, Exchange routes to the external address and doesn't treat resolution failures to this subdomain as errors. +The X400ExternalRelay parameter specifies whether this authoritative domain is an external relay domain. If you set the X400ExternalRelay parameter to $true, Exchange routes to the external address and doesn't treat resolution failures to this subdomain as errors. ```yaml Type: Boolean @@ -219,12 +219,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md b/exchange/exchange-ps/exchange/Start-ComplianceSearch.md index fe33aea538..ddcb34db75 100644 --- a/exchange/exchange-ps/exchange/Start-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Start-ComplianceSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/start-compliancesearch +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Start-ComplianceSearch schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Start-ComplianceSearch cmdlet to start stopped, completed or not started compliance searches in Exchange Server 2016 or later and in the Microsoft 365 compliance center. +Use the Start-ComplianceSearch cmdlet to start stopped, completed or not started compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,11 +30,11 @@ Start-ComplianceSearch [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -61,7 +61,7 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -80,7 +80,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -90,13 +90,15 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -112,7 +114,7 @@ The RetryOnError switch specifies whether to retry the search on any items that Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -122,7 +124,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf parameter doesn't work in the Microsoft 365 compliance center. +The WhatIf parameter doesn't work in the Microsoft Purview compliance portal. 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. @@ -130,7 +132,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -144,12 +146,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md index 1f3e173274..771a794112 100644 --- a/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Start-DatabaseAvailabilityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-databaseavailabilitygroup +online version: https://learn.microsoft.com/powershell/module/exchange/start-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Start-DatabaseAvailabilityGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Start-DatabaseAvailabilityGroup cmdlet to reincorporate one or more previously failed members of a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ Start-DatabaseAvailabilityGroup [-Identity] ] [-TargetServer ] [-WhatIf] @@ -33,7 +33,7 @@ Start-EdgeSynchronization [-Confirm] ## DESCRIPTION The Microsoft Exchange EdgeSync service that runs on Mailbox servers replicates data stored in Active Directory to the local Active Directory Lightweight Directory Services (AD LDS) store on the Edge Transport server. After the initial replication, one-way synchronization of changed data in Active Directory to AD LDS keeps this data up to date. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -66,7 +66,9 @@ Accept wildcard characters: False ``` ### -ForceFullSync -The ForceFullSync switch specifies whether to initiate a full edge synchronization. If you run the command without this switch, only changes since the last replication are synchronized. If you use this switch, the entire configuration information and recipient data are synchronized. +The ForceFullSync switch specifies whether to initiate a full edge synchronization. You don't need to specify a value with this switch. + +If you don't use this switch, only changes since the last replication are synchronized. If you use this switch, the entire configuration information and recipient data are synchronized. ```yaml Type: SwitchParameter @@ -81,8 +83,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForceUpdatecookie -The ForceUpdateCookie switch specifies whether to force the Microsoft Exchange EdgeSync service to update the replication cookie even if it encounters an error. The cookie maintains the changes in Active Directory since the previous EdgeSync replication. Normally, the Microsoft Exchange EdgeSync service doesn't update the cookie if it encounters any errors during replication. +### -ForceUpdateCookie +The ForceUpdateCookie switch specifies whether to force the Microsoft Exchange EdgeSync service to update the replication cookie even if it encounters an error. You don't need to specify a value with this switch. + +The cookie maintains the changes in Active Directory since the previous EdgeSync replication. Normally, the Microsoft Exchange EdgeSync service doesn't update the cookie if it encounters any errors during replication. ```yaml Type: SwitchParameter @@ -154,33 +158,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForceUpdatecookie -The ForceUpdateCookie switch specifies whether to force the Microsoft Exchange EdgeSync service to update the replication cookie even if it encounters an error. The cookie maintains the changes in Active Directory since the previous EdgeSync replication. Normally, the Microsoft Exchange EdgeSync service doesn't update the cookie if it encounters any errors during replication. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -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 -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md index 43c537c26d..598f93159b 100644 --- a/exchange/exchange-ps/exchange/Start-HistoricalSearch.md +++ b/exchange/exchange-ps/exchange/Start-HistoricalSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-historicalsearch +online version: https://learn.microsoft.com/powershell/module/exchange/start-historicalsearch applicable: Exchange Online, Exchange Online Protection title: Start-HistoricalSearch schema: 2.0.0 @@ -16,15 +16,15 @@ This cmdlet is available only in the cloud-based service. Use the Start-HistoricalSearch cmdlet to start a new historical search. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Start-HistoricalSearch -EndDate -ReportTitle -ReportType -StartDate + [-BlockStatus ] [-CompressFile ] + [-ConnectorType ] [-DeliveryStatus ] [-Direction ] [-DLPPolicy ] @@ -37,28 +37,30 @@ Start-HistoricalSearch -EndDate -ReportTitle -ReportType ] [-RecipientAddress ] [-SenderAddress ] + [-SmtpSecurityError ] + [-TLSUsed ] [-TransportRule ] [-Url ] [] ``` ## DESCRIPTION -A historical search provides message trace and report details in a comma-separated value (CSV) file for messages that are aged between 1-4 hours (depending on your environment) and 90 days old. There is a limit of 250 historical searches that you can submit in a 24 hour period; you'll be warned if you're nearing the daily quota. Cancelled searches count against the daily quota. Also, in each CSV file there is a limit of 50000 results or lines. +A historical search provides message trace and report details in a comma-separated value (CSV) file for messages that are aged between 1-4 hours (depending on your environment) and 90 days old. There is a limit of 250 historical searches that you can submit in a 24 hour period; you'll be warned if you're nearing the daily quota. Cancelled searches count against the daily quota. Also, in each CSV file there is a limit of 100000 results or lines. If you specify a distribution group, all messages might not be returned in the results. To ensure that all messages are returned, specify the individual recipient. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -Start-HistoricalSearch -ReportTitle "Fabrikam Search" -StartDate 1/1/2018 -EndDate 1/7/2018 -ReportType MessageTrace -SenderAddress michelle@fabrikam.com -NotifyAddress chris@contoso.com +Start-HistoricalSearch -ReportTitle "Fabrikam Search" -StartDate 1/1/2023 -EndDate 1/7/2023 -ReportType MessageTrace -SenderAddress michelle@fabrikam.com -NotifyAddress chris@contoso.com ``` This example starts a new historical search named "Fabrikam Search" that has the following properties: -- Date range: January 1, 2018 to January 7, 2018 +- Date range: January 1 2023 to January 6 2023. Because we aren't specifying the time of day, the value 0:00 AM is used. In this example, the date range is equivalent to -StartDate "1/1/2023 0:00 AM" -EndDate "1/7/2023 0:00 AM" - Report type: Message trace - Sender address: michelle@fabrikam.com - Internal notification email address: chris@contoso.com @@ -68,9 +70,11 @@ This example starts a new historical search named "Fabrikam Search" that has the ### -EndDate The EndDate parameter specifies the end date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". + +If you don't specify the time of day, the default value 0:00 AM is used. For example, the value 12/31/2022 is really "12/31/2022 0:00 AM", which means no data from 12/31/2022 is included (only data from 12/30/2022 is included). -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. ```yaml Type: DateTime @@ -88,7 +92,7 @@ Accept wildcard characters: False ### -ReportTitle The ReportTitle parameter specifies a descriptive name for the historical search. If the value contains spaces, enclose the value in quotation marks ("). -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. ```yaml Type: String @@ -107,19 +111,18 @@ Accept wildcard characters: False The ReportType parameter specifies the type of historical search that you want to perform. You can use one of the following values: - ATPReport: Defender for Office 365 File types report and Defender for Office 365 Message disposition report -- ATPV2: Exchange Online Protection and Defender for Office 365 Malware detection in email report. -- ATPDocument: Defender for Office 365 Content Malware Report for Safe Attachments for SharePoint, OneDrive, and Microsoft Teams. +- ConnectorReport: Inbound/Outbound Message Report. - DLP: Data Loss Prevention Report. -- Malware: Malware Detections Report. - MessageTrace: Message Trace Report. - MessageTraceDetail: Message Trace Details Report. -- Phish: Exchange Online Protection and Defender for Office 365 E-mail Phish Report. +- OutboundSecurityReport: Outbound Message in Transit Security Report. +- P2SenderAttribution: P2 Sender Attribution Report. - SPAM: SPAM Detections Report. - Spoof: Spoof Mail Report. - TransportRule: Transport or Mail Flow Rules Report. - UnifiedDLP: Unified Data Loss Prevention Report. -You also need to specify at least one of the following values in the command: MessageID, RecipientAddress, or SenderAddress. +You also need to use at least one of the following parameters in the command: MessageID, RecipientAddress, or SenderAddress. ```yaml Type: HistoricalSearchReportType @@ -137,7 +140,7 @@ Accept wildcard characters: False ### -StartDate The StartDate parameter specifies the start date of the date range. -Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". +Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM". ```yaml Type: DateTime @@ -152,6 +155,22 @@ Accept pipeline input: True Accept wildcard characters: False ``` +### -BlockStatus +The BlockStatus parameter filters the results in OutboundSecurityReport reports by the status of messages sent externally, messages blocked due to security checks, or messages sent successfully. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CompressFile {{ Fill CompressFile Description }} @@ -168,6 +187,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ConnectorType +The ConnectorType parameter filters the results in ConnectorReport reports by the connector type. Valid values are: + +- OnPremises +- Partner +- NoConnector + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DeliveryStatus The DeliveryStatus parameter filters the results by the delivery status of the message. You can use one of the following values: @@ -259,7 +298,7 @@ Accept wildcard characters: False ### -Locale The Locale parameter filters the results by the locale of the message. -Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://docs.microsoft.com/dotnet/api/system.globalization.cultureinfo). +Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see [CultureInfo Class](https://learn.microsoft.com/dotnet/api/system.globalization.cultureinfo). ```yaml Type: CultureInfo @@ -291,7 +330,7 @@ Accept wildcard characters: False ``` ### -NetworkMessageID -{{ Fill NetworkMessageID Description }} +The NetworkMessageId parameter filters the message tracking log entries by the value of the NetworkMessageId field. This field contains a unique message ID value that persists across copies of the message that may be created due to bifurcation or distribution group expansion. An example value is 1341ac7b13fb42ab4d4408cf7f55890f. ```yaml Type: MultiValuedProperty @@ -372,8 +411,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SmtpSecurityError +The SmtpSecurityError parameter filters the results in OutboundSecurityReport reports by the error type of blocked messages when sent externally. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TLSUsed +The TLSUsed parameter filters the results in ConnectorReport reports by the TLS version. Valid values are: + +- No Tls +- TLS1.2 +- TLS1.3 + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TransportRule -The TransportRule parameter filters the results by the name of the transport rule that acted on the message. You can specify multiple transport rules separated by commas. +The TransportRule parameter filters the results by the name of the Exchange mail flow rule (also known as a transport rule) that acted on the message. You can specify multiple transport rules separated by commas. ```yaml Type: MultiValuedProperty @@ -409,12 +484,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md b/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md index f83d5d79c5..2afb3f3ca7 100644 --- a/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md +++ b/exchange/exchange-ps/exchange/Start-InformationBarrierPoliciesApplication.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/stop-informationbarrierpoliciesapplication +applicable: Security & Compliance title: Start-InformationBarrierPoliciesApplication schema: 2.0.0 author: chrisda @@ -12,23 +12,24 @@ ms.reviewer: # Start-InformationBarrierPoliciesApplication ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Start-InformationBarrierPoliciesApplication cmdlet to apply active information barrier policies in the Microsoft 365 compliance center. +Use the Start-InformationBarrierPoliciesApplication cmdlet to apply active information barrier policies in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Start-InformationBarrierPoliciesApplication [[-Identity] ] + [-CleanupGroupSegmentLink] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -48,7 +49,7 @@ This parameter is reserved for internal Microsoft use. Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: 0 @@ -57,6 +58,22 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -CleanupGroupSegmentLink +The CleanupGroupSegmentLink switch specifies whether to remove group segment links. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Security & Compliance + +Required: False +Position: Named +Default value: None +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. @@ -67,7 +84,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -77,13 +94,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -97,16 +114,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[New-InformationBarrierPolicy](https://docs.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) +[New-InformationBarrierPolicy](https://learn.microsoft.com/powershell/module/exchange/new-informationbarrierpolicy) diff --git a/exchange/exchange-ps/exchange/Start-MailboxAssistant.md b/exchange/exchange-ps/exchange/Start-MailboxAssistant.md new file mode 100644 index 0000000000..52a05e9bcb --- /dev/null +++ b/exchange/exchange-ps/exchange/Start-MailboxAssistant.md @@ -0,0 +1,182 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxassistant +applicable: Exchange Server 2019 +title: Start-MailboxAssistant +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- +# Start-MailboxAssistant + +## SYNOPSIS +This cmdlet is available only in Exchange Server 2019 in Cumulative Update 11 (CU11) or later. + +Use the Start-MailboxAssistant cmdlet to start processing of a mailbox by the specified assistant. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Start-MailboxAssistant [-Identity] -AssistantName + [-Confirm] + [-DomainController ] + [-Parameters ] + [-SoftDeletedMailbox] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +Start-MailboxAssistant -Identity "Chris" -AssistantName BigFunnelRetryFeederTimeBasedAssistant +``` + +This example starts the `BigFunnelRetryFeederTimeBasedAssistant` assistant and lets it process the mailbox of the user "Chris". The assistant indexes the mailbox items that were not indexed previously. + +**Note**: You first need to create a setting override as described in [Incomplete search results after installing an Exchange Server 2019 update](https://support.microsoft.com/topic/incomplete-search-results-after-installing-an-exchange-server-2019-update-96ae2ef0-4569-4327-8d0c-8a3c1abdc1f6). + +## PARAMETERS + +### -Identity +The Identity parameter specifies the user whose mailbox should be processed by the Mailbox Assistant. Valid values are: + +- Distinguished name (DN) +- SamAccountName +- User ID or user principal name (UPN) + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -AssistantName +The AssistantName parameter specifies the assistant that should process the mailbox. Valid values are: + +- BigFunnelRetryFeederTimeBasedAssistant + +Values are case sensitive. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: True +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SoftDeletedMailbox +The SoftDeletedMailbox switch specifies that the mailbox to be processed by the assistant is a soft-deleted mailbox. + +Soft-deleted mailboxes are deleted mailboxes that are still recoverable. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2019 + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2019 + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Start-MailboxSearch.md b/exchange/exchange-ps/exchange/Start-MailboxSearch.md index d196c6d0e4..a84f5ccd78 100644 --- a/exchange/exchange-ps/exchange/Start-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Start-MailboxSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-mailboxsearch +online version: https://learn.microsoft.com/powershell/module/exchange/start-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Start-MailboxSearch schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Start-MailboxSearch cmdlet to restart or resume a mailbox search that's been stopped. -**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,9 +40,9 @@ When restarting a search, any previous results returned by the same search and c In Exchange 2013 or later, mailbox searches are also used for In-Place Hold. However, you can't start or stop In-Place Hold using the Start-MailboxSearch and Stop-MailboxSearch cmdlets. -For more details, see [In-Place Hold and Litigation Hold in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/holds/holds) and [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). +For more details, see [In-Place Hold and Litigation Hold in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/holds/holds) and [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,7 +109,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -179,12 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md index d6bd5d7cf5..2e90b4cf4d 100644 --- a/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md +++ b/exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-managedfolderassistant +online version: https://learn.microsoft.com/powershell/module/exchange/start-managedfolderassistant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Start-ManagedFolderAssistant schema: 2.0.0 @@ -16,22 +16,32 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Start-ManagedFolderAssistant cmdlet to immediately start messaging records management (MRM) processing of mailboxes that you specify. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### Default +### Identity (Default) ``` -Start-ManagedFolderAssistant [-Identity] +Start-ManagedFolderAssistant [-Identity] [-HoldCleanup] [-AggMailboxCleanup] + [-Confirm] [-DomainController ] + [-WhatIf] + [] +``` + +### ComplianceBoundaryAssistantParameterSet +``` +Start-ManagedFolderAssistant [-Identity] [-AdaptiveScope] + [-AggMailboxCleanup] [-Confirm] - [-HoldCleanup] + [-FullCrawl] + [-InactiveMailbox] [-WhatIf] [] ``` -### ComplianceJobAssistant +### ComplianceJobAssistantParameterSet ``` Start-ManagedFolderAssistant [-Identity] [-ComplianceJob] [-AggMailboxCleanup] @@ -42,7 +52,7 @@ Start-ManagedFolderAssistant [-Identity] [-Compli [] ``` -### DataGovernanceAssistant +### DataGovernanceAssistantParameterSet ``` Start-ManagedFolderAssistant [-Identity] [-DataGovernance] [-AggMailboxCleanup] @@ -53,9 +63,31 @@ Start-ManagedFolderAssistant [-Identity] [-DataGo [] ``` -### HoldCleanup +### ElcB2DumpsterArchiverAssistantParameterSet +``` +Start-ManagedFolderAssistant [-Identity] [-B2DumpsterArchiver] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [] +``` + +### ElcB2IPMArchiverAssistantParameterSet +``` +Start-ManagedFolderAssistant [-Identity] [-B2IPMArchiver] + [-AggMailboxCleanup] + [-Confirm] + [-FullCrawl] + [-InactiveMailbox] + [-WhatIf] + [] +``` + +### HoldCleanupParameterSet ``` -Start-ManagedFolderAssistant [-Identity] -HoldCleanup +Start-ManagedFolderAssistant [-Identity] [-HoldCleanup] [-AggMailboxCleanup] [-Confirm] [-FullCrawl] @@ -64,7 +96,7 @@ Start-ManagedFolderAssistant [-Identity] -HoldCle [] ``` -### StopHoldCleanup +### StopHoldCleanupParameterSet ``` Start-ManagedFolderAssistant [-Identity] [-StopHoldCleanup] [-AggMailboxCleanup] @@ -84,7 +116,7 @@ If you use these parameters in scheduled commands or scripts, we recommend that For more information, see [KB4032361](https://support.microsoft.com/help/4032361). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,7 +150,7 @@ The Identity parameter specifies the mailbox to be processed. In cross-premises - SamAccountName - User ID or user principal name (UPN) -**Note**: In the cloud-based service, if you receive an error, try using the mailbox GUID for the value of this parameter. You can get the mailbox GUID value by replacing with the email address of the user and running the following command: `Get-Mailbox -User | Format-List *GUID,MailboxLocations`. +**Note**: In the cloud-based service, if you receive an error, try using the mailbox GUID for the value of this parameter. You can get the mailbox GUID value by replacing \ with the email address of the user and running the following command: `Get-Mailbox -User | Format-List *GUID,MailboxLocations`. ```yaml Type: MailboxOrMailUserIdParameter @@ -133,29 +165,34 @@ Accept pipeline input: True Accept wildcard characters: False ``` -### -HoldCleanup -The HoldCleanup switch instructs the Managed Folder Assistant to clean up duplicate versions of items in the Recoverable Items folder that may have been created when a mailbox is on In-Place Hold, Litigation Hold, or has Single Item Recovery enabled. You don't need to specify a value with this switch. +### -AdaptiveScope +This parameter is available only in the cloud-based service. -Removing duplicate items from the Recoverable Items folder reduces the folder size and may help prevent reaching Recoverable Items quota limits. For more details about Recoverable Items quota limits, see [Recoverable Items folder in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). +{{ Fill AdaptiveScope Description }} ```yaml Type: SwitchParameter -Parameter Sets: HoldCleanup +Parameter Sets: ComplianceBoundaryAssistantParameterSet Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -AggMailboxCleanup +The AggMailboxCleanup switch specifies aggregate mailbox cleanup. You don't need to specify a value with this switch. + +This switch cleans up aggregate mailboxes, audits, and calendar logging. + ```yaml Type: SwitchParameter -Parameter Sets: Default +Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -164,14 +201,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AggMailboxCleanup -This parameter is reserved for internal Microsoft use. +### -B2DumpsterArchiver +This parameter is available only in the cloud-based service. + +{{ Fill B2DumpsterArchiver Description }} ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: ElcB2DumpsterArchiverAssistantParameterSet Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -B2IPMArchiver +This parameter is available only in the cloud-based service. + +{{ Fill B2IPMArchiver Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ElcB2IPMArchiverAssistantParameterSet +Aliases: +Applicable: Exchange Online Required: False Position: Named @@ -187,7 +244,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter -Parameter Sets: ComplianceJobAssistant +Parameter Sets: ComplianceJobAssistantParameterSet Aliases: Applicable: Exchange Online @@ -224,7 +281,7 @@ This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter -Parameter Sets: DataGovernanceAssistant +Parameter Sets: DataGovernanceAssistantParameterSet Aliases: Applicable: Exchange Online @@ -242,7 +299,7 @@ The DomainController parameter specifies the domain controller that's used by th ```yaml Type: Fqdn -Parameter Sets: Default +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 @@ -260,7 +317,7 @@ The FullCrawl switch recalculates the application of tags across the whole mailb ```yaml Type: SwitchParameter -Parameter Sets: ComplianceJobAssistant, DataGovernanceAssistant, HoldCleanup, StopHoldCleanup +Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet Aliases: Applicable: Exchange Online @@ -271,10 +328,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -HoldCleanup +The HoldCleanup switch instructs the Managed Folder Assistant to clean up duplicate versions of items in the Recoverable Items folder that may have been created when a mailbox is on In-Place Hold, Litigation Hold, or has Single Item Recovery enabled. You don't need to specify a value with this switch. + +Removing duplicate items from the Recoverable Items folder reduces the folder size and may help prevent reaching Recoverable Items quota limits. For more details about Recoverable Items quota limits, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder). + +```yaml +Type: SwitchParameter +Parameter Sets: Identity, HoldCleanupParameterSet +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InactiveMailbox This parameter is available only in the cloud-based service. -The InactiveMailbox switch runs the command only inactive mailboxes. You don't need to specify a value with this switch. +The InactiveMailbox switch runs the command only on inactive mailboxes. You don't need to specify a value with this switch. An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. @@ -282,7 +357,7 @@ When you use this switch, items aren't moved from the inactive mailbox to the ar ```yaml Type: SwitchParameter -Parameter Sets: ComplianceJobAssistant, DataGovernanceAssistant, HoldCleanup, StopHoldCleanup +Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet Aliases: Applicable: Exchange Online @@ -296,17 +371,17 @@ Accept wildcard characters: False ### -StopHoldCleanup This parameter is available only in the cloud-based service. -The StopHoldCleanup parameter stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch. +The StopHoldCleanup switch stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch. A hold clean-up command will run until it completely scans the Recoverable Items folder for duplicate versions of items (it even continues after an interruption). In some cases, the hold clean-up command gets stuck, which can block other regular MRM tasks on the mailbox (for example, expiring items). The StopHoldCleanup switch tells MRM to abandon the stuck hold clean-up task so that regular tasks can continue. ```yaml Type: SwitchParameter -Parameter Sets: StopHoldCleanup +Parameter Sets: StopHoldCleanupParameterSet Aliases: Applicable: Exchange Online -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -334,16 +409,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES ## RELATED LINKS -[Export-MailboxDiagnosticLogs](https://docs.microsoft.com/powershell/module/exchange/Export-MailboxDiagnosticLogs) +[Export-MailboxDiagnosticLogs](https://learn.microsoft.com/powershell/module/exchange/Export-MailboxDiagnosticLogs) diff --git a/exchange/exchange-ps/exchange/Start-MigrationBatch.md b/exchange/exchange-ps/exchange/Start-MigrationBatch.md index c17b2b9be3..cf1d3e9731 100644 --- a/exchange/exchange-ps/exchange/Start-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Start-MigrationBatch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-migrationbatch +online version: https://learn.microsoft.com/powershell/module/exchange/start-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Start-MigrationBatch schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Start-MigrationBatch cmdlet to start a move request or migration batch that was created with the New-MigrationBatch cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ The Start-MigrationBatch cmdlet also will resume a Stopped migration batch or re In the cloud-based service, the Start-MigrationBatch cmdlet can be run at any time to retry failed users within the batch. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,7 +124,9 @@ Accept wildcard characters: False ### -Validate This parameter is available only in on-premises Exchange. -The Validate parameter specifies whether to start the migration batch in the validation stage of the migration process. If you include this parameter, the migration performs a validation check of the mailboxes in the batch. +The Validate switch starts the migration batch in the validation stage of the migration process. You don't need to specify a value with this switch. + +If you use this switch, the migration performs a validation check of the mailboxes in the batch. ```yaml Type: SwitchParameter @@ -160,12 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Start-MigrationUser.md b/exchange/exchange-ps/exchange/Start-MigrationUser.md index 2612d7484a..be88fe1878 100644 --- a/exchange/exchange-ps/exchange/Start-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Start-MigrationUser.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-migrationuser -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/start-migrationuser +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Start-MigrationUser schema: 2.0.0 author: chrisda @@ -12,26 +12,25 @@ ms.reviewer: # Start-MigrationUser ## SYNOPSIS -This cmdlet is available only in the cloud-based service. +This cmdlet is functional only in the cloud-based service. Use the Start-MigrationUser cmdlet to start the migration of a user in an existing migration batch. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Start-MigrationUser [[-Identity] ] [-Confirm] + [-DomainController ] [-Partition ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,7 +52,7 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -72,7 +71,25 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +99,8 @@ Accept wildcard characters: False ``` ### -Partition +This parameter is available only in the cloud-based service. + This parameter is reserved for internal Microsoft use. ```yaml @@ -104,7 +123,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,12 +137,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md b/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md index 74f7d1e5f2..3ad1a2652d 100644 --- a/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md +++ b/exchange/exchange-ps/exchange/Start-RetentionAutoTagLearning.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/start-retentionautotaglearning +online version: https://learn.microsoft.com/powershell/module/exchange/start-retentionautotaglearning applicable: Exchange Server 2010 title: Start-RetentionAutoTagLearning schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in Exchange Server 2010. Use the Start-RetentionAutoTagLearning cmdlet to start auto-tagging for a specified mailbox or to cross-validate auto-tagging results for the mailbox. -Messaging records management (MRM) must be configured before the Start-RetentionAutoTagLearning cmdlet can be used. For more information, see [Understanding Retention Tags and Retention Policies](https://docs.microsoft.com/previous-versions/office/exchange-server-2010/dd297955(v=exchg.141)). +Messaging records management (MRM) must be configured before the Start-RetentionAutoTagLearning cmdlet can be used. For more information, see [Understanding Retention Tags and Retention Policies](https://learn.microsoft.com/previous-versions/office/exchange-server-2010/dd297955(v=exchg.141)). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ Start-RetentionAutoTagLearning [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -100,7 +100,7 @@ Accept wildcard characters: False ``` ### -CrossValidate -The CrossValidate switch specifies whether items in the specified mailbox are being auto-tagged. +The CrossValidate switch specifies whether items in the specified mailbox are being auto-tagged. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -116,7 +116,7 @@ Accept wildcard characters: False ``` ### -Clear -The Clear switch specifies whether to clear auto-tags from the specified mailbox. +The Clear switch specifies whether to clear auto-tags from the specified mailbox. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -189,7 +189,9 @@ Accept wildcard characters: False ``` ### -Train -The Train switch specifies whether to start the training algorithm for auto-tagging on the specified mailbox. This switch is especially useful for retraining. No values are required with this switch. +The Train switch specifies whether to start the training algorithm for auto-tagging on the specified mailbox. You don't need to specify a value with this switch. + +This switch is especially useful for retraining. ```yaml Type: SwitchParameter @@ -225,12 +227,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md b/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md index 49b5d858bd..a0b52107ee 100644 --- a/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md +++ b/exchange/exchange-ps/exchange/Stop-ComplianceSearch.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-compliancesearch -applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/stop-compliancesearch +applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance title: Stop-ComplianceSearch schema: 2.0.0 author: chrisda @@ -14,9 +14,9 @@ ms.reviewer: ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Stop-ComplianceSearch cmdlet to stop running compliance searches in Exchange Server 2016 or later and in the Microsoft 365 compliance center. +Use the Stop-ComplianceSearch cmdlet to stop running compliance searches in Exchange Server 2016 or later and in the Microsoft Purview compliance portal. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,11 +28,11 @@ Stop-ComplianceSearch [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). In on-premises Exchange, this cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -59,7 +59,7 @@ You can find these values by running the command Get-ComplianceSearch | Format-T Type: ComplianceSearchIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: True Position: 1 @@ -78,7 +78,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -88,7 +88,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -96,7 +96,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Required: False Position: Named @@ -110,12 +110,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md b/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md index a4eedab8fa..c9f3ae6135 100644 --- a/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md +++ b/exchange/exchange-ps/exchange/Stop-DatabaseAvailabilityGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-databaseavailabilitygroup +online version: https://learn.microsoft.com/powershell/module/exchange/stop-databaseavailabilitygroup applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Stop-DatabaseAvailabilityGroup schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Stop-DatabaseAvailabilityGroup cmdlet to mark a member of a database availability group (DAG) as failed, or to mark all DAG members in a specific Active Directory site as failed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -43,7 +43,7 @@ Stop-DatabaseAvailabilityGroup [-Identity] ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -48,7 +48,7 @@ The Identity parameter specifies the active application of information barrier p Type: PolicyIdParameter Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 0 @@ -67,7 +67,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -77,13 +77,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -97,16 +97,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS -[Define policies for information barriers](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-policies) +[Define policies for information barriers](https://learn.microsoft.com/purview/information-barriers-policies) -[Edit (or remove) information barrier policies](https://docs.microsoft.com/microsoft-365/compliance/information-barriers-edit-segments-policies) +[Edit (or remove) information barrier policies](https://learn.microsoft.com/purview/information-barriers-edit-segments-policies) diff --git a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md b/exchange/exchange-ps/exchange/Stop-MailboxSearch.md index aec4bedce5..b78b8cb8b3 100644 --- a/exchange/exchange-ps/exchange/Stop-MailboxSearch.md +++ b/exchange/exchange-ps/exchange/Stop-MailboxSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-mailboxsearch +online version: https://learn.microsoft.com/powershell/module/exchange/stop-mailboxsearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Stop-MailboxSearch schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Stop-MailboxSearch cmdlet to stop a mailbox search that's in progress. -**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance Center PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://docs.microsoft.com/microsoft-365/compliance/legacy-ediscovery-retirement). +**Note**: As of October 2020, the \*-MailboxSearch cmdlets are retired in Exchange Online PowerShell. Use the \*-ComplianceSearch cmdlets in Security & Compliance PowerShell instead. For more information, see [Retirement of legacy eDiscovery tools](https://learn.microsoft.com/purview/ediscovery-legacy-retirement). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +31,9 @@ Stop-MailboxSearch [-Identity] ``` ## DESCRIPTION -In Microsoft Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can start and stop a mailbox search. For more information, see [In-Place eDiscovery in Exchange Server](https://docs.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). +In Microsoft Exchange, mailbox searches are used for In-Place eDiscovery and In-Place Hold. You can start and stop a mailbox search. For more information, see [In-Place eDiscovery in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/ediscovery/ediscovery). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -120,12 +120,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md b/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md index 98cf2644f7..0b03abf051 100644 --- a/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md +++ b/exchange/exchange-ps/exchange/Stop-ManagedFolderAssistant.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-managedfolderassistant +online version: https://learn.microsoft.com/powershell/module/exchange/stop-managedfolderassistant applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Stop-ManagedFolderAssistant schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Stop-ManagedFolderAssistant cmdlet to immediately stop messaging records management (MRM) from processing users' mailboxes on the specified servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Stop-ManagedFolderAssistant [[-Identity] ] ## DESCRIPTION The Managed Folder Assistant uses the managed folder mailbox policy settings of users to process mailbox items for retention and journaling as needed. Use the Stop-ManagedFolderAssistant cmdlet to stop the Managed Folder Assistant as soon as processing of the current mailbox is completed. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -130,12 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Stop-MigrationBatch.md b/exchange/exchange-ps/exchange/Stop-MigrationBatch.md index 80c2b95f74..2c68616341 100644 --- a/exchange/exchange-ps/exchange/Stop-MigrationBatch.md +++ b/exchange/exchange-ps/exchange/Stop-MigrationBatch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-migrationbatch +online version: https://learn.microsoft.com/powershell/module/exchange/stop-migrationbatch applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Stop-MigrationBatch schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Stop-MigrationBatch cmdlet to stop the processing of a migration batch that's in progress. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Stop-MigrationBatch [[-Identity] ] ## DESCRIPTION The Stop-MigrationBatch cmdlet stops the migration batch that's being processed in your on-premises Exchange organization or by the cloud-based migration service running in Microsoft 365. You can only stop migration batches that have mailboxes that are still in the process of being migrated or are waiting to be migrated. Stopping a migration won't affect mailboxes that have been migrated already. The migration of mailboxes that are being actively migrated is stopped immediately. If all migration requests in a migration batch are completed or failed, this cmdlet won't run. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -144,12 +144,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Stop-MigrationUser.md b/exchange/exchange-ps/exchange/Stop-MigrationUser.md index 6667b564e9..ccaca8fe4d 100644 --- a/exchange/exchange-ps/exchange/Stop-MigrationUser.md +++ b/exchange/exchange-ps/exchange/Stop-MigrationUser.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/stop-migrationuser -applicable: Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/stop-migrationuser +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Stop-MigrationUser schema: 2.0.0 author: chrisda @@ -12,26 +12,25 @@ ms.reviewer: # Stop-MigrationUser ## SYNOPSIS -This cmdlet is available only in the cloud-based service. +This cmdlet is functional only in the cloud-based service. Use the Stop-MigrationUser cmdlet to stop the migration of a user in an existing migration batch. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX ``` Stop-MigrationUser [[-Identity] ] [-Confirm] + [-DomainController ] [-Partition ] [-WhatIf] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -53,7 +52,7 @@ You can also identify the user by the GUID value in the MigrationUser property f Type: MigrationUserIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: 1 @@ -72,7 +71,25 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController +This parameter is available only in on-premises Exchange. + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -82,6 +99,8 @@ Accept wildcard characters: False ``` ### -Partition +This parameter is available only in the cloud-based service. + This parameter is reserved for internal Microsoft use. ```yaml @@ -104,7 +123,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online Required: False Position: Named @@ -118,12 +137,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md index a65d4cc90b..bbd7d1ecfa 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxDatabaseCopy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-mailboxdatabasecopy +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Suspend-MailboxDatabaseCopy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Suspend-MailboxDatabaseCopy cmdlet to block replication and replay activities (log copying and replay) or activation for a database configured with two or more database copies. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +42,7 @@ Suspend-MailboxDatabaseCopy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,7 +79,7 @@ Accept wildcard characters: False ``` ### -ActivationOnly -The ActivationOnly switch specifies whether to suspend only activation for the mailbox database copy. +The ActivationOnly switch specifies whether to suspend only activation for the mailbox database copy. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -129,6 +129,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableReplayLag +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: EnableReplayLag +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SuspendComment The SuspendComment parameter specifies the reason that the database copy is being suspended. This parameter is limited to 512 characters. @@ -161,33 +177,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReplayLag -This parameter is reserved for internal Microsoft use. - -```yaml -Type: SwitchParameter -Parameter Sets: EnableReplayLag -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -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/p/?LinkID=113216). ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md index 149e683199..5f063c4f44 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxExportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-mailboxexportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxexportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Suspend-MailboxExportRequest schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Suspend-MailboxExportRequest cmdlet to suspend an export request any time after the request was created, but before the request reaches the status of Completed. You can resume the request by using the Resume-MailboxExportRequest cmdlet. -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Suspend-MailboxExportRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -140,12 +140,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md index cd889fad38..41e44b0123 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxImportRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-mailboximportrequest +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboximportrequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Suspend-MailboxImportRequest schema: 2.0.0 @@ -16,11 +16,11 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Suspend-MailboxImportRequest cmdlet to suspend an import request any time after the request was created, but before the request reaches the status of Completed. You can resume the move request by using the Resume-MailboxImportRequest cmdlet. -NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://docs.microsoft.com/microsoft-365/compliance/use-network-upload-to-import-pst-files). +NOTE: This cmdlet is no longer supported in Exchange Online. To import a .pst file in Exchange Online, see [Use network upload to import PST files](https://learn.microsoft.com/purview/use-network-upload-to-import-pst-files). -This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://docs.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). +This cmdlet is available only in the Mailbox Import Export role, and by default, the role isn't assigned to any role groups. To use this cmdlet, you need to add the Mailbox Import Export role to a role group (for example, to the Organization Management role group). For more information, see [Add a role to a role group](https://learn.microsoft.com/Exchange/permissions/role-groups#add-a-role-to-a-role-group). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ Suspend-MailboxImportRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -144,12 +144,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md b/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md index 9a69a28cc4..ca7cdcbde0 100644 --- a/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MailboxRestoreRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-mailboxrestorerequest +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-mailboxrestorerequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Suspend-MailboxRestoreRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Suspend-MailboxRestoreRequest cmdlet to suspend a restore request any time after the request was created, but before the request reaches the status of Completed. You can resume the restore request by using the Resume-MailboxRestoreRequest cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Suspend-MailboxRestoreRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -142,12 +142,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Suspend-Message.md b/exchange/exchange-ps/exchange/Suspend-Message.md index 445057e9b0..e978e8d3de 100644 --- a/exchange/exchange-ps/exchange/Suspend-Message.md +++ b/exchange/exchange-ps/exchange/Suspend-Message.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-message +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-message applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Suspend-Message schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Suspend-Message cmdlet to prevent delivery of a particular message in a queue on a Mailbox server or an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,9 +42,9 @@ A message already in delivery won't be suspended. Delivery will continue and the A message being sent to multiple recipients might be located in multiple queues. If you specify an Identity parameter, the message is suspended in a single queue if that identity matches only a single message. If the identity matches more than one message, you receive an error. To suspend a message in more than one queue in a single operation, you must use the Filter parameter. -For instructions on how to resume a suspended message, see [Resume-Message](https://docs.microsoft.com/powershell/module/exchange/resume-message). +For instructions on how to resume a suspended message, see [Resume-Message](https://learn.microsoft.com/powershell/module/exchange/resume-message). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -61,7 +61,7 @@ This example prevents delivery of all messages for which the following condition ## PARAMETERS ### -Identity -The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). +The Identity parameter specifies the message. Valid input for this parameter uses the syntax Server\\Queue\\MessageInteger or Queue\\MessageInteger or MessageInteger, for example, Mailbox01\\contoso.com\\5 or 10. For details about message identity, see [Message identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#message-identity). ```yaml Type: MessageIdentity @@ -77,7 +77,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more messages by using OPath filter syntax. The OPath filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://docs.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more messages by using OPATH filter syntax. The OPATH filter includes a message property name followed by a comparison operator and value (for example, `"FromAddress -like '*@contoso.com'"`). For details about filterable message properties and comparison operators, see [Properties of messages in queues](https://learn.microsoft.com/Exchange/mail-flow/queues/message-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -159,12 +159,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Suspend-MoveRequest.md b/exchange/exchange-ps/exchange/Suspend-MoveRequest.md index a4bcbfa9b3..852bd02d0b 100644 --- a/exchange/exchange-ps/exchange/Suspend-MoveRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-MoveRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-moverequest +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-moverequest applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Suspend-MoveRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Suspend-MoveRequest cmdlet to suspend a move request any time after the move request was created, but before it reaches the status of CompletionInProgress. You can resume the move request by using the Resume-MoveRequest cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Suspend-MoveRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -178,12 +178,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md index cb12246c00..6e8a63fbb7 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md +++ b/exchange/exchange-ps/exchange/Suspend-PublicFolderMailboxMigrationRequest.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfoldermailboxmigrationrequest applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online title: Suspend-PublicFolderMailboxMigrationRequest schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Suspend-PublicFolderMailboxMigrationRequest cmdlet to suspend individual jobs in public folder migration batches that were created by using the New-MigrationBatch cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Suspend-PublicFolderMailboxMigrationRequest [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -131,12 +131,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md b/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md index e6bca70e6b..8819989303 100644 --- a/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md +++ b/exchange/exchange-ps/exchange/Suspend-PublicFolderReplication.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-publicfolderreplication +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-publicfolderreplication applicable: Exchange Server 2010 title: Suspend-PublicFolderReplication schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Suspend-PublicFolderReplication cmdlet to stop public folder replication for the organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Suspend-PublicFolderReplication [-Confirm] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,12 +97,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Suspend-Queue.md b/exchange/exchange-ps/exchange/Suspend-Queue.md index 03bb3a0952..14102cc59b 100644 --- a/exchange/exchange-ps/exchange/Suspend-Queue.md +++ b/exchange/exchange-ps/exchange/Suspend-Queue.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/suspend-queue +online version: https://learn.microsoft.com/powershell/module/exchange/suspend-queue applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Suspend-Queue schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Suspend-Queue cmdlet to stop processing for a queue on a Mailbox server or an Edge Transport server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -40,9 +40,9 @@ Suspend-Queue [-Identity] ## DESCRIPTION The Suspend-Queue cmdlet stops processing on a queue that has a status of Active or Retry. Messages being processed are delivered, but no additional messages leave the queue. When you use the Identity parameter, the queue is suspended only if the identity matches a single queue. If the identity matches more than one queue, you receive an error. To suspend more than one queue in a single operation, you must use the Filter parameter. -For instructions on how to resume suspended queues, see [Resume-Queue](https://docs.microsoft.com/powershell/module/exchange/resume-queue). +For instructions on how to resume suspended queues, see [Resume-Queue](https://learn.microsoft.com/powershell/module/exchange/resume-queue). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -63,7 +63,7 @@ This example suspends processing on all queues on the server Server1.contoso.com ## PARAMETERS ### -Identity -The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). +The Identity parameter specifies the queue. Valid input for this parameter uses the syntax Server\\Queue or Queue, for example, Mailbox01\\contoso.com or Unreachable. For details about queue identity, see [Queue identity](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell#queue-identity). ```yaml Type: QueueIdentity @@ -79,7 +79,7 @@ Accept wildcard characters: False ``` ### -Filter -The Filter parameter specifies one or more queues by using OPath filter syntax. The OPath filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://docs.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://docs.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). +The Filter parameter specifies one or more queues by using OPATH filter syntax. The OPATH filter includes a queue property name followed by a comparison operator and value (for example, `"NextHopDomain -eq 'contoso.com'"`). For details about filterable queue properties and comparison operators, see [Queue properties in Exchange Server](https://learn.microsoft.com/Exchange/mail-flow/queues/queue-properties) and [Find queues and messages in queues in the Exchange Management Shell](https://learn.microsoft.com/Exchange/mail-flow/queues/queues-and-messages-in-powershell). You can specify multiple criteria by using the and comparison operator. Property values that aren't expressed as an integer must be enclosed in quotation marks ("). @@ -161,12 +161,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md index d8d6ca4961..48f24eefda 100644 --- a/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-ActiveSyncConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-activesyncconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-activesyncconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-ActiveSyncConnectivity schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ActiveSyncConnectivity cmdlet to test connectivity to Microsoft Exchange ActiveSync virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,7 +45,7 @@ The Test-ActiveSyncConnectivity cmdlet tests Exchange ActiveSync connectivity by The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command: -& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1 +`& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1` The test results are displayed on-screen. The cmdlet returns the following information. @@ -56,9 +56,9 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-ActiveSyncConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAS Test.html"`. +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-ActiveSyncConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAS Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -195,7 +195,7 @@ Accept wildcard characters: False ### -MailboxCredential The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -211,7 +211,7 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -236,7 +236,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -268,7 +270,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter @@ -300,7 +304,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -354,12 +358,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md b/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md index c81d910797..24d8280b0b 100644 --- a/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md +++ b/exchange/exchange-ps/exchange/Test-ApplicationAccessPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-applicationaccesspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/test-applicationaccesspolicy applicable: Exchange Online, Exchange Online Protection title: Test-ApplicationAccessPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Test-ApplicationAccessPolicy cmdlet to test access right of an application to a specific user/mailbox. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +28,7 @@ Test-ApplicationAccessPolicy [-Identity] -AppId ## DESCRIPTION This feature applies only to apps connecting to the Microsoft Graph API for Outlook resources. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,12 +93,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md b/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md index f38d46e885..219f178aa0 100644 --- a/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-ArchiveConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-archiveconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-archiveconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-ArchiveConnectivity schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ArchiveConnectivity cmdlet to verify archive functionality for a mailbox user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -32,7 +32,7 @@ Test-ArchiveConnectivity [-UserSmtp] ## DESCRIPTION Running the Test-ArchiveConnectivity cmdlet validates connectivity to a user's archive mailbox. End-to-end verification includes testing whether an on-premises or cloud-based archive is provisioned for the on-premises mailbox user and whether it's enabled and logging on to the archive mailbox on behalf of the user. Successful completion of the command indicates that processes such as the Managed Folder Assistant and Outlook on the web are able to successfully access the archive mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -140,12 +140,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-AssistantHealth.md b/exchange/exchange-ps/exchange/Test-AssistantHealth.md index 99c78ed253..95868838da 100644 --- a/exchange/exchange-ps/exchange/Test-AssistantHealth.md +++ b/exchange/exchange-ps/exchange/Test-AssistantHealth.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-assistanthealth +online version: https://learn.microsoft.com/powershell/module/exchange/test-assistanthealth applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-AssistantHealth schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-AssistantHealth cmdlet to verify that the Microsoft Exchange Mailbox Assistants service (MSExchangeMailboxAssistants) is healthy, to recover from health issues, and to report the status of the diagnosis or recovery action. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ The Mailbox Assistants service runs on all servers that have the Mailbox server By default, when you run this cmdlet, it returns the RunspaceId, events, and performance counters in a table format. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,6 +57,29 @@ This example detects the mailbox assistant's health on the local Mailbox server. ## PARAMETERS +### -ServerName +The ServerName parameter specifies the Mailbox server where you want to run this command. You can use any value that uniquely identifies the server. For example: + +- Name +- FQDN +- Distinguished name (DN) +- Exchange Legacy DN + +If you don't use this parameter, the command is run on the local server. + +```yaml +Type: ServerIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +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. @@ -77,11 +100,9 @@ Accept wildcard characters: False ``` ### -IncludeCrashDump -The IncludeCrashDump parameter specifies that the command should take an error report prior to taking any recovery actions. This parameter should only be used if running from a local computer. If you use the parameter while connected remotely, the command fails. - -The default value for this parameter is $false. +The IncludeCrashDump switch specifies that the command should take an error report prior to taking any recovery actions. You don't need to specify a value with this switch. -You don't have to specify a value with this parameter. +You should only use this switch on the local computer. If you use this switch while connected remotely, the command will fail. ```yaml Type: SwitchParameter @@ -113,7 +134,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -129,13 +152,13 @@ Accept wildcard characters: False ``` ### -ResolveProblems -This ResolveProblems parameter specifies that if the command detects an issue, it attempts to fix it. This command attempts to fix the following issues: +This ResolveProblems switch specifies that if the command detects an issue, it attempts to fix it. You don't need to specify a value with this switch. + +This command attempts to fix the following issues: - Starts the Mailbox Assistants service if it isn't running. - Restarts the Mailbox Assistants service if it detects that the service is hung or deadlocked for more than 15 minutes. -You don't have to specify a value with this parameter. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -149,29 +172,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServerName -The ServerName parameter specifies the Mailbox server where you want to run this command. You can use any value that uniquely identifies the server. For example: - -- Name -- FQDN -- Distinguished name (DN) -- Exchange Legacy DN - -If you don't use this parameter, the command is run on the local server. - -```yaml -Type: ServerIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -WatermarkBehindWarningThreholdInMinutes The WatermarkBehindWarningThreholdInMinutes parameter specifies the threshold for watermark age. Event watermarks indicate the last time that events were successfully processed by an assistant. An event watermark that hasn't been updated in a while may indicate a problem. For each Mailbox Assistant, the Test-AssistantHealth cmdlet compares the current time with the time stamp of the last event watermark to determine the watermark age. If that age exceeds the value set by the WatermarkBehindWarningThreholdInMinutes parameter, a warning is generated. @@ -211,12 +211,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md index 8f1e052ccc..c2836a32a6 100644 --- a/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-CalendarConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-calendarconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-calendarconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-CalendarConnectivity schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Test-CalendarConnectivity cmdlet to verify that anonymous calendar sharing is enabled and working properly. The Calendar virtual directory is a subdirectory of the Microsoft Outlook on the web virtual directories. When you run this command without any parameters, the command tests calendar connectivity against all Outlook on the web virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -56,9 +56,9 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-CalendarConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\Calendar Test.html"`. +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-CalendarConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\Calendar Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -146,7 +146,7 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -171,7 +171,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -187,7 +189,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter @@ -289,12 +293,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md index 4702536e56..3389d80031 100644 --- a/exchange/exchange-ps/exchange/Test-ClientAccessRule.md +++ b/exchange/exchange-ps/exchange/Test-ClientAccessRule.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-clientaccessrule +online version: https://learn.microsoft.com/powershell/module/exchange/test-clientaccessrule applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Test-ClientAccessRule schema: 2.0.0 @@ -12,11 +12,14 @@ ms.reviewer: # Test-ClientAccessRule ## SYNOPSIS -This cmdlet is available or functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. +> [!NOTE] +> Beginning in October 2022, client access rules were deprecated for all Exchange Online organizations that weren't using them. Client access rules will be deprecated for all remaining organizations on September 1, 2025. If you choose to turn off client access rules before the deadline, the feature will be disabled in your organization. For more information, see [Update on Client Access Rules Deprecation in Exchange Online](https://techcommunity.microsoft.com/blog/exchange/update-on-client-access-rules-deprecation-in-exchange-online/4354809). + +This cmdlet is functional only in Exchange Server 2019 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. Use the Test-ClientAccessRule cmdlet to test how client access rules affect access to your organization. If any of the client properties you specify for this cmdlet match any client access rules, the rules are returned in the results. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -38,7 +41,7 @@ Client access rules are like mail flow rules (also known as transport rules) for - RemotePowerShell:BasicAuthentication and NonBasicAuthentication. - ExchangeActiveSync:BasicAuthentication, OAuthAuthentication, and CertificateBasedAuthentication. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -150,7 +153,14 @@ Accept wildcard characters: False ``` ### -User -The User parameter specifies the user account to test. You can use any value that uniquely identifies the user. For example: +The User parameter specifies the user account to test. + +For the best results, we recommend using the following values: + +- UPN: For example, `user@contoso.com` (users only). +- Domain\\SamAccountName: For example, `contoso\user`. + +Otherwise, you can use any value that uniquely identifies the user. For example: - Name - Alias @@ -234,12 +244,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-DataClassification.md b/exchange/exchange-ps/exchange/Test-DataClassification.md index 04ab225727..7d9109fd68 100644 --- a/exchange/exchange-ps/exchange/Test-DataClassification.md +++ b/exchange/exchange-ps/exchange/Test-DataClassification.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-dataclassification -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/test-dataclassification +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance title: Test-DataClassification schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Test-DataClassification cmdlet to find the confidence and count of a sensitive information type that's found in a specified text string. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -24,6 +24,7 @@ For information about the parameter sets in the Syntax section below, see [Excha Test-DataClassification [-ClassificationNames ] [-DomainController ] + [-FileExtension ] [-TestTextExtractionResults ] [-TextToClassify ] [] @@ -32,13 +33,14 @@ Test-DataClassification ## DESCRIPTION This cmdlet lets you know the classification results that are returned by the Microsoft classification engine in specific text. The classification results include the sensitive type, its count, and confidence. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -$r = Test-DataClassification -TextToClassify "Credit card information Visa: 4485 3647 3952 7352. Patient Identifier or SSN: 452-12-1232" +$r = Test-DataClassification -TextToClassify "Credit card information Visa: xxxx xxxx xxxx xxxx. Patient Identifier or SSN: xxx-xx-xxxx" + $r.ClassificationResults ``` @@ -58,7 +60,7 @@ You can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -68,7 +70,7 @@ Accept wildcard characters: False ``` ### -DomainController -This parameter is available only in on-premises Exchange. +This parameter is functional only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. @@ -76,7 +78,25 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Security & Compliance + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileExtension +This parameter is available only in the cloud-based service. + +{{ Fill FileExtension Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Security & Compliance Required: False Position: Named @@ -92,7 +112,7 @@ The TestTextExtractionResults parameter specifies the extracted text from the Te Type: TestTextExtractionResult[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -108,7 +128,7 @@ The TextToClassify parameter specifies the text string for which classification Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -122,12 +142,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md b/exchange/exchange-ps/exchange/Test-EcpConnectivity.md index f62490d42e..81cf892ecd 100644 --- a/exchange/exchange-ps/exchange/Test-EcpConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-EcpConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-ecpconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-ecpconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-EcpConnectivity schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Test-EcpConnectivity cmdlet to test connectivity to Exchange Control Panel (ECP) virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -55,9 +55,9 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-EcpConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAC Test.html"`. +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-EcpConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EAC Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -145,7 +145,7 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -170,7 +170,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -186,7 +188,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter @@ -250,7 +254,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -306,12 +310,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md b/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md index 0bdaa16d62..8f9a1e1fb9 100644 --- a/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md +++ b/exchange/exchange-ps/exchange/Test-EdgeSynchronization.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-edgesynchronization +online version: https://learn.microsoft.com/powershell/module/exchange/test-edgesynchronization applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-EdgeSynchronization schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-EdgeSynchronization cmdlet to diagnose whether the subscribed Edge Transport servers have a current and accurate synchronization status. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +47,7 @@ The Test-EdgeSynchronization cmdlet is a diagnostic cmdlet that provides a repor This cmdlet compares the data stored in Active Directory and the data stored in AD LDS. Any inconsistencies in data are reported in the results output by this cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -119,7 +119,9 @@ Accept wildcard characters: False ``` ### -ExcludeRecipientTest -The ExcludeRecipientTest switch specifies whether to exclude validation of recipient data synchronization. If you include this switch, only the synchronization of configuration objects is validated. Validating that recipient data is synchronized takes longer than validating only configuration data. You don't have to include a value with this switch. +The ExcludeRecipientTest switch specifies whether to exclude validation of recipient data synchronization. You don't need to specify a value with this switch. + +If you use this switch, only the synchronization of configuration objects is validated. Validating that recipient data is synchronized takes longer than validating only configuration data. ```yaml Type: SwitchParameter @@ -135,7 +137,9 @@ Accept wildcard characters: False ``` ### -FullCompareMode -The FullCompareMode switch specifies whether a full comparison of the configuration data between Active Directory and AD LDS instance on the target Edge Transport server is performed. If you don't use this switch, a full comparison of replicated configuration data is skipped and the command only tests the Edge synchronization by verifying the replication cookie. +The FullCompareMode switch specifies whether a full comparison of the configuration data between Active Directory and AD LDS instance on the target Edge Transport server is performed. You don't need to specify a value with this switch. + +If you don't use this switch, a full comparison of replicated configuration data is skipped and the command only tests the Edge synchronization by verifying the replication cookie. ```yaml Type: SwitchParameter @@ -167,7 +171,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -221,12 +228,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-ExchangeSearch.md b/exchange/exchange-ps/exchange/Test-ExchangeSearch.md index 47906f4256..de07b2a9a7 100644 --- a/exchange/exchange-ps/exchange/Test-ExchangeSearch.md +++ b/exchange/exchange-ps/exchange/Test-ExchangeSearch.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-exchangesearch +online version: https://learn.microsoft.com/powershell/module/exchange/test-exchangesearch applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-ExchangeSearch schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ExchangeSearch cmdlet to test that Exchange Search is currently enabled and is indexing new email messages in a timely manner. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -59,7 +59,7 @@ The Test-ExchangeSearch cmdlet creates a hidden message and an attachment in the You can use the Verbose switch to get detailed information about each step performed by the cmdlet as part of the test. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -109,7 +109,7 @@ Accept wildcard characters: False ``` ### -Archive -The Archive switch specifies that the test be run against the archive mailbox for the mailbox user specified in the Identity parameter. When the Archive switch is used, you must also use the Identity parameter to specify the mailbox. +The Archive switch specifies that the test is run against the archive mailbox for the mailbox user specified by the Identity parameter. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -176,7 +176,7 @@ Accept wildcard characters: False ``` ### -MailboxDatabase -This parameter is available or functional only in Exchange Server 2010 and 2013. +This parameter is functional only in Exchange Server 2010 and 2013. The MailboxDatabase parameter specifies the mailbox database to test Exchange Search against. You can use any value that uniquely identifies the database. For example: @@ -200,7 +200,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -259,12 +261,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-FederationTrust.md b/exchange/exchange-ps/exchange/Test-FederationTrust.md index 873cb3bf86..d8910cf09d 100644 --- a/exchange/exchange-ps/exchange/Test-FederationTrust.md +++ b/exchange/exchange-ps/exchange/Test-FederationTrust.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-federationtrust +online version: https://learn.microsoft.com/powershell/module/exchange/test-federationtrust applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-FederationTrust schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-FederationTrust cmdlet to verify that the federation trust is properly configured and functioning as expected. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -42,7 +42,7 @@ The Test-FederationTrust cmdlet runs the following series of tests to ensure tha - Certificates are checked to ensure they're valid and can be used with the Microsoft Federation Gateway. - A security token is requested from the Microsoft Federation Gateway. This test ensures that a token can be properly retrieved and used. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -91,7 +91,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -152,12 +155,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md b/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md index 3d013ee210..d26350dd00 100644 --- a/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md +++ b/exchange/exchange-ps/exchange/Test-FederationTrustCertificate.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-federationtrustcertificate +online version: https://learn.microsoft.com/powershell/module/exchange/test-federationtrustcertificate applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-FederationTrustCertificate schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-FederationTrustCertificate cmdlet to check the status of certificates that are used for federation on all Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Test-FederationTrustCertificate [-Confirm] ## DESCRIPTION The certificate used to establish a federation trust is propagated to all Exchange servers in the organization. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -99,12 +99,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md b/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md index a6df2bdd7c..4b2de63622 100644 --- a/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md +++ b/exchange/exchange-ps/exchange/Test-IPAllowListProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-ipallowlistprovider +online version: https://learn.microsoft.com/powershell/module/exchange/test-ipallowlistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-IPAllowListProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Test-IPAllowListProvider cmdlet to test IP Allow list providers on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -164,12 +164,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md b/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md index 2503980e95..7ab51aad23 100644 --- a/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md +++ b/exchange/exchange-ps/exchange/Test-IPBlockListProvider.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-ipblocklistprovider +online version: https://learn.microsoft.com/powershell/module/exchange/test-ipblocklistprovider applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-IPBlockListProvider schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available or effective only on Edge Transport servers in on-premi Use the Test-IPBlockListProvider cmdlet to test IP Block list providers on Edge Transport servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -164,12 +164,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-IRMConfiguration.md b/exchange/exchange-ps/exchange/Test-IRMConfiguration.md index 0438ca57d3..c3b0a5ae4e 100644 --- a/exchange/exchange-ps/exchange/Test-IRMConfiguration.md +++ b/exchange/exchange-ps/exchange/Test-IRMConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-irmconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/test-irmconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Test-IRMConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Test-IRMConfiguration cmdlet to test Information Rights Management (IRM) configuration and functionality. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Test-IRMConfiguration [[-Identity] ] -Sender ` to the command. For example: `Test-IMAPConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\IMAP Test.html"`. +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-IMAPConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\IMAP Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). -**Important Note**: In Exchange 2013 or later, when you run this command to test a single mailbox on an Exchange server that isn't hosting the active mailbox database copy for the mailbox, you might see the following error message: +**Note**: In Exchange 2013 or later, when you run this command to test a single mailbox on an Exchange server that isn't hosting the active mailbox database copy for the mailbox, you might see the following error message: -`Unable to create MailboxSession object to access the mailbox [user@consoto.com]. Detailed error information: [Microsoft.Exchange.Data.Storage.WrongServerException]: The user and the mailbox are in different Active Directory sites. Inner error [Microsoft.Mapi.MapiExceptionMailboxInTransit]: MapiExceptionMailboxInTransit: Detected site violation (hr=0x0, ec=1292)` +`Unable to create MailboxSession object to access the mailbox [user@contoso.com]. Detailed error information: [Microsoft.Exchange.Data.Storage.WrongServerException]: The user and the mailbox are in different Active Directory sites. Inner error [Microsoft.Mapi.MapiExceptionMailboxInTransit]: MapiExceptionMailboxInTransit: Detected site violation (hr=0x0, ec=1292)` When you receive this error, run the command again on the server that's hosting the active mailbox database copy to verify that IMAP works for the mailbox. @@ -183,7 +183,7 @@ Accept wildcard characters: False ### -MailboxCredential The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -199,7 +199,7 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -224,7 +224,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -274,7 +276,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter @@ -308,7 +312,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -346,12 +350,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md index 1e127cf9b8..f166b0c365 100644 --- a/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md +++ b/exchange/exchange-ps/exchange/Test-M365DataAtRestEncryptionPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-m365dataatrestencryptionpolicy +online version: https://learn.microsoft.com/powershell/module/exchange/test-m365dataatrestencryptionpolicy applicable: Exchange Online, Exchange Online Protection title: Test-M365DataAtRestEncryptionPolicy schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Test-M365DataAtRestEncryptionPolicy cmdlet to test an existing Microsoft 365 data-at-rest encryption policy. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +29,7 @@ Test-M365DataAtRestEncryptionPolicy [[-Identity] ] ## DESCRIPTION The Microsoft Exchange Mailbox Replication service runs on Mailbox servers. This command ensures that the Mailbox Replication service is running and that it responds to a remote procedure call (RPC) ping check. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -130,7 +130,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -148,7 +151,7 @@ Accept wildcard characters: False ### -MRSProxyCredentials The MRSProxyCredentials parameter specifies the credentials that are required for the MRSProxyPingCheck test on the server that's specified by the MRSProxyServer parameter. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -206,12 +209,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-Mailflow.md b/exchange/exchange-ps/exchange/Test-Mailflow.md index 739b200460..628848623e 100644 --- a/exchange/exchange-ps/exchange/Test-Mailflow.md +++ b/exchange/exchange-ps/exchange/Test-Mailflow.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-mailflow +online version: https://learn.microsoft.com/powershell/module/exchange/test-mailflow applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-Mailflow schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-Mailflow cmdlet to diagnose whether mail can be successfully sent from and delivered to the system mailbox on a Mailbox server. You can also use this cmdlet to verify that email is sent between Mailbox servers within a defined latency threshold. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -112,9 +112,9 @@ The Test-Mailflow results are displayed on-screen. The interesting values in the - TestMailflowResult: The values returned are typically Success or \*FAILURE\*. - MessageLatencyTime: The time required to complete the test (deliver the test message). The value uses the syntax hh:mm:ss.ffff where hh = hours, mm = minutes, ss = seconds and ffff = fractions of a second. -You can write the Test-Mailflow results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-Mailflow -AutoDiscoverTargetMailboxServer | ConvertTo-Csv > "C:\My Documents\test-mailflow 2020-05-01.csv"`. +You can write the Test-Mailflow results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > ` to the command. For example: `Test-Mailflow -AutoDiscoverTargetMailboxServer | ConvertTo-Csv > "C:\My Documents\test-mailflow 2020-05-01.csv"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -158,7 +158,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoverTargetMailboxServer -The AutoDiscoverTargetMailboxServer switch specifies whether to automatically populate a list of target Mailbox servers to which to send a test message. The task queries Active Directory to discover all Mailbox servers and then sends each server a test message. +The AutoDiscoverTargetMailboxServer switch specifies whether to automatically populate a list of target Mailbox servers to which to send a test message. You don't need to specify a value with this switch. + +The task queries Active Directory to discover all Mailbox servers and then sends each server a test message. When you use this switch, you can't use the CrossPremises, TargetDatabase, TargetEmailAddress or TargetMailboxServer parameters. @@ -374,7 +376,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -428,12 +433,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-Message.md b/exchange/exchange-ps/exchange/Test-Message.md new file mode 100644 index 0000000000..c4b62c4ac7 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-Message.md @@ -0,0 +1,235 @@ +--- +external help file: Microsoft.Exchange.ServerStatus-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/test-message +applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection +title: Test-Message +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-Message + +## SYNOPSIS +This cmdlet is functional only in the cloud-based service. + +Use the Test-Message cmdlet to simulate and report on the effects of mail flow rules (transport rules) and unified DLP rules on test email messages. Because this cmdlet introduces email into the DLP evaluation pipeline, actions such as Block, Moderate, etc. can take place on the test message. Related notifications will also be sent to any configured recipients. + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +### TransportRules +``` +Test-Message -Recipients -SendReportTo [-TransportRules] + [-Confirm] + [-Force] + [-MessageFileData ] + [-Sender ] + [-UnifiedDlpRules] + [-WhatIf] + [] +``` + +### UnifiedDLPRules +``` +Test-Message -Recipients -SendReportTo [-UnifiedDlpRules] + [-Confirm] + [-Force] + [-MessageFileData ] + [-Sender ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +$data = [System.IO.File]::ReadAllBytes('C:\Data\test.eml') + +Test-Message -MessageFileData $data -Sender megan@contoso.com -Recipients adele@contoso.com -SendReportTo admin@contoso.com -TransportRules -UnifiedDlpRules +``` + +This example uses the test.eml message file at C:\Data to test mail flow rules and unified DLP rules for the sender megan@contoso.com to the recipient adele@contoso.com. The results report is sent to admin@contoso.com. + +## PARAMETERS + +### -Recipients +The Recipients parameter specifies the recipient email address to use for the test message. + +You can specify multiple email addresses separated by commas. + +```yaml +Type: ProxyAddressCollection +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SendReportTo +The SendReportTo parameter specifies the target email address for the command results. + +```yaml +Type: RecipientIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TransportRules +The TransportRules switch specifies that you want to test mail flow rules. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: TransportRules +Aliases: +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UnifiedDlpRules +The UnifiedDlpRules switch specifies that you want to unified DLP rules. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: UnifiedDLPRules +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: SwitchParameter +Parameter Sets: TransportRules +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: False +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MessageFileData +The MessageFileData parameter specifies the .eml message file to test. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). + +```yaml +Type: Byte[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sender +The Sender parameter specifies the sender email address to use for the test message. + +```yaml +Type: SmtpAddress +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Server 2013, Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md index 29f19e0c8e..d37917bd9e 100644 --- a/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md +++ b/exchange/exchange-ps/exchange/Test-MigrationServerAvailability.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-migrationserveravailability +online version: https://learn.microsoft.com/powershell/module/exchange/test-migrationserveravailability applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Test-MigrationServerAvailability schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Test-MigrationServerAvailability cmdlet to test the availability of the target server in preparation to perform cross-forest mailbox moves, migration of on-premises mailboxes to Exchange Online, or to migrate on-premises mailbox data from an IMAP server to Exchange Online mailboxes. For all migration types, the cmdlet attempts to verify the connection settings used to connect to the target server. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -122,7 +122,7 @@ Test-MigrationServerAvailability -ServiceAccountKeyFileData [-Gmail] ### Compliance ``` -Test-MigrationServerAvailability -Credentials -EmailAddress [-Compliance] +Test-MigrationServerAvailability -Credentials -EmailAddress [-Compliance] [-RemoteServer ] [-Confirm] [-Partition ] @@ -178,7 +178,7 @@ If the verification is successful, you can use the same settings to create a mig - New-MigrationEndpoint - New-MigrationBatch -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -192,6 +192,7 @@ For IMAP migrations, this example verifies the connection to the IMAP mail serve ### Example 2 ```powershell $Credentials = Get-Credential + Test-MigrationServerAvailability -ExchangeOutlookAnywhere -Autodiscover -EmailAddress administrator@contoso.com -Credentials $Credentials ``` @@ -200,6 +201,7 @@ This example uses the Autodiscover and ExchangeOutlookAnywhere parameters to ver ### Example 3 ```powershell $Credentials = Get-Credential + Test-MigrationServerAvailability -ExchangeOutlookAnywhere -ExchangeServer exch2k3.contoso.com -Credentials $Credentials -RPCProxyServer mail.contoso.com -Authentication NTLM ``` @@ -215,6 +217,7 @@ This example verifies the connection settings to a remote server using the setti ### Example 5 ```powershell $MRSEndpoints = (Get-MigrationEndpoint).Identity + Foreach ($MEP in $MRSEndpoints) {Test-MigrationServerAvailability -Endpoint $MEP} ``` @@ -223,11 +226,11 @@ This example tests multiple existing endpoints. ## PARAMETERS ### -Autodiscover -The Autodiscover parameter specifies that the cmdlet should use the Autodiscover service to obtain the connection settings for the target server. You don't need to specify a value with this switch. +The Autodiscover switch specifies that the command should use the Autodiscover service to obtain the connection settings for the target server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter -Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscove +Parameter Sets: ExchangeRemoteMoveAutoDiscover, ExchangeOutlookAnywhereAutoDiscover Aliases: Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online @@ -255,9 +258,9 @@ Accept wildcard characters: False ``` ### -Credentials -The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\\username format or the user principal name (UPN) (user@example.com) format. +The Credentials parameter specifies the username and password for an account that can access mailboxes on the target server. Specify the username in the domain\\username format or the user principal name (UPN) format (for example, `user@contoso.com`). -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -333,7 +336,9 @@ Accept wildcard characters: False ### -ExchangeOutlookAnywhere This parameter is available only in the cloud-based service. -The ExchangeOutlookAnywhere parameter specifies a migration type for migrating on-premises mailboxes to Exchange Online. Use this parameter if you plan to migrate mailboxes to Exchange Online using a staged Exchange migration or a cutover Exchange migration. +The ExchangeOutlookAnywhere switch specifies a migration type for migrating on-premises mailboxes to Exchange Online. You don't need to specify a value with this switch. + +Use this switch if you plan to migrate mailboxes to Exchange Online using a staged Exchange migration or a cutover Exchange migration. ```yaml Type: SwitchParameter @@ -349,7 +354,9 @@ Accept wildcard characters: False ``` ### -ExchangeRemoteMove -The ExchangeRemoteMove parameter specifies a type of migration where mailboxes are moved with full fidelity between two on-premises forests or between an on-premises forest and Exchange Online. Use this parameter if you plan to perform a cross-forest move or migrate mailboxes between an on-premises Exchange organization and Exchange Online in a hybrid deployment. +The ExchangeRemoteMove switch specifies a migration type where mailboxes are moved with full fidelity between two on-premises forests or between an on-premises forest and Exchange Online. You don't need to specify a value with this switch. + +Use this switch if you plan to perform a cross-forest move or migrate mailboxes between an on-premises Exchange organization and Exchange Online in a hybrid deployment. ```yaml Type: SwitchParameter @@ -385,7 +392,9 @@ Accept wildcard characters: False ### -Imap This parameter is available only in the cloud-based service. -The Imap parameter specifies an IMAP migration as the migration type. This parameter is required when you want to migrate data from an IMAP mail server to Exchange Online mailboxes. +The Imap parameter specifies an IMAP migration type. You don't need to specify a value with this switch. + +This switch is required when you want to migrate data from an IMAP mail server to Exchange Online mailboxes. ```yaml Type: SwitchParameter @@ -403,7 +412,9 @@ Accept wildcard characters: False ### -Gmail This parameter is available only in the cloud-based service. -The Gmail parameter specifies Gmail migration as the migration type. This parameter is required when you want to migrate data from a Google Workspace (formerly G Suite) tenant to Exchange Online mailboxes. +The Gmail parameter specifies Gmail as the migration type. You don't need to specify a value with this switch. + +This switch is required when you want to migrate data from a Google Workspace (formerly G Suite) tenant to Exchange Online mailboxes. ```yaml Type: SwitchParameter @@ -564,7 +575,7 @@ This parameter is available only in the cloud-based service. The ServiceAccountKeyFileData parameter is used to specify information needed to authenticate as a service account. The data should come from the JSON key file that is downloaded when the service account that has been granted access to your remote tenant is created. -Use the following format for the value of this parameter: `([System.IO.File]::ReadAllBytes())`. For example: `-CSVData ([System.IO.File]::ReadAllBytes("C:\Users\Administrator\Desktop\service-account.json"))`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] @@ -783,12 +794,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md b/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md index d345ec2c8d..69c08e2c8a 100644 --- a/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-OAuthConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-oauthconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-oauthconnectivity applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Test-OAuthConnectivity schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Test-OAuthConnectivity cmdlet to test OAuth authentication to partner applications for a user. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -25,7 +25,6 @@ Test-OAuthConnectivity -Service -TargetUri [-AppOnly] [-Confirm] [-Mailbox ] - [-OrganizationDomain ] [-ReloadConfig] [-UseCachedToken] [-WhatIf] @@ -33,9 +32,9 @@ Test-OAuthConnectivity -Service -TargetUri ``` ## DESCRIPTION -SharePoint, Lync and Skype for Business partner applications are automatically created in on-premises Exchange deployments. For the Test-OAuthConnectivity cmdlet to succeed for other partner applications, you first need to create the partner application by using the Configure-EnterpriseApplication.ps1 script. +SharePoint, Lync and Skype for Business partner applications are automatically created in on-premises Exchange deployments. For the Test-OAuthConnectivity cmdlet to succeed for other partner applications in on-premises deployments, you first need to create the partner application by using the Configure-EnterprisePartnerApplication.ps1 script that's available in the %ExchangeInstallPath%Scripts folder ($env:ExchangeInstallPath\Scripts in PowerShell). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -146,26 +145,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrganizationDomain -This parameter is available only in the cloud-based service. - -The OrganizationDomain parameter specifies the domain name of the Microsoft 365 organization. For example, contoso.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ReloadConfig -The ReloadConfig switch reloads all the configuration settings from the Exchange configuration objects. You don't need to specify a value with this switch. If you don't use this switch, the cached configuration settings are used. +The ReloadConfig switch reloads all the configuration settings from the Exchange configuration objects. You don't need to specify a value with this switch. + +If you don't use this switch, the cached configuration settings are used. ```yaml Type: SwitchParameter @@ -217,12 +200,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md b/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md index 1c9648d9f7..79352a03a2 100644 --- a/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md +++ b/exchange/exchange-ps/exchange/Test-OrganizationRelationship.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-organizationrelationship -applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/test-organizationrelationship +applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Test-OrganizationRelationship schema: 2.0.0 author: chrisda @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Test-OrganizationRelationship cmdlet to verify that the organization relationship is properly configured and functioning as expected. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,9 +31,9 @@ Test-OrganizationRelationship [[-Identity] ## DESCRIPTION The Test-OrganizationRelationship cmdlet doesn't include any functional tests of federated sharing features, such as accessing user free/busy information or moving mailboxes between organizations. It only verifies that the configuration will allow these features to work correctly. -Before you can test an organization relationship, you must first create an organization relationship. For more information, see [Create an organization relationship](https://docs.microsoft.com/exchange/create-an-organization-relationship-exchange-2013-help). +Before you can test an organization relationship, you must first create an organization relationship. For more information, see [Create an organization relationship](https://learn.microsoft.com/exchange/create-an-organization-relationship-exchange-2013-help). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -57,7 +57,7 @@ The Identity parameter specifies the organization relationship to be tested. You Type: OrganizationRelationshipIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: 1 @@ -80,7 +80,7 @@ The UserIdentity parameter specifies the mailbox for which a delegation token is Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: True Position: Named @@ -99,7 +99,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -133,7 +133,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection Required: False Position: Named @@ -147,12 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md b/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md index b3e67c1f97..2443888dbc 100644 --- a/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-OutlookConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-outlookconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-outlookconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-OutlookConnectivity schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-OutlookConnectivity cmdlet to test end-to-end Microsoft Outlook client connectivity in the Microsoft Exchange organization. This includes testing for both Outlook Anywhere (RPC over HTTP) and MAPI over HTTP connections. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -94,13 +94,13 @@ Test-OutlookConnectivity [[-Identity] ] -WSTestType `: Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It will attempt to connect to and log in to the mailbox in the specified mailbox database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). + +MAPI over HTTP probes: + +- `OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe`: Validates that the MAPI/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. +- `OutlookMapiHttp.Protocol\OutlookMapiHttpDeepTestProbe`: Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. +- `OutlookMapiHttp.Protocol\OutlookRpcDeepTestProbe\`: Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log in to the mailbox in the specified database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). + +```yaml +Type: String +Parameter Sets: Probe +Aliases: +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GetDefaultsFromAutodiscover This parameter is available only in Exchange Server 2010. @@ -305,7 +333,7 @@ Accept wildcard characters: False ### -Credential The Credential parameter specifies the credential used by the probe. The system's test credentials are used by default -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -341,7 +369,7 @@ This parameter is available only in Exchange Server 2010. The MailboxCredential parameter specifies certain credentials to allow logon access to a user's mailbox. Use the parameter along with the Identity parameter to access a user's mailbox when you don't have access permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -390,7 +418,9 @@ Accept wildcard characters: False ### -MonitoringContext This parameter is available only in Exchange Server 2010. -The MonitoringContext switch specifies whether the command returns additional information that can be used with Microsoft System Center Operations Manager. You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -405,34 +435,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProbeIdentity -The ProbeIdentity parameter specifies the probe to use. Valid values are: - -Outlook Anywhere (RPC over HTTP) probes: - -- `Outlook.Protocol\OutlookRpcSelfTestProbe`: Validates that the RPC/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. -- `Outlook.Protocol\OutlookRpcDeepTestProbe`: Validates that the RPC/HTTP endpoint is working on the Mailbox server. It will attempt to connect to and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. -- `Outlook.Protocol\OutlookRpcDeepTestProbe\`: Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It will attempt to connect to and log in to the mailbox in the specified mailbox database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). - -MAPI over HTTP probes: - -- `OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe`: Validates that the MAPI/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity. -- `OutlookMapiHttp.Protocol\OutlookMapiHttpDeepTestProbe`: Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet. -- `OutlookMapiHttp.Protocol\OutlookRpcDeepTestProbe\`: Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log in to the mailbox in the specified database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, `"Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530"`). - -```yaml -Type: String -Parameter Sets: Probe -Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -RpcAuthenticationType This parameter is available only in Exchange Server 2010. @@ -585,7 +587,9 @@ Accept wildcard characters: False ### -TrustAnySslCert This parameter is available only in Exchange Server 2010. -The TrustAnySslCert switch specifies whether to ignore any Secure Sockets Layer (SSL) certificate warnings. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. ```yaml Type: SwitchParameter @@ -623,12 +627,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-OutlookWebServices.md b/exchange/exchange-ps/exchange/Test-OutlookWebServices.md index 4adf72f88a..a9eae33fd1 100644 --- a/exchange/exchange-ps/exchange/Test-OutlookWebServices.md +++ b/exchange/exchange-ps/exchange/Test-OutlookWebServices.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-outlookwebservices +online version: https://learn.microsoft.com/powershell/module/exchange/test-outlookwebservices applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-OutlookWebServices schema: 2.0.0 @@ -12,15 +12,15 @@ ms.reviewer: # Test-OutlookWebServices ## SYNOPSIS -This cmdlet is available or functional only in Exchange Server 2010. +This cmdlet is functional only in Exchange Server 2010. Use the Test-OutlookWebServices cmdlet to verify the Autodiscover service settings for Microsoft Outlook on a computer running Microsoft Exchange Server 2010 that has the Client Access server role installed. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX -### Default +### Default ``` Test-OutlookWebServices [[-Identity] ] [-ClientAccessServer ] @@ -63,9 +63,9 @@ Test-OutlookWebServices [[-Identity] ] [-MonitoringContext] ``` ## DESCRIPTION -The Test-OutlookWebServices cmdlet uses a specified address to verify that the Outlook provider is configured correctly. +The Test-OutlookWebServices cmdlet uses a specified address to verify that the Outlook provider is configured correctly. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -86,7 +86,7 @@ The example tests for a connection to each service. The example also submits a r ## PARAMETERS ### -Identity -The Identity parameter specifies any valid address in the forest. If you specify this parameter, incorrectly formed addresses and addresses that are outside the forest are rejected. This address is used to test the Outlook provider. This property accepts the domain and username in the domain\\username format or an Active Directory GUID and resolves them to the SMTP address that's needed to authenticate. +The Identity parameter specifies any valid address in the forest. If you specify this parameter, incorrectly formed addresses and addresses that are outside the forest are rejected. This address is used to test the Outlook provider. This property accepts the domain and username in the domain\\username format or an Active Directory GUID and resolves them to the SMTP address that's needed to authenticate. ```yaml Type: RecipientIdParameter @@ -127,7 +127,7 @@ Accept wildcard characters: False ``` ### -ClientAccessServer -This parameter is available or functional only in Exchange Server 2010. +This parameter is functional only in Exchange Server 2010. The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. @@ -191,7 +191,7 @@ Accept wildcard characters: False ### -MailboxCredential The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -207,7 +207,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether the results of the command include monitoring events and performance counters. The two possible values for this parameter are $true or $false. If you specify $true, the results include monitoring events and performance counters, in addition to information about the MAPI transaction. +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -239,7 +242,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -277,12 +280,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-OwaConnectivity.md b/exchange/exchange-ps/exchange/Test-OwaConnectivity.md index ad2fe05c75..3f6dbf78e8 100644 --- a/exchange/exchange-ps/exchange/Test-OwaConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-OwaConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-owaconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-owaconnectivity applicable: Exchange Server 2010 title: Test-OwaConnectivity schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Test-OwaConnectivity cmdlet to verify that Microsoft Office Outlook Web App is running as expected. The Test-OwaConnectivity cmdlet can be used to test Outlook Web App connectivity for all Microsoft Exchange Server 2010 virtual directories on a specified Client Access server for all mailboxes on servers running Exchange that are in the same Active Directory site. The Test-OwaConnectivity cmdlet can also be used to test the connectivity for an individual Exchange Outlook Web App URL. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -68,7 +68,7 @@ If the command encounters a virtual directory that doesn't require Secure Socket The Test-OwaConnectivity cmdlet can be run as a one-time interactive task or as a scheduled task under Microsoft System Center Operations Manager 2007 control. To run the Test-OwaConnectivity cmdlet as a System Center Operations Manager 2007 task, the Client Access test mailbox must be available on the Mailbox servers that the cmdlet tests against. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -88,23 +88,23 @@ This example tests the connectivity of a specific Client Access server Contoso12 ## PARAMETERS -### -MailboxCredential -The MailboxCredential parameter specifies the mailbox credential for a single URL test. +### -ClientAccessServer +This parameter is available only in Exchange Server 2010 -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +The ClientAccessServer parameter specifies the name of the Client Access server to test. If this parameter is included, all Exchange Outlook Web App virtual directories on the Client Access server are tested against all Exchange Mailbox servers in the local Active Directory site. -The MailboxCredential parameter is required only when using the URL parameter. +Don't use this parameter with the URL parameter. ```yaml -Type: PSCredential -Parameter Sets: URL +Type: ServerIdParameter +Parameter Sets: Identity Aliases: Applicable: Exchange Server 2010 -Required: True -Position: Named +Required: False +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` @@ -128,39 +128,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUnsecureAccess -The AllowUnsecureAccess parameter specifies whether virtual directories that don't require SSL are tested. If the AllowUnsecureAccess parameter is included, it enables virtual directories that don't require SSL to be tested. If this parameter isn't included, the command skips virtual directories that don't require SSL, and an error is generated. +### -MailboxCredential +The MailboxCredential parameter specifies the mailbox credential for a single URL test. + +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). + +The MailboxCredential parameter is required only when using the URL parameter. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: PSCredential +Parameter Sets: URL Aliases: Applicable: Exchange Server 2010 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientAccessServer -This parameter is available only in Exchange Server 2010 - -The ClientAccessServer parameter specifies the name of the Client Access server to test. If this parameter is included, all Exchange Outlook Web App virtual directories on the Client Access server are tested against all Exchange Mailbox servers in the local Active Directory site. +### -AllowUnsecureAccess +The AllowUnsecureAccess switch specifies whether virtual directories that don't require SSL are tested. You don't need to specify a value with this switch. -Don't use this parameter with the URL parameter. +If you don't use this switch, the command skips virtual directories that don't require SSL, and an error is generated. ```yaml -Type: ServerIdParameter -Parameter Sets: Identity +Type: SwitchParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Server 2010 Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -234,7 +236,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter shows you what information is returned to System Center Operations Manager 2007. When Operations Manager 2007 executes the Test-OwaConnectivity cmdlet, it requires additional information to be returned. By setting this parameter to $true, you can see exactly what would be returned to Operations Manager 2007. This parameter is informational only and has no effect on Operations Manager 2007. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -250,7 +254,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter @@ -314,7 +320,9 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate parameter specifies whether to check an internal URL without generating an SSL certificate validation error. The TrustAnySSLCertificate parameter allows SSL certificate validation failures to not be reported. This is useful for testing internal URLs because Internet Information Services (IIS) doesn't support assigning multiple certificates for a single virtual directory. If a directory has different URLs for internal and external access and has a certificate, that certificate is usually for the external URL. This parameter lets the task check an internal URL without generating an error when the certificate doesn't match the URL. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. + +This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. ```yaml Type: SwitchParameter @@ -366,12 +374,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-PopConnectivity.md b/exchange/exchange-ps/exchange/Test-PopConnectivity.md index 0dbfa4e319..fedc41347a 100644 --- a/exchange/exchange-ps/exchange/Test-PopConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-PopConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-popconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-popconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-PopConnectivity schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Test-PopConnectivity cmdlet to verify that the Microsoft Exchange POP3 service is working as expected. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -56,9 +56,9 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-PopConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\POP Test.html"`. +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-PopConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\POP Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -177,7 +177,7 @@ Accept wildcard characters: False ### -MailboxCredential The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -193,7 +193,7 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -218,7 +218,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -268,7 +270,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter @@ -302,7 +306,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -340,12 +344,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md b/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md index f4270d0170..b418302280 100644 --- a/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-PowerShellConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-powershellconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-powershellconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-PowerShellConnectivity schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Test-PowerShellConnectivity cmdlet to test client connectivity to Exchange remote PowerShell virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -68,9 +68,9 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Latency(MS): The time required to complete the test in milliseconds. - Error: Any error messages that were encountered. -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-PowerShellConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\PowerShell Test.html"`. +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-PowerShellConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\PowerShell Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -84,6 +84,7 @@ This example tests the PowerShell (Default Web Site) virtual directory on the MB ### Example 2 ```powershell $UserCredentials = Get-Credential + Test-PowerShellConnectivity -ConnectionUri https://contoso.com/powershell -TestCredential $UserCredentials -Authentication Basic ``` @@ -93,6 +94,31 @@ The credentials that are used to connect to the virtual directory are stored in ## PARAMETERS +### -ClientAccessServer +The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. + +You can use any value that uniquely identifies the server. For example: + +- Name +- Distinguished name (DN) +- ExchangeLegacyDN +- GUID + +You can't use this parameter with the ConnectionUri parameter. + +```yaml +Type: ServerIdParameter +Parameter Sets: Identity +Aliases: +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True +Accept wildcard characters: False +``` + ### -ConnectionUri The ConnectionUri parameter specifies the URL of the remote PowerShell virtual directory to test, for example, `https://contoso.com/powershell`. @@ -114,7 +140,7 @@ Accept wildcard characters: False ### -TestCredential The TestCredential parameter specifies the credentials to use for the test. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). You can only use this parameter with the ConnectionUri parameter. @@ -154,31 +180,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientAccessServer -The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections. - -You can use any value that uniquely identifies the server. For example: - -- Name -- Distinguished name (DN) -- ExchangeLegacyDN -- GUID - -You can't use this parameter with the ConnectionUri parameter. - -```yaml -Type: ServerIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True -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. @@ -215,7 +216,7 @@ Accept wildcard characters: False ``` ### -MailboxServer -The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. +The MailboxServer parameter specifies the Exchange Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect. You can use any value that uniquely identifies the server. For example: @@ -240,7 +241,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -256,7 +259,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter @@ -290,7 +295,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -346,12 +351,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-ReplicationHealth.md b/exchange/exchange-ps/exchange/Test-ReplicationHealth.md index 7e868ab00f..384af71e00 100644 --- a/exchange/exchange-ps/exchange/Test-ReplicationHealth.md +++ b/exchange/exchange-ps/exchange/Test-ReplicationHealth.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-replicationhealth +online version: https://learn.microsoft.com/powershell/module/exchange/test-replicationhealth applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-ReplicationHealth schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ReplicationHealth cmdlet to check all aspects of replication and replay, or to provide status for a specific Mailbox server in a database availability group (DAG). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Test-ReplicationHealth [[-Identity] ] ## DESCRIPTION The Test-ReplicationHealth cmdlet is designed for the proactive monitoring of continuous replication and the continuous replication pipeline, the availability of Active Manager and the health and status of the underlying cluster service, quorum and network components. The Test-ReplicationHealth cmdlet can be run locally or remotely against any Mailbox server in a DAG. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -146,7 +146,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -214,12 +217,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-SenderId.md b/exchange/exchange-ps/exchange/Test-SenderId.md index ae94bcef86..53db8aa93a 100644 --- a/exchange/exchange-ps/exchange/Test-SenderId.md +++ b/exchange/exchange-ps/exchange/Test-SenderId.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-senderid +online version: https://learn.microsoft.com/powershell/module/exchange/test-senderid applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-SenderId schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-SenderId cmdlet to test whether a specified IP address is the legitimate sending address for a specified SMTP address. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Test-SenderId -IPAddress -PurportedResponsibleDomain ## DESCRIPTION The Test-SenderId cmdlet provides the results of a Sender ID check for the IP address and the corresponding domain name that you specify. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -175,12 +175,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-ServiceHealth.md b/exchange/exchange-ps/exchange/Test-ServiceHealth.md index 840715dd53..1016e36a2c 100644 --- a/exchange/exchange-ps/exchange/Test-ServiceHealth.md +++ b/exchange/exchange-ps/exchange/Test-ServiceHealth.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-servicehealth +online version: https://learn.microsoft.com/powershell/module/exchange/test-servicehealth applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-ServiceHealth schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-ServiceHealth cmdlet to test whether all the Microsoft Windows services that Exchange requires on a server have started. The Test-ServiceHealth cmdlet returns an error for any service required by a configured role when the service is set to start automatically and isn't currently running. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ Test-ServiceHealth [[-Server] ] ## DESCRIPTION This cmdlet isn't supported on Exchange 2013 Client Access servers (the cmdlet will return unexpected output). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -123,7 +123,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -159,12 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md new file mode 100644 index 0000000000..896490cd63 --- /dev/null +++ b/exchange/exchange-ps/exchange/Test-ServicePrincipalAuthorization.md @@ -0,0 +1,148 @@ +--- +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml +online version: https://learn.microsoft.com/powershell/module/exchange/test-serviceprincipalauthorization +applicable: Exchange Online, Exchange Online Protection +title: Test-ServicePrincipalAuthorization +schema: 2.0.0 +author: chrisda +ms.author: chrisda +ms.reviewer: +--- + +# Test-ServicePrincipalAuthorization + +## SYNOPSIS +This cmdlet is available only in the cloud-based service. + +Use the Test-ServicePrincipalAuthorization cmdlet to test the access granted by role-based access control (RBAC) for Applications. For more information, see [Role Based Access Control for Applications in Exchange Online](https://learn.microsoft.com/Exchange/permissions-exo/application-rbac). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). + +## SYNTAX + +``` +Test-ServicePrincipalAuthorization [-Identity] + [-Confirm] + [-Resource ] + [-WhatIf] + [] +``` + +## DESCRIPTION +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Test-ServicePrincipalAuthorization -Identity "DemoB" -Resource "Mailbox A" | Format-Table + +RoleName GrantedPermissions AllowedResourceScope ScopeType InScope +-------- ------------------ -------------------- --------- ------ +Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope True +Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit False +Application Contacts.Read Contacts.Read Organization Organization True +``` + +This example tests if this service principal (the app named "DemoB") can exercise each of its assigned permissions against the target mailbox named "Mailbox A." The membership in the scope is indicated by the InScope column. + +### Example 2 +```powershell +PS C:\> Test-ServicePrincipalAuthorization -Identity "DemoB" | Format-Table + +RoleName GrantedPermissions AllowedResourceScope ScopeType InScope +-------- ------------------ -------------------- --------- ------ +Application Mail.Read Mail.Read Canadian Employees CustomRecipientScope Not Run +Application Calendars.Read Calendars.Read 4d819ce9-9257-44.. AdministrativeUnit Not Run +Application Contacts.Read Contacts.Read Organization Organization Not Run +``` + +This example tests the entitlement of the app named "DemoB", including which permissions it has at which scopes. Because the command doesn't use the Resource parameter, the scope membership check is not run. + +## PARAMETERS + +### -Identity +The Identity parameter specifies the service principal that you want to test. You can use any value that uniquely identifies the service principal. For example: + +- Name +- Distinguished name (DN) +- GUID +- AppId +- ServiceId + +```yaml +Type: ServicePrincipalIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Resource +The Resource parameter specifies the target mailbox where the scoped permissions apply. You can use any value that uniquely identifies the mailbox. For example: + +- Name +- Distinguished name (DN) +- Canonical DN +- GUID + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhatIf +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange Online, Exchange Online Protection + +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 + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-SiteMailbox.md b/exchange/exchange-ps/exchange/Test-SiteMailbox.md index c7c028af8a..249202e6e8 100644 --- a/exchange/exchange-ps/exchange/Test-SiteMailbox.md +++ b/exchange/exchange-ps/exchange/Test-SiteMailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/test-sitemailbox +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-SiteMailbox schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Test-SiteMailbox ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. Use the Test-SiteMailbox cmdlet to test the site mailbox to Microsoft SharePoint connectivity and to test whether users have the correct permissions to use a site mailbox. This cmdlet should be used for troubleshooting and diagnostic purposes. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ Test-SiteMailbox [[-Identity] ] ## DESCRIPTION If you don't specify the RequestorIdentity parameter, the command uses the identification of the user running this command. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -79,7 +79,7 @@ You can't use this parameter with the SharePointUrl parameter. Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: 1 @@ -91,13 +91,13 @@ Accept wildcard characters: False ### -BypassOwnerCheck The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. -If you run the command without this parameter and you aren't a member or owner of the site mailbox, then the command will fail. +If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,7 +116,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -143,7 +143,7 @@ If you don't specify this parameter, the command uses the identification of the Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -153,8 +153,6 @@ Accept wildcard characters: False ``` ### -SharePointUrl -This parameter is available only in on-premises Exchange. - The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu". You can't use this parameter with the Identity parameter. @@ -175,13 +173,13 @@ Accept wildcard characters: False ### -UseAppTokenOnly The UseAppTokenOnly switch specifies that you want to test the site mailbox by using the identity of the Exchange server. You don't need to specify a value with this switch. -You can't use this parameter with the RequestorIdentity parameter. +You can't use this switch with the RequestorIdentity parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -197,7 +195,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -211,12 +209,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md b/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md index 27af2fb1c5..68097adcaf 100644 --- a/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-SmtpConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-smtpconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-smtpconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-SmtpConnectivity schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Test-SmtpConnectivity cmdlet to diagnose whether an SMTP connection can successfully be established to the Receive connectors on a specific server. Although you can run this cmdlet manually to verify SMTP connectivity for a specified server, it's primarily used by Microsoft System Center Operations Manager 2007 to test your transport servers' ability to receive SMTP connections to each of the bindings on all the Receive connectors on those servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -41,7 +41,7 @@ When you run the Test-SmtpConnectivity cmdlet against a Mailbox server, the cmdl You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding ` > ` to the command. For example: `Test-SmtpConnectivity Mailbox01 | ConvertTo-Csv > "C:\My Documents\SMTP Test.csv"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -124,7 +124,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -160,12 +163,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-SystemHealth.md b/exchange/exchange-ps/exchange/Test-SystemHealth.md index 63db47c02d..8248f8de34 100644 --- a/exchange/exchange-ps/exchange/Test-SystemHealth.md +++ b/exchange/exchange-ps/exchange/Test-SystemHealth.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-systemhealth +online version: https://learn.microsoft.com/powershell/module/exchange/test-systemhealth applicable: Exchange Server 2010 title: Test-SystemHealth schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Test-SystemHealth cmdlet to gather data about your Microsoft Exchange system and to analyze the data according to best practices. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -47,7 +47,7 @@ Test-SystemHealth [-ADCredentials ] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -60,18 +60,19 @@ This example gathers data about your Exchange system. ### Example 2 ```powershell -$temp=Test-SystemHealth -OutData -Set-Content -Value $temp.FileData -Path d:\temp\SystemHealthOutData.xml -Encoding Byte +$SysHealth = Test-SystemHealth -OutData + +[System.IO.File]::WriteAllBytes('D:\temp\SystemHealthOutData.xml', $SysHealth.FileData) ``` -This example saves the output data as a byte stream to the temporary variable $temp. Then the content is written to the file SystemHealthOutData.xml using the Set-Content cmdlet. +This example saves the output data as a byte stream to the variable named $SysHealth. The content is then written to the SystemHealthOutData.xml file in the D:\\temp folder. ## PARAMETERS ### -ADCredentials The ADCredentials parameter specifies the username and password that's used to access Active Directory. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -87,7 +88,7 @@ Accept wildcard characters: False ``` ### -Analyze -The Analyze parameter specifies whether to enable analysis on the data gathered. A value of $true enables analysis. The default value is $true. +The Analyze switch enables analysis on the data gathered. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -103,7 +104,7 @@ Accept wildcard characters: False ``` ### -Collect -The Collect parameter specifies whether to enable data collection. A value of $true enables data collection. The default value is $true. +The Collect switch enables data collection. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -202,7 +203,7 @@ Accept wildcard characters: False ``` ### -DownloadConfigurationUpdates -The DownloadConfigurationUpdates parameter checks for and downloads newer versions of the configuration file. The default value is $true, which checks for and downloads newer versions of the configuration file. +The DownloadConfigurationUpdates switch checks for and downloads newer versions of the configuration file. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -220,7 +221,7 @@ Accept wildcard characters: False ### -ExchangeCredentials The ExchangeCredentials parameter specifies the username and password that's used to access Exchange servers. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -236,7 +237,7 @@ Accept wildcard characters: False ``` ### -Export -The Export parameter causes sensitive data to be removed from the output file specified. A value of $true causes data removal. The default value is $false. +The Export switch causes sensitive data to be removed from the output file specified. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -316,7 +317,9 @@ Accept wildcard characters: False ``` ### -OutData -The OutData switch specifies whether the output data is sent as a byte stream. For example, if you run $temp=Test-SystemHealth -OutData, $temp contains the byte stream of the output data, and you can covert it back to xml by using the Set-Content command. For a code sample, see "Example 2" later in this topic. +The OutData switch specifies whether the output data is sent as a byte stream. You don't need to specify a value with this switch. + +For example, if you run the command: `$temp = Test-SystemHealth -OutData`, `$temp` contains the byte stream of the output data, and you can covert it back to xml by using the Set-Content command. For a code sample, see "Example 2" in this topic. ```yaml Type: SwitchParameter @@ -432,12 +435,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-TextExtraction.md b/exchange/exchange-ps/exchange/Test-TextExtraction.md index fd39c814b1..43b3808f00 100644 --- a/exchange/exchange-ps/exchange/Test-TextExtraction.md +++ b/exchange/exchange-ps/exchange/Test-TextExtraction.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-textextraction -applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/test-textextraction +applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance title: Test-TextExtraction schema: 2.0.0 author: chrisda @@ -9,15 +9,14 @@ ms.author: chrisda ms.reviewer: --- - # Test-TextExtraction ## SYNOPSIS This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. -Use the Test-TextExtraction cmdlet to find the text that is extracted from a specified email message in Exchange flow. +Use the Test-TextExtraction cmdlet to return the text from unencrypted email message files. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,40 +29,44 @@ Test-TextExtraction [-FileData] ``` ## DESCRIPTION -This cmdlet returns the text that is found in a file in Exchange. The Microsoft classification engine uses this text to classify content and determine which sensitive information types are found in this file/message. +This cmdlet doesn't work on encrypted email message files. + +The Microsoft classification engine uses the results to classify content and determine the sensitive information types in the message file. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell -$content = Test-TextExtraction -FileData (Get-Content -Path '.\financial data.msg' -Encoding byte -ReadCount 0) +$content = Test-TextExtraction -FileData ([System.IO.File]::ReadAllBytes('.\financial data.msg')) + $content.ExtractedResults ``` -This example returns the text that's extracted from the email "financial data.msg" +This example extracts the text from the email message file named "financial data.msg" that's in the same folder where you run the command, and shows the results. ### Example 2 ```powershell -$content = Test-TextExtraction -FileData (Get-Content -Path '.\financial data.msg' -Encoding byte -ReadCount 0) +$content = Test-TextExtraction -FileData ([System.IO.File]::ReadAllBytes('.\financial data.msg')) + Test-DataClassification -TestTextExtractionResults $content.ExtractedResults ``` -This example extracts the text from the email "financial data.msg" and returns the sensitive information types, their confidence, and count. +This example extracts the text from the email message file named "financial data.msg", stores the information in the variable named $content, and uses the variable with the Test-DataClassification cmdlet to return the sensitive information types, their confidence, and count. ## PARAMETERS ### -FileData The FileData parameter specifies the name and path of the file from which text should be extracted. -A valid value for this parameter requires you to read the file to a byte-encoded object using the Get-Content cmdlet. For example, `(Get-Content -Encoding Byte -Path "C:\My Documents\" -ReadCount 0)`. +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml Type: Byte[] Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: True Position: 0 @@ -82,7 +85,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -100,7 +103,7 @@ The DomainController parameter specifies the domain controller that's used by th Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -116,7 +119,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Required: False Position: Named @@ -130,12 +133,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Test-UMConnectivity.md b/exchange/exchange-ps/exchange/Test-UMConnectivity.md index 30a6a2e829..7a6b3e9a41 100644 --- a/exchange/exchange-ps/exchange/Test-UMConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-UMConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.MediaAndDevices-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-umconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-umconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016 title: Test-UMConnectivity schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Test-UMConnectivity cmdlet to test the operation of Unified Messaging (UM) servers. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or Exchange 2016, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -110,7 +110,7 @@ When you run this cmdlet in an on-premises Unified Messaging deployment, you nee After this task is complete, the cmdlet will have tested the operation of the Mailbox server and related telephony components. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -445,7 +445,10 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values for this parameter are $true or $false. The default value is $false. If you specify the value $true, the monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are: + +- $true: Monitoring events and performance counters are included in the command results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). +- $false: Monitoring events and performance counters aren't included in the command results. This is the default value. ```yaml Type: Boolean @@ -529,12 +532,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md index c456dfdc4b..fba4a45320 100644 --- a/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md +++ b/exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RemoteConnections-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/test-webservicesconnectivity +online version: https://learn.microsoft.com/powershell/module/exchange/test-webservicesconnectivity applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Test-WebServicesConnectivity schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in on-premises Exchange. Use the Test-WebServicesConnectivity cmdlet to test client connectivity to Exchange Web Services virtual directories. -**Note**: This cmdlet works best in Exchange 2010. In Exchange 2013 or later, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. +**Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet has been replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -87,9 +87,9 @@ The test results are displayed on-screen. The cmdlet returns the following infor - Result: The values returned are typically Success or \*FAILURE\*. - Latency(MS): The time required to complete the test in milliseconds -You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding `> ` to the command. For example: `Test-WebServicesConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EWS Test.html"`. +You can write the results to a file by piping the output to ConvertTo-Html and Set-Content. For example: `Test-WebServicesConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\EWS Test.html"`. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -203,7 +203,7 @@ Accept wildcard characters: False ### -AllowUnsecureAccess This parameter is available only in Exchange Server 2010. -The AllowUnsecureAccess switch specifies whether to enable the command to continue to run over an unsecured channel that doesn't require Secure Sockets Layer (SSL). +The AllowUnsecureAccess switch specifies whether to enable the command to continue to run over an unsecured channel that doesn't require Secure Sockets Layer (SSL). You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -276,7 +276,7 @@ Accept wildcard characters: False ### -MailboxCredential The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). This parameter is required when you use the Identity parameter. @@ -310,7 +310,9 @@ Accept wildcard characters: False ``` ### -MonitoringContext -The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). You don't need to specify a value with this switch. +The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. + +Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager (SCOM). ```yaml Type: SwitchParameter @@ -326,7 +328,9 @@ Accept wildcard characters: False ``` ### -ResetTestAccountCredentials -The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. +The ResetTestAccountCredentials switch resets the password for the test account that's used to run this command. You don't need to specify a value with this switch. + +The password for the test account is typically reset every seven days. Use this switch to force a password reset any time it's required for security reasons. ```yaml Type: SwitchParameter @@ -358,7 +362,7 @@ Accept wildcard characters: False ``` ### -TrustAnySSLCertificate -The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch. +The TrustAnySSLCertificate switch allows Exchange to accept certificates from untrusted certification authorities (CAs). You don't need to specify a value with this switch. This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL. @@ -378,7 +382,7 @@ Accept wildcard characters: False ### -UseAutodiscoverForClientAccessServer This parameter is available only in Exchange Server 2010. -The UseAutodiscoverForClientAccessServer parameter specifies whether the test should use the Autodiscover service to locate the Client Access server. +The UseAutodiscoverForClientAccessServer switch specifies whether the test should use the Autodiscover service to locate the Client Access server. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter @@ -414,12 +418,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md b/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md index c92b1f5dab..50c11224ce 100644 --- a/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md +++ b/exchange/exchange-ps/exchange/Undo-SoftDeletedMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/undo-softdeletedmailbox +online version: https://learn.microsoft.com/powershell/module/exchange/undo-softdeletedmailbox applicable: Exchange Online title: Undo-SoftDeletedMailbox schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox that has been deleted. Mailboxes can be recovered within 30 days of being deleted. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -50,7 +48,7 @@ Use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox that has been delete If the Microsoft account (formerly known as a Windows Live ID) wasn't deleted when the mailbox was deleted, you have to specify a new Microsoft account and password when you use the Undo-SoftDeletedMailbox cmdlet to recover a mailbox. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -59,48 +57,48 @@ You need to be assigned permissions before you can run this cmdlet. Although thi Undo-SoftDeletedMailbox -SoftDeletedObject florencef ``` -This example recovers the deleted mailbox for the user Florence Flipo. When this mailbox was deleted, the associated Windows Live ID was also deleted. +This example recovers the deleted mailbox for the user Florence Flipo. When this mailbox was deleted, the associated Microsoft account was also deleted. ### Example 2 ```powershell -Undo-SoftDeletedMailbox bjohnson@contoso.edu -WindowsLiveID brianj@contoso.edu -Password (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force) +Undo-SoftDeletedMailbox bjohnson@contoso.edu -WindowsLiveID brianj@contoso.edu -Password (Get-Credential).password ``` -This example recovers the deleted mailbox for the user Brian Johnson. When this mailbox was deleted, the associated Microsoft account (formerly known as a Windows Live ID) wasn't deleted. Note that a new Microsoft account and password have to be created to recover this mailbox. In the scenario, the old Microsoft account is retained as a proxy address for the mailbox. +This example recovers the deleted mailbox for the user Brian Johnson. When this mailbox was deleted, the associated Microsoft account wasn't deleted. Note that a new Microsoft account and password have to be created to recover this mailbox. In the scenario, the old Microsoft account is retained as a proxy address for the mailbox. ## PARAMETERS -### -PublicFolder -The PublicFolder switch is required to recover public folder mailboxes. You don't need to specify a value with this switch. - -Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. +### -SoftDeletedObject +The SoftDeletedObject parameter specifies the deleted mailbox to recover. You can use the alias or the email address of the deleted mailbox for the value of this parameter. Use the Get-Mailbox -SoftDeletedMailbox command to get information for deleted mailboxes. ```yaml -Type: SwitchParameter -Parameter Sets: PublicFolder +Type: MailboxIdParameter +Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -SoftDeletedObject -The SoftDeletedObject parameter specifies the deleted mailbox to recover. You can use the alias or the email address of the deleted mailbox for the value of this parameter. Use the Get-Mailbox -SoftDeletedMailbox command to get information for deleted mailboxes. +### -PublicFolder +The PublicFolder switch is required to recover public folder mailboxes. You don't need to specify a value with this switch. + +Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. ```yaml -Type: MailboxIdParameter -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: PublicFolder Aliases: Applicable: Exchange Online Required: True -Position: 1 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` @@ -158,7 +156,11 @@ Accept wildcard characters: False ### -Password The Password parameter specifies a new password for the mailbox. -This parameter uses the syntax `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter. +You can use the following methods as a value for this parameter: + +- `(ConvertTo-SecureString -String '' -AsPlainText -Force)`. +- Before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable (`$password`) for the value. +- `(Get-Credential).password` to be prompted to enter the password securely when you run this command. You have to include the Password parameter to recover a deleted mailbox with an existing Microsoft account (formerly known as a Windows Live ID) that wasn't deleted with the mailbox. @@ -192,7 +194,7 @@ Accept wildcard characters: False ``` ### -WindowsLiveID -The WindowsLiveID parameter specifies a new Microsoft account (formerly known as a Windows Live ID) and primary SMTP for the mailbox. The previous Microsoft account is retained as a proxy address for the mailbox. +The WindowsLiveID parameter specifies a new Microsoft account (formerly known as a Windows Live ID) and primary SMTP address for the mailbox. The previous Microsoft account is retained as a proxy address for the mailbox. You have to include the WindowsLiveID parameter to recover a deleted mailbox with an existing Microsoft account that wasn't deleted with the mailbox. @@ -214,12 +216,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md index a6cb8f0648..7402d91bdb 100644 --- a/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md +++ b/exchange/exchange-ps/exchange/Undo-SoftDeletedUnifiedGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/undo-softdeletedunifiedgroup +online version: https://learn.microsoft.com/powershell/module/exchange/undo-softdeletedunifiedgroup applicable: Exchange Online title: Undo-SoftDeletedUnifiedGroup schema: 2.0.0 @@ -16,9 +16,7 @@ This cmdlet is available only in the cloud-based service. Use the Undo-SoftDeletedUnifiedGroup cmdlet to restore soft-deleted Microsoft 365 Groups in your cloud-based organization. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,9 +32,9 @@ Microsoft 365 Groups are group objects that are available across Microsoft 365 s Soft-deleted Microsoft 365 Groups are groups that have been deleted, but can be restored within 30 days of being deleted. All of the group contents can be restored within this period. After 30 days, soft-deleted Microsoft 365 Groups are marked for permanent deletion and can't be restored. -To display all soft-deleted Microsoft 365 Groups in your organization, use the Get-AzureADMSDeletedGroup cmdlet in Azure Active Directory PowerShell. To permanently remove (purge) a soft-deleted Microsoft 365 Group, use the Remove-AzureADMSDeletedDirectoryObject cmdlet in Azure Active Directory PowerShell. For more information, see [Permanently delete a Microsoft 365 Group](https://docs.microsoft.com/microsoft-365/admin/create-groups/restore-deleted-group#permanently-delete-a-microsoft-365-group). +To display all soft-deleted Microsoft 365 Groups in your organization, use the [Get-MgDirectoryDeletedItemAsGroup](https://learn.microsoft.com/powershell/module/microsoft.graph.identity.directorymanagement/get-mgdirectorydeleteditemasgroup) cmdlet in Microsoft Graph PowerShell. To permanently remove (purge) a soft-deleted Microsoft 365 Group, use the [Remove-MgDirectoryDeletedItem](https://learn.microsoft.com/powershell/module/microsoft.graph.identity.directorymanagement/remove-mgdirectorydeleteditem) cmdlet in Microsoft Graph PowerShell. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +116,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md b/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md index 606850fe82..5618a653c7 100644 --- a/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md +++ b/exchange/exchange-ps/exchange/Uninstall-TransportAgent.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/uninstall-transportagent +online version: https://learn.microsoft.com/powershell/module/exchange/uninstall-transportagent applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Uninstall-TransportAgent schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Uninstall-TransportAgent cmdlet to unregister transport agents from Exchange servers. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ You can install and uninstall transport agents in the following locations: - The Front End Transport service on Mailbox servers. - Edge Transport servers. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -145,12 +145,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-AddressList.md b/exchange/exchange-ps/exchange/Update-AddressList.md index a395c77590..8c44e68434 100644 --- a/exchange/exchange-ps/exchange/Update-AddressList.md +++ b/exchange/exchange-ps/exchange/Update-AddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-addresslist +online version: https://learn.microsoft.com/powershell/module/exchange/update-addresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-AddressList schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-AddressList cmdlet to update the recipients included in address lists. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Update-AddressList [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -119,12 +119,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md index 1bb776a61d..dfbaff31dc 100644 --- a/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md +++ b/exchange/exchange-ps/exchange/Update-ComplianceCaseMember.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-compliancecasemember -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/update-compliancecasemember +applicable: Security & Compliance title: Update-ComplianceCaseMember schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Update-ComplianceCaseMember ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Update-ComplianceCaseMember cmdlet to replace all members of eDiscovery cases in the Microsoft 365 compliance center. To add or remove existing members, use the Add-ComplianceCaseMember and Remove-ComplianceCaseMember cmdlets. +Use the Update-ComplianceCaseMember cmdlet to replace all members of eDiscovery cases in the Microsoft Purview compliance portal. To add or remove existing members, use the Add-ComplianceCaseMember and Remove-ComplianceCaseMember cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ To add a member of an eDiscovery case, the user needs to be a member of the Revi - Create and edit compliance searches associated with a case. - Perform compliance actions (for example, export) on the results of a compliance search. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -58,7 +58,7 @@ To see the available eDiscovery cases, use the Get-ComplianceCase cmdlet. Type: String Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: 1 @@ -81,7 +81,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -100,7 +100,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -110,13 +110,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -130,12 +130,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Update-DatabaseSchema.md b/exchange/exchange-ps/exchange/Update-DatabaseSchema.md index 298e7eef9d..1ca485d6cb 100644 --- a/exchange/exchange-ps/exchange/Update-DatabaseSchema.md +++ b/exchange/exchange-ps/exchange/Update-DatabaseSchema.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-databaseschema +online version: https://learn.microsoft.com/powershell/module/exchange/update-databaseschema applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-DatabaseSchema schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-DatabaseSchema cmdlet to upgrade the database schema for one or more databases after an Exchange software update that includes database schema updates has been installed on Mailbox servers in a database availability group (DAG). Some software updates for Exchange may include database schema updates. After such an update has been installed on all members of a DAG, the administrator must run the Update-DatabaseSchema cmdlet for each database in the DAG and dismount/mount or failover the database to trigger the database schema update. The in-place database schema upgrade engine ensures that no schema updates occur until all members of the DAG have compatible versions of the software. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +28,7 @@ Update-DatabaseSchema [-Identity] -MajorVersion - ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -133,12 +133,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md index 10018e5978..cc94a00944 100644 --- a/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md +++ b/exchange/exchange-ps/exchange/Update-DistributionGroupMember.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-distributiongroupmember +online version: https://learn.microsoft.com/powershell/module/exchange/update-distributiongroupmember applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Update-DistributionGroupMember schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Update-DistributionGroupMember cmdlet to replace all members of distribution groups and mail-enabled security groups. To add or remove existing group members, use the Add-DistributionGroupMember and Remove-DistributionGroupMember cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Update-DistributionGroupMember [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -68,13 +68,13 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -175,12 +175,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md b/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md deleted file mode 100644 index a77cb3529c..0000000000 --- a/exchange/exchange-ps/exchange/Update-EOPDistributionGroupMember.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-eopdistributiongroupmember -applicable: Exchange Online Protection -title: Update-EOPDistributionGroupMember -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Update-EOPDistributionGroupMember - -## SYNOPSIS -This cmdlet is available only in Exchange Online Protection. - -Use the Update-EOPDistributionGroupMember cmdlet to add or remove members from distribution groups and mail-enabled security groups in standalone Exchange Online Protection (EOP) organizations without Exchange Online mailboxes. This cmdlet isn't available in EOP that's included with Exchange Enterprise CAL with Services licenses in on-premises Exchange; use the Update-DistributionGroupMember cmdlet instead. - -Typically, standalone EOP organizations that also have on-premises Active Directory use directory synchronization to create users and groups in EOP. However, if you can't use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP. - -This cmdlet uses a batch processing method that results in a propagation delay of a few minutes before the results of the cmdlet are visible. - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Update-EOPDistributionGroupMember [-Identity ] - [-ExternalDirectoryObjectId ] - [-Members ] - [] -``` - -## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Update-EOPDistributionGroupMember -Identity "Security Team" -Members @("Kitty Petersen","Tyson Fawcett") -``` - -This example replaces the current members of the Security Team distribution group with Kitty Petersen and Tyson Fawcett. - -### Example 2 -```powershell -$CurrentMemberObjects = Get-DistributionGroupMember "Security Team" -$CurrentMemberNames = $CurrentMemberObjects | % {$_.name} -$CurrentMemberNames += "Tyson Fawcett" -Update-EOPDistributionGroupMember -Identity "Security Team" -Members $CurrentMemberNames -``` - -This example adds a new user named Tyson Fawcett to the distribution group named Security Team while preserving the current members of the group. The current member objects are retrieved in a collection, the collection is filtered to extract the names, the user "Tyson Fawcett" is added, and the updated name list replaces the current membership of the distribution group. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the distribution group or mail-enabled security group that you want to update. You can use any value that uniquely identifies the group. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -```yaml -Type: DistributionGroupIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalDirectoryObjectId -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Members -The Members parameter specifies the list of recipients (mail-enabled objects) in the distribution group or mail-enabled security group. In Exchange Online Protection, the valid recipient types are: - -- Mail users -- Distribution groups -- Mail-enabled security groups - -You can use any value that uniquely identifies the recipient. For example: - -- Name -- Alias -- Distinguished name (DN) -- Canonical DN -- Email address -- GUID - -To replace the current members of the group with the recipients that you specify, use the syntax `@("Recipient1","Recipient2",..."RecipientN")`. To add new group members without affecting the existing members, see Example 2 in the Examples section. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md b/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md index 4b280b0be7..a5ab8316da 100644 --- a/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md +++ b/exchange/exchange-ps/exchange/Update-EmailAddressPolicy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-emailaddresspolicy +online version: https://learn.microsoft.com/powershell/module/exchange/update-emailaddresspolicy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-EmailAddressPolicy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-EmailAddressPolicy cmdlet to apply new or updated email address policies to the affected recipients in an on-premises Exchange organization. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,7 +31,7 @@ Update-EmailAddressPolicy [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,7 +118,9 @@ Accept wildcard characters: False ``` ### -UpdateSecondaryAddressesOnly -The UpdateSecondaryAddressesOnly switch parameter specifies that only the proxy email addresses are updated for the recipients. The recipient's primary email address isn't updated. You don't need to specify a value with this switch. +The UpdateSecondaryAddressesOnly switch specifies that only the proxy email addresses are updated for the recipients. You don't need to specify a value with this switch. + +The recipient's primary email address isn't updated. ```yaml Type: SwitchParameter @@ -154,12 +156,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md b/exchange/exchange-ps/exchange/Update-ExchangeHelp.md index b1f7c10595..01778dcf54 100644 --- a/exchange/exchange-ps/exchange/Update-ExchangeHelp.md +++ b/exchange/exchange-ps/exchange/Update-ExchangeHelp.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-exchangehelp +online version: https://learn.microsoft.com/powershell/module/exchange/update-exchangehelp applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-ExchangeHelp schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-ExchangeHelp cmdlet to find, download and install the latest available help topics for the Exchange Management Shell on the local computer. If an available version is found based your installed version and languages of Exchange, the cmdlet downloads and integrates the updated version of Help in the Exchange Management Shell. This cmdlet is a required substitute for the Update-Help cmdlet that's available in Windows PowerShell. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,9 +28,9 @@ Update-ExchangeHelp [-Force] ## DESCRIPTION The Update-ExchangeHelp cmdlet is available in Exchange Server 2013 or later. -You need to run the Update-ExchangeHelp cmdlet on each Exchange server. By default, the cmdlet requires an Internet connection, but you can configure an offline mode. For more information, see [Use Update-ExchangeHelp to update Exchange PowerShell help topics on Exchange servers](https://docs.microsoft.com/powershell/exchange/use-update-exchangehelp). +You need to run the Update-ExchangeHelp cmdlet on each Exchange server. By default, the cmdlet requires an Internet connection, but you can configure an offline mode. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -44,7 +44,7 @@ This example checks for the latest available version of Help for the Exchange Ma ## PARAMETERS ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. By default, the Update-ExchangeHelp cmdlet has a throttling period of 24 hours. If you run this cmdlet within 24 hours of the last time you ran it, it won't check for updates. You can use this switch to force the cmdlet to check for updates more frequently and to display status or error messages. @@ -66,12 +66,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-FileDistributionService.md b/exchange/exchange-ps/exchange/Update-FileDistributionService.md index 7fd9c62174..869bf696a3 100644 --- a/exchange/exchange-ps/exchange/Update-FileDistributionService.md +++ b/exchange/exchange-ps/exchange/Update-FileDistributionService.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-filedistributionservice +online version: https://learn.microsoft.com/powershell/module/exchange/update-filedistributionservice applicable: Exchange Server 2010 title: Update-FileDistributionService schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Update-FileDistributionService cmdlet to access the Microsoft Exchange File Distribution service to poll for offline address book (OAB), Group Metrics, and Unified Messaging (UM) configuration and data. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -34,7 +34,7 @@ The Update-FileDistributionService cmdlet forces the Microsoft Exchange File Dis If you don't use the Type parameter when running this command, OAB, Unified Messaging, and Group Metrics data are reloaded. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -160,12 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-GlobalAddressList.md b/exchange/exchange-ps/exchange/Update-GlobalAddressList.md index 24fcf20c40..8fe39ea94d 100644 --- a/exchange/exchange-ps/exchange/Update-GlobalAddressList.md +++ b/exchange/exchange-ps/exchange/Update-GlobalAddressList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-globaladdresslist +online version: https://learn.microsoft.com/powershell/module/exchange/update-globaladdresslist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-GlobalAddressList schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-GlobalAddressList cmdlet to update the recipients included in a global address list (GAL). -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Update-GlobalAddressList [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -118,12 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md index 3ad71d29e6..bb0e1ea9e9 100644 --- a/exchange/exchange-ps/exchange/Update-HybridConfiguration.md +++ b/exchange/exchange-ps/exchange/Update-HybridConfiguration.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-hybridconfiguration +online version: https://learn.microsoft.com/powershell/module/exchange/update-hybridconfiguration applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Update-HybridConfiguration schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Update-HybridConfiguration cmdlet to define the credentials that are used to update the hybrid configuration object. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -31,14 +31,16 @@ Update-HybridConfiguration -OnPremisesCredentials -TenantCredenti ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES ### Example 1 ```powershell $OnPremisesCreds = Get-Credential + $TenantCreds = Get-Credential + Update-HybridConfiguration -OnPremisesCredentials $OnPremisesCreds -TenantCredentials $TenantCreds ``` @@ -55,7 +57,7 @@ Use the last command to define the credentials that are used to update the hybri ### -OnPremisesCredentials The OnPremisesCredentials parameter specifies the on-premises Active Directory account and password that's used to configure the hybrid configuration object. This account must be a member of the Organization Management role group. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -71,9 +73,12 @@ Accept wildcard characters: False ``` ### -TenantCredentials -The TenantCredentials parameter specifies the Microsoft 365 organization account and password that's used to configure the hybrid configuration object. This is often the administrator account that's assigned when the Microsoft 365 organization was created. This account must be a member of the Global admin role. +The TenantCredentials parameter specifies the Microsoft 365 organization account and password that's used to configure the hybrid configuration object. This is often the administrator account that's assigned when the Microsoft 365 organization was created. This account must be a member of the Global Administrators role. + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. -A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://docs.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). +A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value `(Get-Credential)`. Or, before you run this command, store the credentials in a variable (for example, `$cred = Get-Credential`) and then use the variable name (`$cred`) for this parameter. For more information, see [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential). ```yaml Type: PSCredential @@ -126,9 +131,9 @@ Accept wildcard characters: False ``` ### -ForceUpgrade -The ForceUpgrade switch specifies whether to suppress the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. +The ForceUpgrade switch suppresses the confirmation message that appears if the object was created in a previous version of Exchange. You don't need to specify a value with this switch. -This confirmation prompt is only displayed when the existing HybridConfiguration Active Directory object version is Exchange 2010. +This confirmation prompt is displayed only when the existing HybridConfiguration Active Directory object version is Exchange 2010. ```yaml Type: SwitchParameter @@ -180,12 +185,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md b/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md index f55abcecb2..b7f5614479 100644 --- a/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md +++ b/exchange/exchange-ps/exchange/Update-MailboxDatabaseCopy.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-mailboxdatabasecopy +online version: https://learn.microsoft.com/powershell/module/exchange/update-mailboxdatabasecopy applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-MailboxDatabaseCopy schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-MailboxDatabaseCopy cmdlet to seed or reseed a mailbox database copy. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -77,9 +77,9 @@ Seeding is the process in which a copy of a mailbox database is added to another The Update-MailboxDatabaseCopy cmdlet can also be used to seed a content index catalog for a mailbox database copy. When you do this, the MAPI network is used, regardless of the value you specify with the Network parameter. -You must suspend a database copy before you can update it using the Update-MailboxDatabaseCopy cmdlet. For detailed steps about how to suspend a database copy, see [Suspend or resume a mailbox database copy](https://docs.microsoft.com/Exchange/high-availability/manage-ha/suspend-resume-db-copies). +You must suspend a database copy before you can update it using the Update-MailboxDatabaseCopy cmdlet. For detailed steps about how to suspend a database copy, see [Suspend or resume a mailbox database copy](https://learn.microsoft.com/Exchange/high-availability/manage-ha/suspend-resume-db-copies). -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -272,7 +272,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -479,12 +481,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md b/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md index 5657a0f8ca..c9dd29eb20 100644 --- a/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md +++ b/exchange/exchange-ps/exchange/Update-OfflineAddressBook.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-offlineaddressbook +online version: https://learn.microsoft.com/powershell/module/exchange/update-offlineaddressbook applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-OfflineAddressBook schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-OfflineAddressBook cmdlet to update the offline address books (OABs) used by Microsoft Outlook clients. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Update-OfflineAddressBook [-Identity] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -97,7 +97,9 @@ Accept wildcard characters: False ``` ### -Force -The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch. +The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. + +You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. ```yaml Type: SwitchParameter @@ -133,12 +135,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-PublicFolder.md b/exchange/exchange-ps/exchange/Update-PublicFolder.md index e7ef82d6bf..52de562a91 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolder.md +++ b/exchange/exchange-ps/exchange/Update-PublicFolder.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-publicfolder +online version: https://learn.microsoft.com/powershell/module/exchange/update-publicfolder applicable: Exchange Server 2010 title: Update-PublicFolder schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in Exchange Server 2010. Use the Update-PublicFolder cmdlet to start content synchronization of a public folder. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -29,7 +29,7 @@ Update-PublicFolder [-Identity] -Server ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -119,12 +119,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=2081749). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md b/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md index a75fa9c5c6..cfef60bbfd 100644 --- a/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md +++ b/exchange/exchange-ps/exchange/Update-PublicFolderMailbox.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.WebClient-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-publicfoldermailbox +online version: https://learn.microsoft.com/powershell/module/exchange/update-publicfoldermailbox applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online title: Update-PublicFolderMailbox schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Update-PublicFolderMailbox cmdlet to update the hierarchy for public folders. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -45,9 +45,9 @@ Update-PublicFolderMailbox [-Identity] -FolderId ").Identity`. @@ -80,7 +81,7 @@ The Identity parameter specifies the role group whose membership you want to mod Type: RoleGroupIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: True Position: 1 @@ -90,13 +91,13 @@ Accept wildcard characters: False ``` ### -BypassSecurityGroupManagerCheck -The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: +The BypassSecurityGroupManagerCheck switch specifies whether to allow a user who isn't an owner of the group to modify or delete the group. You don't need to specify a value with this switch. + +If you aren't defined in the ManagedBy property of the group, you need to use this switch in commands that modify or delete the group. To use this switch, your account requires specific permissions based on the group type: - Distribution groups or mail-enabled security groups: You need to be a member of the Organization Management role group or have the Security Group Creation and Membership role assigned. - Role groups: You need to be a member of the Organization Management role group or have the Role Management role assigned. -You don't need to specify a value with this switch. - ```yaml Type: SwitchParameter Parameter Sets: (All) @@ -120,7 +121,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -156,7 +157,7 @@ By default, the values that you specify overwrite the existing membership list o Type: MultiValuedProperty Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -166,7 +167,7 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. 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. @@ -174,7 +175,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance Center, Exchange Online Protection +Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection Required: False Position: Named @@ -188,12 +189,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-SafeList.md b/exchange/exchange-ps/exchange/Update-SafeList.md index 07a0a32048..9b052ebd8b 100644 --- a/exchange/exchange-ps/exchange/Update-SafeList.md +++ b/exchange/exchange-ps/exchange/Update-SafeList.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailControl-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-safelist +online version: https://learn.microsoft.com/powershell/module/exchange/update-safelist applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-SafeList schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-SafeList cmdlet to update the safelist aggregation data in Active Directory. Safelist aggregation data is used in the built-in anti-spam filtering in Microsoft Exchange. EdgeSync replicates safelist aggregation data to Edge Transport servers in the perimeter network. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -36,7 +36,7 @@ The Update-SafeList cmdlet reads the safelist aggregation data stored on a Micro Be mindful of the network and replication traffic that may be generated when you run the Update-SafeList cmdlet. Running the command on multiple mailboxes where safelists are heavily used may generate a significant amount of traffic. We recommend that if you run the command on multiple mailboxes, you should run the command during off-peak, non-business hours. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -50,6 +50,7 @@ This example updates Safe Senders List data for the single user kim@contoso.com. ### Example 2 ```powershell Set-AdServerSettings -ViewEntireForest $true + Get-Mailbox -ResultSize Unlimited -RecipientTypeDetails UserMailbox | Update-Safelist ``` @@ -120,7 +121,7 @@ Accept wildcard characters: False ``` ### -EnsureJunkEmailRule -The EnsureJunkEmailRule parameter specifies whether to force the junk email rule to be turned on for the mailbox if the rule isn't turned on already. +The EnsureJunkEmailRule switch forces the junk email rule to be turned on for the mailbox if the rule isn't turned on already. You don't need to specify a value with this switch. The junk email rule can only be created after the user logs on to the mailbox. If the user has never logged on to the mailbox, this parameter can't turn on the junk email rule. @@ -138,7 +139,9 @@ Accept wildcard characters: False ``` ### -IncludeDomains -The IncludeDomains switch specifies whether to include the sender domains specified by users in Outlook in the safelist aggregation data. By default, domains specified by the senders aren't included. +The IncludeDomains switch specifies whether to include the sender domains specified by users in Outlook in the safelist aggregation data. You don't need to specify a value with this switch. + +By default, domains specified by the senders aren't included. In most cases, we don't recommend that you include domains because users may include the domains of large Internet service providers (ISPs), which could unintentionally provide addresses that may be used or spoofed by spammers. @@ -194,12 +197,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-SiteMailbox.md b/exchange/exchange-ps/exchange/Update-SiteMailbox.md index 000a479a85..e56a3a732f 100644 --- a/exchange/exchange-ps/exchange/Update-SiteMailbox.md +++ b/exchange/exchange-ps/exchange/Update-SiteMailbox.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-sitemailbox -applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +online version: https://learn.microsoft.com/powershell/module/exchange/update-sitemailbox +applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-SiteMailbox schema: 2.0.0 author: chrisda @@ -12,13 +12,13 @@ ms.reviewer: # Update-SiteMailbox ## SYNOPSIS -This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other. - -Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). +This cmdlet is available only in on-premises Exchange. Use the Update-SiteMailbox cmdlet to trigger a Microsoft SharePoint synchronization. This command synchronizes document content membership and permissions into Microsoft Exchange. You may need to perform this action when troubleshooting document or membership synchronization issues. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see [Deprecation of Site Mailboxes](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/deprecation-of-site-mailboxes/ba-p/93028). + +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -37,7 +37,7 @@ Update-SiteMailbox [-Identity] ## DESCRIPTION If you are running this command against a site mailbox in which you aren't the owner, you need to use the BypassOwnerCheck parameter to run this cmdlet. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -71,7 +71,7 @@ The Identity parameter specifies the site mailbox that you want to update. You c Type: RecipientIdParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: True Position: 1 @@ -81,13 +81,15 @@ Accept wildcard characters: False ``` ### -BypassOwnerCheck -The BypassOwnerCheck parameter specifies that the user running the command in the Exchange Management Shell isn't a site mailbox owner or member. If you run the command without this parameter and you aren't the site mailbox owner or member, the command doesn't run or return any information. +The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch. + +If you don't use this switch, and you aren't a member or owner of the site mailbox, the command will fail. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -106,7 +108,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -116,13 +118,13 @@ Accept wildcard characters: False ``` ### -FullSync -The FullSync parameter specifies full sync is expensive and will have a performance impact on the Exchange system. +The FullSync switch specifies full sync is expensive and will have a performance impact on the Exchange system. You don't need to specify a value with this switch. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -132,8 +134,6 @@ Accept wildcard characters: False ``` ### -Organization -This parameter is available only in on-premises Exchange. - This parameter is reserved for internal Microsoft use. ```yaml @@ -150,8 +150,6 @@ Accept wildcard characters: False ``` ### -Server -This parameter is available only in on-premises Exchange. - The Server parameter specifies the fully qualified domain name (FQDN) or the Microsoft SharePoint server on which the site mailbox is located. ```yaml @@ -180,7 +178,7 @@ If you don't specify this parameter when you run the cmdlet, this parameter valu Type: TargetType Parameter Sets: (All) Aliases: -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -196,7 +194,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online +Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 Required: False Position: Named @@ -210,12 +208,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/Update-StoreMailboxState.md b/exchange/exchange-ps/exchange/Update-StoreMailboxState.md index f955ea589a..d586e3c49e 100644 --- a/exchange/exchange-ps/exchange/Update-StoreMailboxState.md +++ b/exchange/exchange-ps/exchange/Update-StoreMailboxState.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RolesAndAccess-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-storemailboxstate +online version: https://learn.microsoft.com/powershell/module/exchange/update-storemailboxstate applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 title: Update-StoreMailboxState schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available only in on-premises Exchange. Use the Update-StoreMailboxState cmdlet to synchronize the mailbox state for a mailbox in the Exchange mailbox store with the state of the corresponding Active Directory user account. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -30,7 +30,7 @@ Update-StoreMailboxState -Database -Identity -ModuleId -PolicyId + [-Confirm] + [-Everyone ] + [-IsFeatureEnabled ] + [-IsUserControlEnabled ] + [-IsUserOptedInByDefault ] + [-GroupIds ] + [-Name ] + [-ResultSize ] + [-UserIds ] + [-WhatIf] + [] +``` + +## DESCRIPTION +Use the Update-VivaModuleFeaturePolicy cmdlet to update an access policy for a feature in a Viva module in Viva. + +This cmdlet updates the attributes of the policy that you specify. These attributes include: + +- The policy name (Name parameter). +- Whether or not the policy enables the feature (IsFeatureEnabled parameter). +- Whether or not the policy enables user controls (IsUserControlEnabled parameter, only applicable to a feature policy). +- Who the policy applies to (the UserIds and GroupIds parameters or the Everyone parameter). + +You can update these attributes independently of each other. For example, if you specify the Name parameter but not the IsFeatureEnabled parameter, the name of the policy is updated but whether or not the policy enables the feature remains unchanged. + +**Important**: Values that you specify for the UserIds and/or GroupIds parameters or the Everyone parameter **overwrite** any existing users or groups. To preserve the existing users and groups, you need to specify those existing users or groups **and** any additional users or groups that you want to add. Not including existing users or groups in the command effectively removes those specific users or groups from the policy. For more information, see the examples. + +You need to use the Connect-ExchangeOnline cmdlet to authenticate. + +This cmdlet requires the .NET Framework 4.7.2 or later. + +Currently, you need to be a member of the Global Administrators role or the roles that have been assigned at the feature level to run this cmdlet. + +To learn more about assigned roles at the feature level, see [Features Available for Feature Access Management](https://learn.microsoft.com/viva/feature-access-management#features-available-for-feature-access-management). + +To learn more about administrator role permissions in Microsoft Entra ID, see [Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids). + +> [!IMPORTANT] +> Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. + +## EXAMPLES + +### Example 1 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b1 -Name NewPolicyName -IsFeatureEnabled $false +``` + +This example updates the name of the specified policy and makes it so the policy does not enable the feature. + +### Example 2 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -GroupIds group1@contoso.com,group2@contoso.com +``` + +This example updates who the specified policy applies to. The policy now applies **only** to the specified groups, overwriting the users and groups the policy used to apply to. + +### Example 3 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -UserIds user1@contoso.com,user2@contoso.com +``` + +This example updates who the specified policy applies to. The policy now applies **only** to the specified users, overwriting the users and groups the policy used to apply to. + +### Example 4 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId VivaInsights -FeatureId Reflection -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -Name NewPolicyName -IsFeatureEnabled $true -GroupIds group1@contoso.com,57680382-61a5-4378-85ad-f72095d4e9c3 -UserIds user1@contoso.com +``` + +This example updates the name of the specified policy, makes it so the policy enables the feature, and updates who the policy applies to. The policy now applies **only** to the specified users and groups, overwriting the users and groups the policy used to apply to. + +### Example 5 +```powershell +Update-VivaModuleFeaturePolicy -ModuleId PeopleSkills -FeatureId ShowAISkills -PolicyId 3db38dfa-02a3-4039-b33a-42b0b3da029b -IsFeatureEnabled $true -IsUserControlEnabled $true -IsUserOptedInByDefault $false +``` + +This example updates a policy for the ShowAISkills feature in Viva Skills. The policy enables the feature for the users previously added to the policy, allows user controls, and opted out users by default (Soft Disable policy). + +## PARAMETERS + +### -FeatureId +The FeatureId parameter specifies the feature in the Viva module of the policy that you want to update. + +To view details about the features in a Viva module that support feature access controls, use the Get-VivaModuleFeature cmdlet. The FeatureId value is returned in the output of the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleId +The ModuleId parameter specifies the Viva module of the policy that you want to update. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyId +The PolicyId parameter specifies the policy for the feature in the Viva module that you want to update. + +To view details about the policies for a feature in a Viva module, use the Get-VivaModuleFeaturePolicy cmdlet. The PolicyId value is returned in the output of the cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: True +Position: Named +Default value: None +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`. +- 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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Everyone +The Everyone parameter specifies that the updated policy applies to all users in the organization. Valid values are: + +- $true: The policy applies to all users. This is the only useful value for this parameter. +- $false: Don't use this value. + +If you don't want to update who the policy applies to, don't use this parameter. + +Don't use this parameter with the GroupIds or UserIds parameters. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupIds +The GroupIds parameter specifies the email addresses or security group object IDs (GUIDs) of groups that the updated policy applies to. Both [Mail-enabled and non-mail-enabled Microsoft Entra groups](https://docs.microsoft.com/graph/api/resources/groups-overview#group-types-in-azure-ad-and-microsoft-graph) are supported. You can enter multiple values separated by commas. + +If you don't want to update who the policy applies to, don't use this parameter. + +The values that you specify for this parameter or the UserIds parameter replace any existing groups. To preserve the existing groups, include them along with any new users or groups that you specify. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. + +**Note**: In v3.5.1-Preview2 or later of the module, this parameter supports security group object IDs (GUIDs). Previous versions of the module accept only email addresses for this parameter. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -IsFeatureEnabled +The IsFeatureEnabled parameter specifies whether the feature is enabled by the updated policy. Valid values are: + +- $true: The feature is enabled by the policy. +- $false: The feature is not enabled by the policy. + +If you don't want to update whether the feature is enabled by the policy, don't use this parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserControlEnabled +**Note**: This parameter is available in version 3.3.0 or later of the module. If the feature supports user controls for opting out, make sure you set the *IsUserControlEnabled* parameter when you create the policy. Otherwise, user controls for the policy use the default state for the feature. + +The IsUserControlEnabled parameter specifies whether user control is enabled by the policy. Valid values are: + +- $true: User control is enabled by the policy. Users can opt out of the feature. +- $false: User control isn't enabled by the policy. Users can't opt of the feature. + +Only features that allow admins to enable and disable user controls by policy can use this parameter. If the feature doesn't support admins toggling user controls, the default value applies. See the feature documentation for more information. + +If you don't want to update whether the user control is enabled by the policy, don't use this parameter. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsUserOptedInByDefault +This parameter is available in version 3.8.0-Preview2 or later of the module. + +The IsUserOptedInByDefault parameter specifies whether users are opted in by default by the policy. Valid values are: + +- $true: By default, users are opted in by the policy if the user hasn't set a preference. +- $false: By default, users are opted out by the policy if the user hasn't set a preference. + +This parameter is optional and can be used to override the default user opt-in value set in the feature metadata. + +This parameter can be set only when the IsUserControlEnabled parameter is set to $true. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The Name parameter specifies the updated name for the policy. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks ("). + +Valid characters are English letters, numbers, commas, periods, and spaces. + +If you don't want to update the name of the policy, don't use this parameter. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResultSize +This parameter is reserved for internal Microsoft use. + +```yaml +Type: Unlimited +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserIds +The UserIds parameter specifies the user principal names (UPNs) of users that the updated policy applies to. You can enter multiple values separated by commas. + +If you don't want to update who the policy applies to, don't use this parameter. + +The values that you specify for this parameter or the GroupIds parameter replace any existing users. To preserve the existing users, include them along with any new users or groups that you specify. + +You can specify a maximum of 20 total users or groups (20 users and no groups, 10 users and 10 groups, etc.). + +To have the updated policy apply to all users in the organization, use the Everyone parameter with the value $true. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online + +Required: False +Position: Named +Default value: None +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Applicable: Exchange 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/p/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[Exchange PowerShell](https://learn.microsoft.com/powershell/module/exchange) + +[About the Exchange Online PowerShell module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2) + +[Role template IDs](https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference#role-template-ids) diff --git a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md index cf941c6528..bd36987193 100644 --- a/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md +++ b/exchange/exchange-ps/exchange/Update-eDiscoveryCaseAdmin.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/update-ediscoverycaseadmin -applicable: Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/update-ediscoverycaseadmin +applicable: Security & Compliance title: Update-eDiscoveryCaseAdmin schema: 2.0.0 author: chrisda @@ -12,11 +12,11 @@ ms.reviewer: # Update-eDiscoveryCaseAdmin ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). -Use the Update-eDiscoveryCaseAdmin cmdlet to replace all existing eDiscovery Administrators in the Microsoft 365 compliance center. To add or remove individual eDiscovery Administrators, use the Add-eDiscoveryCaseAdmin and Remove-eDiscoveryCaseAdmin cmdlets. +Use the Update-eDiscoveryCaseAdmin cmdlet to replace all existing eDiscovery Administrators in the Microsoft Purview compliance portal. To add or remove individual eDiscovery Administrators, use the Add-eDiscoveryCaseAdmin and Remove-eDiscoveryCaseAdmin cmdlets. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,11 +28,11 @@ Update-eDiscoveryCaseAdmin -Users ``` ## DESCRIPTION -An eDiscovery Administrator is member of the eDiscovery Manager role group who can also view and access all eDiscovery cases in your organization. +An eDiscovery Administrator is a member of the eDiscovery Manager role group who can view and access all eDiscovery cases in the organization. To make a user an eDiscovery Administrator, add them to the eDiscovery Manager role group by running the following command in Security & Compliance PowerShell: `Add-RoleGroupMember -Identity "eDiscovery Manager" -Member ""`. -To make a user an eDiscovery Administrator, the user must be assigned the Case Management role. By default, this role is assigned to the Organization Management and eDiscovery Manager role groups. +After the user is a member of the eDiscovery Manager role group, you can then use this cmdlet to add them to the list of eDiscovery Administrators. -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -59,7 +59,7 @@ You can enter multiple values separated by commas. If the values contain spaces Type: String[] Parameter Sets: (All) Aliases: -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: True Position: Named @@ -78,7 +78,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -88,13 +88,13 @@ Accept wildcard characters: False ``` ### -WhatIf -The WhatIf switch doesn't work in Security & Compliance Center PowerShell. +The WhatIf switch doesn't work in Security & Compliance PowerShell. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Security & Compliance Center +Applicable: Security & Compliance Required: False Position: Named @@ -108,12 +108,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md index d813a9f001..d0092da6bc 100644 --- a/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md +++ b/exchange/exchange-ps/exchange/Upgrade-DistributionGroup.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.CalendarsAndGroups-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/upgrade-distributiongroup +online version: https://learn.microsoft.com/powershell/module/exchange/upgrade-distributiongroup applicable: Exchange Online, Exchange Online Protection title: Upgrade-DistributionGroup schema: 2.0.0 @@ -18,9 +18,7 @@ Use the Upgrade-DistributionGroup cmdlet to upgrade distribution groups to Micro **Note**: Before you use this cmdlet, verify there are no email address policies that you created with the IncludeUnifiedGroupRecipients parameter; otherwise the command will fail. Remove and recreate the email address policies after you upgrade your distribution groups to Microsoft 365 Groups. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,11 +26,12 @@ For information about the parameter sets in the Syntax section below, see [Excha Upgrade-DistributionGroup [-DlIdentities] [-ActionType ] [-ExecutingUser ] + [-Organization ] [] ``` ## DESCRIPTION -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -95,17 +94,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Organization +This parameter is reserved for internal Microsoft use. + +```yaml +Type: OrganizationIdParameter +Parameter Sets: (All) +Aliases: +Applicable: Exchange Online, Exchange Online Protection + +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 -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md b/exchange/exchange-ps/exchange/Validate-OutboundConnector.md index 5a33f9c5e8..e096f825c2 100644 --- a/exchange/exchange-ps/exchange/Validate-OutboundConnector.md +++ b/exchange/exchange-ps/exchange/Validate-OutboundConnector.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/validate-outboundconnector +online version: https://learn.microsoft.com/powershell/module/exchange/validate-outboundconnector applicable: Exchange Online, Exchange Online Protection title: Validate-OutboundConnector schema: 2.0.0 @@ -16,9 +16,9 @@ This cmdlet is available only in the cloud-based service. Use the Validate-OutboundConnector cmdlet to test the settings of Outbound connectors in Microsoft 365. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). +**Note**: This cmdlet does not set the validation status or timestamp on the connector. To set these values, run the following command: `Set-OutboundConnector -Identity "" -IsValidated $true -LastValidationTimestamp (Get-Date).ToUniversalTime()`. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -35,7 +35,7 @@ The Validate-OutboundConnector cmdlet performs two tests on the specified connec - SMTP connectivity to each smart host that's defined on the connector. - Send test email messages to one or more recipients in the domain that's configured on the connector. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -126,12 +126,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md b/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md index 424893e922..c4a8ee7175 100644 --- a/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md +++ b/exchange/exchange-ps/exchange/Validate-RetentionRuleQuery.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.Exchange.TransportMailflow-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/validate-retentionrulequery -applicable: Exchange Online, Security & Compliance Center +online version: https://learn.microsoft.com/powershell/module/exchange/validate-retentionrulequery +applicable: Exchange Online, Security & Compliance title: Validate-RetentionRuleQuery schema: 2.0.0 author: chrisda @@ -12,13 +12,11 @@ ms.reviewer: # Validate-RetentionRuleQuery ## SYNOPSIS -This cmdlet is available only in Security & Compliance Center PowerShell. For more information, see [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell). +This cmdlet is available only in Security & Compliance PowerShell. For more information, see [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell). Use the Validate-RetentionRuleQuery cmdlet to validate the Keyword Query Language (KQL) content search filters for retention rules. -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -28,7 +26,7 @@ Validate-RetentionRuleQuery -KqlQueryString ``` ## DESCRIPTION -To use this cmdlet in Security & Compliance Center PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft 365 compliance center](https://docs.microsoft.com/microsoft-365/compliance/microsoft-365-compliance-center-permissions). +To use this cmdlet in Security & Compliance PowerShell, you need to be assigned permissions. For more information, see [Permissions in the Microsoft Purview compliance portal](https://learn.microsoft.com/purview/microsoft-365-compliance-center-permissions). ## EXAMPLES @@ -44,13 +42,13 @@ This example validates the specified KQL content search filter. ### -KqlQueryString The KqlQueryString parameter specifies the KQL text search string that you want to validate. -This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information about KQL, see [Keyword Query Language (KQL) syntax reference](https://docs.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). +This parameter uses a text search string or a query that's formatted by using the Keyword Query Language (KQL). For more information, see [Keyword Query Language (KQL) syntax reference](https://learn.microsoft.com/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference) and [Keyword queries and search conditions for eDiscovery](https://learn.microsoft.com/purview/ediscovery-keyword-queries-and-search-conditions). ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Exchange Online, Security & Compliance Center +Applicable: Exchange Online, Security & Compliance Required: True Position: Named @@ -64,12 +62,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### - ## OUTPUTS -### - ## NOTES ## RELATED LINKS diff --git a/exchange/exchange-ps/exchange/Write-AdminAuditLog.md b/exchange/exchange-ps/exchange/Write-AdminAuditLog.md index 864c839a07..3545297054 100644 --- a/exchange/exchange-ps/exchange/Write-AdminAuditLog.md +++ b/exchange/exchange-ps/exchange/Write-AdminAuditLog.md @@ -1,6 +1,6 @@ --- external help file: Microsoft.Exchange.RecordsandEdge-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/write-adminauditlog +online version: https://learn.microsoft.com/powershell/module/exchange/write-adminauditlog applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection title: Write-AdminAuditLog schema: 2.0.0 @@ -16,7 +16,7 @@ This cmdlet is available in on-premises Exchange and in the cloud-based service. Use the Write-AdminAuditLog cmdlet to write a comment to the administrator audit log. -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). ## SYNTAX @@ -33,7 +33,7 @@ When the Write-AdminAuditLog cmdlet runs, the value provided in the Comment para For the Write-AdminAuditLog cmdlet to write to the audit log, it must be included in the list of cmdlets being logged by administrator audit logging. -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). ## EXAMPLES @@ -122,12 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Input types To see the input types that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. ## OUTPUTS -### +### Output types To see the return types, which are also known as output types, that this cmdlet accepts, see [Cmdlet Input and Output Types](https://go.microsoft.com/fwlink/p/?LinkId=616387). If the Output Type field is blank, the cmdlet doesn't return data. ## NOTES diff --git a/exchange/exchange-ps/exchange/exchange.md b/exchange/exchange-ps/exchange/exchange.md index 6a74489c20..8ead57cb12 100644 --- a/exchange/exchange-ps/exchange/exchange.md +++ b/exchange/exchange-ps/exchange/exchange.md @@ -8,10 +8,18 @@ title: exchange ## Description Exchange PowerShell is built on Windows PowerShell technology and provides a powerful command-line interface that enables automation of administrative tasks. The following PowerShell environments are available in Exchange: -- [Exchange Server PowerShell (Exchange Management Shell)](https://docs.microsoft.com/powershell/exchange/exchange-management-shell) -- [Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell) -- [Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/scc-powershell) -- [Exchange Online Protection PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-online-protection-powershell) +- [Exchange Server PowerShell (Exchange Management Shell)](https://learn.microsoft.com/powershell/exchange/exchange-management-shell) +- [Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell) +- [Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/scc-powershell) +- [Exchange Online Protection PowerShell](https://learn.microsoft.com/powershell/exchange/exchange-online-protection-powershell) + +> [!NOTE] +> For Exchange Online, Security & Compliance, and Exchange Online Protection, the module from the PowerShell Gallery that you use to connect is [ExchangeOnlineManagement](https://www.powershellgallery.com/packages/ExchangeOnlineManagement/). For more information, see [About the Exchange Online PowerShell module](../../docs-conceptual/exchange-online-powershell-v2.md). +> +> For Exchange Server, there is no Microsoft-provided module in the PowerShell Gallery. Instead, to use PowerShell in Exchange, you have the following options: +> +> - Use the Exchange Management Shell on an Exchange server or that you've installed locally on your own computer using a **Management tools** only installation of Exchange server. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](../../docs-conceptual/open-the-exchange-management-shell.md). +> - Use remote PowerShell from a Windows PowerShell session. For more information, see [Connect to Exchange servers using remote PowerShell](../../docs-conceptual/connect-to-exchange-servers-using-remote-powershell.md). ## active-directory Cmdlets ### [Add-ADPermission](Add-ADPermission.md) @@ -47,36 +55,42 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ## defender-for-office-365 Cmdlets ### [Disable-AntiPhishRule](Disable-AntiPhishRule.md) +### [Disable-ATPProtectionPolicyRule](Disable-ATPProtectionPolicyRule.md) + ### [Disable-SafeAttachmentRule](Disable-SafeAttachmentRule.md) ### [Disable-SafeLinksRule](Disable-SafeLinksRule.md) ### [Enable-AntiPhishRule](Enable-AntiPhishRule.md) +### [Enable-ATPProtectionPolicyRule](Enable-ATPProtectionPolicyRule.md) + ### [Enable-SafeAttachmentRule](Enable-SafeAttachmentRule.md) ### [Enable-SafeLinksRule](Enable-SafeLinksRule.md) -### [Get-AdvancedThreatProtectionDocumentDetail](Get-AdvancedThreatProtectionDocumentDetail.md) - -### [Get-AdvancedThreatProtectionDocumentReport](Get-AdvancedThreatProtectionDocumentReport.md) - -### [Get-AdvancedThreatProtectionTrafficReport](Get-AdvancedThreatProtectionTrafficReport.md) - ### [Get-AntiPhishPolicy](Get-AntiPhishPolicy.md) ### [Get-AntiPhishRule](Get-AntiPhishRule.md) +### [Get-ATPBuiltInProtectionRule](Get-ATPBuiltInProtectionRule.md) + ### [Get-AtpPolicyForO365](Get-AtpPolicyForO365.md) +### [Get-ATPProtectionPolicyRule](Get-ATPProtectionPolicyRule.md) + ### [Get-ATPTotalTrafficReport](Get-ATPTotalTrafficReport.md) +### [Get-ContentMalwareMdoAggregateReport](Get-ContentMalwareMdoAggregateReport.md) + +### [Get-ContentMalwareMdoDetailReport](Get-ContentMalwareMdoDetailReport.md) + +### [Get-EmailTenantSettings](Get-EmailTenantSettings.md) + ### [Get-MailDetailATPReport](Get-MailDetailATPReport.md) ### [Get-MailTrafficATPReport](Get-MailTrafficATPReport.md) -### [Get-PhishFilterPolicy](Get-PhishFilterPolicy.md) - ### [Get-SafeAttachmentPolicy](Get-SafeAttachmentPolicy.md) ### [Get-SafeAttachmentRule](Get-SafeAttachmentRule.md) @@ -89,14 +103,18 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SafeLinksRule](Get-SafeLinksRule.md) -### [Get-SpoofMailReport](Get-SpoofMailReport.md) +### [Get-SpoofIntelligenceInsight](Get-SpoofIntelligenceInsight.md) -### [Get-UrlTrace](Get-UrlTrace.md) +### [Get-SpoofMailReport](Get-SpoofMailReport.md) ### [New-AntiPhishPolicy](New-AntiPhishPolicy.md) ### [New-AntiPhishRule](New-AntiPhishRule.md) +### [New-ATPBuiltInProtectionRule](New-ATPBuiltInProtectionRule.md) + +### [New-ATPProtectionPolicyRule](New-ATPProtectionPolicyRule.md) + ### [New-SafeAttachmentPolicy](New-SafeAttachmentPolicy.md) ### [New-SafeAttachmentRule](New-SafeAttachmentRule.md) @@ -109,6 +127,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-AntiPhishRule](Remove-AntiPhishRule.md) +### [Remove-ATPProtectionPolicyRule](Remove-ATPProtectionPolicyRule.md) + ### [Remove-SafeAttachmentPolicy](Remove-SafeAttachmentPolicy.md) ### [Remove-SafeAttachmentRule](Remove-SafeAttachmentRule.md) @@ -121,9 +141,13 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-AntiPhishRule](Set-AntiPhishRule.md) +### [Set-ATPBuiltInProtectionRule](Set-ATPBuiltInProtectionRule.md) + ### [Set-AtpPolicyForO365](Set-AtpPolicyForO365.md) -### [Set-PhishFilterPolicy](Set-PhishFilterPolicy.md) +### [Set-ATPProtectionPolicyRule](Set-ATPProtectionPolicyRule.md) + +### [Set-EmailTenantSettings](Set-EmailTenantSettings.md) ### [Set-SafeAttachmentPolicy](Set-SafeAttachmentPolicy.md) @@ -148,14 +172,20 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Delete-QuarantineMessage](Delete-QuarantineMessage.md) +### [Disable-EOPProtectionPolicyRule](Disable-EOPProtectionPolicyRule.md) + ### [Disable-HostedContentFilterRule](Disable-HostedContentFilterRule.md) ### [Disable-HostedOutboundSpamFilterRule](Disable-HostedOutboundSpamFilterRule.md) ### [Disable-MalwareFilterRule](Disable-MalwareFilterRule.md) +### [Disable-ReportSubmissionRule](Disable-ReportSubmissionRule.md) + ### [Enable-AntispamUpdates](Enable-AntispamUpdates.md) +### [Enable-EOPProtectionPolicyRule](Enable-EOPProtectionPolicyRule.md) + ### [Enable-HostedContentFilterRule](Enable-HostedContentFilterRule.md) ### [Enable-HostedOutboundSpamFilterRule](Enable-HostedOutboundSpamFilterRule.md) @@ -164,20 +194,38 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Export-QuarantineMessage](Export-QuarantineMessage.md) +### [Enable-ReportSubmissionRule](Enable-ReportSubmissionRule.md) + ### [Get-AgentLog](Get-AgentLog.md) +### [Get-AggregateZapReport](Get-AggregateZapReport.md) + +### [Get-ArcConfig](Get-ArcConfig.md) + ### [Get-AttachmentFilterEntry](Get-AttachmentFilterEntry.md) ### [Get-AttachmentFilterListConfig](Get-AttachmentFilterListConfig.md) +### [Get-BlockedConnector](Get-BlockedConnector.md) + ### [Get-BlockedSenderAddress](Get-BlockedSenderAddress.md) +### [Get-ConfigAnalyzerPolicyRecommendation](Get-ConfigAnalyzerPolicyRecommendation.md) + ### [Get-ContentFilterConfig](Get-ContentFilterConfig.md) ### [Get-ContentFilterPhrase](Get-ContentFilterPhrase.md) +### [Get-DetailZapReport](Get-DetailZapReport.md) + ### [Get-DkimSigningConfig](Get-DkimSigningConfig.md) +### [Get-EOPProtectionPolicyRule](Get-EOPProtectionPolicyRule.md) + +### [Get-ExoPhishSimOverrideRule](Get-ExoPhishSimOverrideRule.md) + +### [Get-ExoSecOpsOverrideRule](Get-ExoSecOpsOverrideRule.md) + ### [Get-HostedConnectionFilterPolicy](Get-HostedConnectionFilterPolicy.md) ### [Get-HostedContentFilterPolicy](Get-HostedContentFilterPolicy.md) @@ -214,17 +262,19 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-PhishSimOverridePolicy](Get-PhishSimOverridePolicy.md) -### [Get-PhishSimOverrideRule](Get-PhishSimOverrideRule.md) - ### [Get-QuarantineMessage](Get-QuarantineMessage.md) ### [Get-QuarantineMessageHeader](Get-QuarantineMessageHeader.md) +### [Get-QuarantinePolicy](Get-QuarantinePolicy.md) + ### [Get-RecipientFilterConfig](Get-RecipientFilterConfig.md) -### [Get-SecOpsOverridePolicy](Get-SecOpsOverridePolicy.md) +### [Get-ReportSubmissionPolicy](Get-ReportSubmissionPolicy.md) + +### [Get-ReportSubmissionRule](Get-ReportSubmissionRule.md) -### [Get-SecOpsOverrideRule](Get-SecOpsOverrideRule.md) +### [Get-SecOpsOverridePolicy](Get-SecOpsOverridePolicy.md) ### [Get-SenderFilterConfig](Get-SenderFilterConfig.md) @@ -232,10 +282,22 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SenderReputationConfig](Get-SenderReputationConfig.md) +### [Get-TeamsProtectionPolicy](Get-TeamsProtectionPolicy.md) + +### [Get-TeamsProtectionPolicyRule](Get-TeamsProtectionPolicyRule.md) + ### [Get-TenantAllowBlockListItems](Get-TenantAllowBlockListItems.md) +### [Get-TenantAllowBlockListSpoofItems](Get-TenantAllowBlockListSpoofItems.md) + ### [New-DkimSigningConfig](New-DkimSigningConfig.md) +### [New-EOPProtectionPolicyRule](New-EOPProtectionPolicyRule.md) + +### [New-ExoPhishSimOverrideRule](New-ExoPhishSimOverrideRule.md) + +### [New-ExoSecOpsOverrideRule](New-ExoSecOpsOverrideRule.md) + ### [New-HostedContentFilterPolicy](New-HostedContentFilterPolicy.md) ### [New-HostedContentFilterRule](New-HostedContentFilterRule.md) @@ -250,24 +312,42 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-PhishSimOverridePolicy](New-PhishSimOverridePolicy.md) -### [New-PhishSimOverrideRule](New-PhishSimOverrideRule.md) +### [New-QuarantinePermissions](New-QuarantinePermissions.md) + +### [New-QuarantinePolicy](New-QuarantinePolicy.md) + +### [New-ReportSubmissionPolicy](New-ReportSubmissionPolicy.md) + +### [New-ReportSubmissionRule](New-ReportSubmissionRule.md) ### [New-SecOpsOverridePolicy](New-SecOpsOverridePolicy.md) -### [New-SecOpsOverrideRule](New-SecOpsOverrideRule.md) +### [New-TeamsProtectionPolicy](New-TeamsProtectionPolicy.md) + +### [New-TeamsProtectionPolicyRule](New-TeamsProtectionPolicyRule.md) ### [New-TenantAllowBlockListItems](New-TenantAllowBlockListItems.md) +### [New-TenantAllowBlockListSpoofItems](New-TenantAllowBlockListSpoofItems.md) + ### [Preview-QuarantineMessage](Preview-QuarantineMessage.md) ### [Release-QuarantineMessage](Release-QuarantineMessage.md) ### [Remove-AttachmentFilterEntry](Remove-AttachmentFilterEntry.md) +### [Remove-BlockedConnector](Remove-BlockedConnector.md) + ### [Remove-BlockedSenderAddress](Remove-BlockedSenderAddress.md) ### [Remove-ContentFilterPhrase](Remove-ContentFilterPhrase.md) +### [Remove-EOPProtectionPolicyRule](Remove-EOPProtectionPolicyRule.md) + +### [Remove-ExoPhishSimOverrideRule](Remove-ExoPhishSimOverrideRule.md) + +### [Remove-ExoSecOpsOverrideRule](Remove-ExoSecOpsOverrideRule.md) + ### [Remove-HostedContentFilterPolicy](Remove-HostedContentFilterPolicy.md) ### [Remove-HostedContentFilterRule](Remove-HostedContentFilterRule.md) @@ -290,22 +370,34 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-PhishSimOverridePolicy](Remove-PhishSimOverridePolicy.md) -### [Remove-PhishSimOverrideRule](Remove-PhishSimOverrideRule.md) +### [Remove-QuarantinePolicy](Remove-QuarantinePolicy.md) -### [Remove-SecOpsOverridePolicy](Remove-SecOpsOverridePolicy.md) +### [Remove-ReportSubmissionPolicy](Remove-ReportSubmissionPolicy.md) + +### [Remove-ReportSubmissionRule](Remove-ReportSubmissionRule.md) -### [Remove-SecOpsOverrideRule](Remove-SecOpsOverrideRule.md) +### [Remove-SecOpsOverridePolicy](Remove-SecOpsOverridePolicy.md) ### [Remove-TenantAllowBlockListItems](Remove-TenantAllowBlockListItems.md) +### [Remove-TenantAllowBlockListSpoofItems](Remove-TenantAllowBlockListSpoofItems.md) + ### [Rotate-DkimSigningConfig](Rotate-DkimSigningConfig.md) +### [Set-ArcConfig](Set-ArcConfig.md) + ### [Set-AttachmentFilterListConfig](Set-AttachmentFilterListConfig.md) ### [Set-ContentFilterConfig](Set-ContentFilterConfig.md) ### [Set-DkimSigningConfig](Set-DkimSigningConfig.md) +### [Set-EOPProtectionPolicyRule](Set-EOPProtectionPolicyRule.md) + +### [Set-ExoPhishSimOverrideRule](Set-ExoPhishSimOverrideRule.md) + +### [Set-ExoSecOpsOverrideRule](Remove-ExoSecOpsOverrideRule.md) + ### [Set-HostedConnectionFilterPolicy](Set-HostedConnectionFilterPolicy.md) ### [Set-HostedContentFilterPolicy](Set-HostedContentFilterPolicy.md) @@ -338,13 +430,17 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-PhishSimOverridePolicy](Set-PhishSimOverridePolicy.md) -### [Set-PhishSimOverrideRule](Set-PhishSimOverrideRule.md) +### [Set-QuarantinePermissions](Set-QuarantinePermissions.md) + +### [Set-QuarantinePolicy](Set-QuarantinePolicy.md) ### [Set-RecipientFilterConfig](Set-RecipientFilterConfig.md) -### [Set-SecOpsOverridePolicy](Set-SecOpsOverridePolicy.md) +### [Set-ReportSubmissionPolicy](Set-ReportSubmissionPolicy.md) + +### [Set-ReportSubmissionRule](Set-ReportSubmissionRule.md) -### [Set-SecOpsOverrideRule](Set-SecOpsOverrideRule.md) +### [Set-SecOpsOverridePolicy](Set-SecOpsOverridePolicy.md) ### [Set-SenderFilterConfig](Set-SenderFilterConfig.md) @@ -352,8 +448,14 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-SenderReputationConfig](Set-SenderReputationConfig.md) +### [Set-TeamsProtectionPolicy](Set-TeamsProtectionPolicy.md) + +### [Set-TeamsProtectionPolicyRule](Set-TeamsProtectionPolicyRule.md) + ### [Set-TenantAllowBlockListItems](Set-TenantAllowBlockListItems.md) +### [Set-TenantAllowBlockListSpoofItems](Set-TenantAllowBlockListSpoofItems.md) + ### [Test-IPAllowListProvider](Test-IPAllowListProvider.md) ### [Test-IPBlockListProvider](Test-IPBlockListProvider.md) @@ -413,7 +515,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-CASMailbox](Set-CASMailbox.md) -### [set-CASMailboxPlan](set-CASMailboxPlan.md) +### [Set-CASMailboxPlan](Set-CASMailboxPlan.md) ### [Set-ClientAccessRule](Set-ClientAccessRule.md) @@ -790,20 +892,18 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-M365DataAtRestEncryptionPolicyAssignment](Get-M365DataAtRestEncryptionPolicyAssignment.md) +### [Get-MailboxIRMAccess](Get-MailboxIRMAccess.md) + ### [Get-OMEConfiguration](Get-OMEConfiguration.md) ### [Get-OMEMessageStatus](Get-OMEMessageStatus.md) ### [Get-RMSTemplate](Get-RMSTemplate.md) -### [Get-RMSTrustedPublishingDomain](Get-RMSTrustedPublishingDomain.md) - ### [Get-SmimeConfig](Get-SmimeConfig.md) ### [Import-ExchangeCertificate](Import-ExchangeCertificate.md) -### [Import-RMSTrustedPublishingDomain](Import-RMSTrustedPublishingDomain.md) - ### [New-DataEncryptionPolicy](New-DataEncryptionPolicy.md) ### [New-ExchangeCertificate](New-ExchangeCertificate.md) @@ -814,9 +914,9 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-ExchangeCertificate](Remove-ExchangeCertificate.md) -### [Remove-OMEConfiguration](Remove-OMEConfiguration.md) +### [Remove-MailboxIRMAccess](Remove-MailboxIRMAccess.md) -### [Remove-RMSTrustedPublishingDomain](Remove-RMSTrustedPublishingDomain.md) +### [Remove-OMEConfiguration](Remove-OMEConfiguration.md) ### [Set-DataEncryptionPolicy](Set-DataEncryptionPolicy.md) @@ -826,14 +926,14 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-M365DataAtRestEncryptionPolicyAssignment](Set-M365DataAtRestEncryptionPolicyAssignment.md) +### [Set-MailboxIRMAccess](Set-MailboxIRMAccess.md) + ### [Set-OMEConfiguration](Set-OMEConfiguration.md) ### [Set-OMEMessageRevocation](Set-OMEMessageRevocation.md) ### [Set-RMSTemplate](Set-RMSTemplate.md) -### [Set-RMSTrustedPublishingDomain](Set-RMSTrustedPublishingDomain.md) - ### [Set-SmimeConfig](Set-SmimeConfig.md) ### [Test-IRMConfiguration](Test-IRMConfiguration.md) @@ -855,8 +955,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-HybridConfiguration](Get-HybridConfiguration.md) -### [Get-HybridMailflow](Get-HybridMailflow.md) - ### [Get-HybridMailflowDatacenterIPs](Get-HybridMailflowDatacenterIPs.md) ### [Get-IntraOrganizationConfiguration](Get-IntraOrganizationConfiguration.md) @@ -897,8 +995,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-HybridConfiguration](Set-HybridConfiguration.md) -### [Set-HybridMailflow](Set-HybridMailflow.md) - ### [Set-IntraOrganizationConnector](Set-IntraOrganizationConnector.md) ### [Set-OnPremisesOrganization](Set-OnPremisesOrganization.md) @@ -964,6 +1060,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-SearchDocumentFormat](Set-SearchDocumentFormat.md) +### [Start-MailboxAssistant](Start-MailboxAssistant.md) + ### [Test-AssistantHealth](Test-AssistantHealth.md) ### [Test-ExchangeSearch](Test-ExchangeSearch.md) @@ -1005,6 +1103,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Enable-SweepRule](Enable-SweepRule.md) +### [Expedite-Delicensing](Expedite-Delicensing.md) + ### [Export-MailboxDiagnosticLogs](Export-MailboxDiagnosticLogs.md) ### [Export-RecipientDataProperty](Export-RecipientDataProperty.md) @@ -1069,6 +1169,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-MessageCategory](Get-MessageCategory.md) +### [Get-PendingDelicenseUser](Get-PendingDelicenseUser.md) + ### [Get-Place](Get-Place.md) ### [Get-RecipientPermission](Get-RecipientPermission.md) @@ -1081,8 +1183,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-UserPhoto](Get-UserPhoto.md) -### [Import-ContactList](Import-ContactList.md) - ### [Import-RecipientDataProperty](Import-RecipientDataProperty.md) ### [New-App](New-App.md) @@ -1198,8 +1298,20 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ## mail-flow Cmdlets ### [Add-ResubmitRequest](Add-ResubmitRequest.md) +### [Disable-DnssecForVerifiedDomain](Disable-DnssecForVerifiedDomain.md) + +### [Disable-IPv6ForAcceptedDomain](Disable-IPv6ForAcceptedDomain.md) + +### [Disable-SmtpDaneInbound](Disable-SmtpDaneInbound.md) + ### [Disable-TransportAgent](Disable-TransportAgent.md) +### [Enable-DnssecForVerifiedDomain](Enable-DnssecForVerifiedDomain.md) + +### [Enable-IPv6ForAcceptedDomain](Enable-IPv6ForAcceptedDomain.md) + +### [Enable-SmtpDaneInbound](Enable-SmtpDaneInbound.md) + ### [Enable-TransportAgent](Enable-TransportAgent.md) ### [Export-Message](Export-Message.md) @@ -1210,6 +1322,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-DeliveryAgentConnector](Get-DeliveryAgentConnector.md) +### [Get-DnssecStatusForVerifiedDomain](Get-DnssecStatusForVerifiedDomain.md) + ### [Get-EdgeSubscription](Get-EdgeSubscription.md) ### [Get-EdgeSyncServiceConfig](Get-EdgeSyncServiceConfig.md) @@ -1220,6 +1334,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-InboundConnector](Get-InboundConnector.md) +### [Get-IPv6StatusForAcceptedDomain](Get-IPv6StatusForAcceptedDomain.md) + ### [Get-MailboxTransportService](Get-MailboxTransportService.md) ### [Get-Message](Get-Message.md) @@ -1250,6 +1366,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SendConnector](Get-SendConnector.md) +### [Get-SmtpDaneInboundStatus](Get-SmtpDaneInboundStatus.md) + ### [Get-SystemMessage](Get-SystemMessage.md) ### [Get-TransportAgent](Get-TransportAgent.md) @@ -1518,8 +1636,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ExchangeServerAccessLicenseUser](Get-ExchangeServerAccessLicenseUser.md) +### [Get-ExchangeFeature](Get-ExchangeFeature.md) + ### [Get-ExchangeSettings](Get-ExchangeSettings.md) +### [Get-FeatureConfiguration](Get-FeatureConfiguration.md) + ### [Get-Notification](Get-Notification.md) ### [Get-OrganizationConfig](Get-OrganizationConfig.md) @@ -1528,6 +1650,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-PerimeterConfig](Get-PerimeterConfig.md) +### [Get-ServicePrincipal](Get-ServicePrincipal.md) + ### [Get-SettingOverride](Get-SettingOverride.md) ### [New-ApplicationAccessPolicy](New-ApplicationAccessPolicy.md) @@ -1538,8 +1662,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-ExchangeSettings](New-ExchangeSettings.md) +### [New-FeatureConfiguration](New-FeatureConfiguration.md) + ### [New-PartnerApplication](New-PartnerApplication.md) +### [New-ServicePrincipal](New-ServicePrincipal.md) + ### [New-SettingOverride](New-SettingOverride.md) ### [Remove-ApplicationAccessPolicy](Remove-ApplicationAccessPolicy.md) @@ -1548,8 +1676,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-AuthServer](Remove-AuthServer.md) +### [Remove-FeatureConfiguration](Remove-FeatureConfiguration.md) + ### [Remove-PartnerApplication](Remove-PartnerApplication.md) +### [Remove-ServicePrincipal](Remove-ServicePrincipal.md) + ### [Remove-SettingOverride](Remove-SettingOverride.md) ### [Set-AccessToCustomerDataRequest](Set-AccessToCustomerDataRequest.md) @@ -1566,10 +1698,14 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-ExchangeAssistanceConfig](Set-ExchangeAssistanceConfig.md) +### [Set-ExchangeFeature](Set-ExchangeFeature.md) + ### [Set-ExchangeServer](Set-ExchangeServer.md) ### [Set-ExchangeSettings](Set-ExchangeSettings.md) +### [Set-FeatureConfiguration](Set-FeatureConfiguration.md) + ### [Set-Notification](Set-Notification.md) ### [Set-OrganizationConfig](Set-OrganizationConfig.md) @@ -1578,12 +1714,16 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-PerimeterConfig](Set-PerimeterConfig.md) +### [Set-ServicePrincipal](Set-ServicePrincipal.md) + ### [Set-SettingOverride](Set-SettingOverride.md) ### [Test-ApplicationAccessPolicy](Test-ApplicationAccessPolicy.md) ### [Test-OAuthConnectivity](Test-OAuthConnectivity.md) +### [Test-ServicePrincipalAuthorization](Test-ServicePrincipalAuthorization.md) + ### [Test-SystemHealth](Test-SystemHealth.md) ### [Update-ExchangeHelp](Update-ExchangeHelp.md) @@ -1609,14 +1749,20 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Export-TransportRuleCollection](Export-TransportRuleCollection.md) -### [Get-ActivityAlert](Get-ActivityAlert.md) - ### [Get-AdministrativeUnit](Get-AdministrativeUnit.md) ### [Get-AutoSensitivityLabelPolicy](Get-AutoSensitivityLabelPolicy.md) ### [Get-AutoSensitivityLabelRule](Get-AutoSensitivityLabelRule.md) +### [Get-EtrLimits](Get-EtrLimits.md) + +### [Get-ExoInformationBarrierPolicy](Get-ExoInformationBarrierPolicy.md) + +### [Get-ExoInformationBarrierSegment](Get-ExoInformationBarrierSegment.md) + +### [Get-ExoInformationBarrierRelationship](Get-ExoInformationBarrierRelationship.md) + ### [Get-InformationBarrierPoliciesApplicationStatus](Get-InformationBarrierPoliciesApplicationStatus.md) ### [Get-InformationBarrierPolicy](Get-InformationBarrierPolicy.md) @@ -1637,6 +1783,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ProtectionAlert](Get-ProtectionAlert.md) +### [Get-ReviewItems](Get-ReviewItems.md) + ### [Get-SupervisoryReviewPolicyV2](Get-SupervisoryReviewPolicyV2.md) ### [Get-SupervisoryReviewRule](Get-SupervisoryReviewRule.md) @@ -1653,7 +1801,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Install-UnifiedCompliancePrerequisite](Install-UnifiedCompliancePrerequisite.md) -### [New-ActivityAlert](New-ActivityAlert.md) +### [Invoke-ComplianceSecurityFilterAction](Invoke-ComplianceSecurityFilterAction.md) ### [New-AutoSensitivityLabelPolicy](New-AutoSensitivityLabelPolicy.md) @@ -1681,8 +1829,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-TransportRule](New-TransportRule.md) -### [Remove-ActivityAlert](Remove-ActivityAlert.md) - ### [Remove-AutoSensitivityLabelPolicy](Remove-AutoSensitivityLabelPolicy.md) ### [Remove-AutoSensitivityLabelRule](Remove-AutoSensitivityLabelRule.md) @@ -1703,14 +1849,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-ProtectionAlert](Remove-ProtectionAlert.md) -### [Remove-RecordLabel](Remove-RecordLabel.md) - ### [Remove-SupervisoryReviewPolicyV2](Remove-SupervisoryReviewPolicyV2.md) ### [Remove-TransportRule](Remove-TransportRule.md) -### [Set-ActivityAlert](Set-ActivityAlert.md) - ### [Set-AutoSensitivityLabelPolicy](Set-AutoSensitivityLabelPolicy.md) ### [Set-AutoSensitivityLabelRule](Set-AutoSensitivityLabelRule.md) @@ -1748,10 +1890,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-AuditConfig](Get-AuditConfig.md) -### [Get-AuditConfigurationPolicy](Get-AuditConfigurationPolicy.md) - -### [Get-AuditConfigurationRule](Get-AuditConfigurationRule.md) - ### [Get-AuditLogSearch](Get-AuditLogSearch.md) ### [Get-MailboxAuditBypassAssociation](Get-MailboxAuditBypassAssociation.md) @@ -1760,18 +1898,10 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-AdminAuditLogSearch](New-AdminAuditLogSearch.md) -### [New-AuditConfigurationPolicy](New-AuditConfigurationPolicy.md) - -### [New-AuditConfigurationRule](New-AuditConfigurationRule.md) - ### [New-MailboxAuditLogSearch](New-MailboxAuditLogSearch.md) ### [New-UnifiedAuditLogRetentionPolicy](New-UnifiedAuditLogRetentionPolicy.md) -### [Remove-AuditConfigurationPolicy](Remove-AuditConfigurationPolicy.md) - -### [Remove-AuditConfigurationRule](Remove-AuditConfigurationRule.md) - ### [Remove-UnifiedAuditLogRetentionPolicy](Remove-UnifiedAuditLogRetentionPolicy.md) ### [Search-AdminAuditLog](Search-AdminAuditLog.md) @@ -1784,8 +1914,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-AuditConfig](Set-AuditConfig.md) -### [Set-AuditConfigurationRule](Set-AuditConfigurationRule.md) - ### [Set-MailboxAuditBypassAssociation](Set-MailboxAuditBypassAssociation.md) ### [Set-UnifiedAuditLogRetentionPolicy](Set-UnifiedAuditLogRetentionPolicy.md) @@ -1836,6 +1964,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Stop-MailboxSearch](Stop-MailboxSearch.md) ## policy-and-compliance-dlp Cmdlets +### [Export-ActivityExplorerData](Export-ActivityExplorerData.md) + ### [Export-DlpPolicyCollection](Export-DlpPolicyCollection.md) ### [Get-ClassificationRuleCollection](Get-ClassificationRuleCollection.md) @@ -1854,6 +1984,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-DlpEdmSchema](Get-DlpEdmSchema.md) +### [Get-DlpIncidentDetailReport](Get-DlpIncidentDetailReport.md) + ### [Get-DlpKeywordDictionary](Get-DlpKeywordDictionary.md) ### [Get-DlpPolicy](Get-DlpPolicy.md) @@ -1990,8 +2122,16 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ## policy-and-compliance-retention Cmdlets ### [Enable-ComplianceTagStorage](Enable-ComplianceTagStorage.md) +### [Export-ContentExplorerData](Export-ContentExplorerData.md) + ### [Export-FilePlanProperty](Export-FilePlanProperty.md) +### [Get-AdaptiveScope](Get-AdaptiveScope.md) + +### [Get-AppRetentionCompliancePolicy](Get-AppRetentionCompliancePolicy.md) + +### [Get-AppRetentionComplianceRule](Get-AppRetentionComplianceRule.md) + ### [Get-ComplianceRetentionEvent](Get-ComplianceRetentionEvent.md) ### [Get-ComplianceRetentionEventType](Get-ComplianceRetentionEventType.md) @@ -2042,6 +2182,14 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Import-FilePlanProperty](Import-FilePlanProperty.md) +### [Invoke-HoldRemovalAction](Invoke-HoldRemovalAction.md) + +### [New-AdaptiveScope](New-AdaptiveScope.md) + +### [New-AppRetentionCompliancePolicy](New-AppRetentionCompliancePolicy.md) + +### [New-AppRetentionComplianceRule](New-AppRetentionComplianceRule.md) + ### [New-ComplianceRetentionEvent](New-ComplianceRetentionEvent.md) ### [New-ComplianceRetentionEventType](New-ComplianceRetentionEventType.md) @@ -2078,6 +2226,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-RetentionPolicyTag](New-RetentionPolicyTag.md) +### [Remove-AdaptiveScope](Remove-AdaptiveScope.md) + +### [Remove-AppRetentionCompliancePolicy](Remove-AppRetentionCompliancePolicy.md) + +### [Remove-AppRetentionComplianceRule](Remove-AppRetentionComplianceRule.md) + ### [Remove-ComplianceRetentionEventType](Remove-ComplianceRetentionEventType.md) ### [Remove-ComplianceTag](Remove-ComplianceTag.md) @@ -2112,6 +2266,12 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-RetentionPolicyTag](Remove-RetentionPolicyTag.md) +### [Set-AdaptiveScope](Set-AdaptiveScope.md) + +### [Set-AppRetentionCompliancePolicy](Set-AppRetentionCompliancePolicy.md) + +### [Set-AppRetentionComplianceRule](Set-AppRetentionComplianceRule.md) + ### [Set-ComplianceRetentionEventType](Set-ComplianceRetentionEventType.md) ### [Set-ComplianceTag](Set-ComplianceTag.md) @@ -2158,13 +2318,23 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Validate-RetentionRuleQuery](Validate-RetentionRuleQuery.md) -## powershell-v2-module Cmdlets +## powershell-v3-module Cmdlets +### [Add-VivaModuleFeaturePolicy](Add-VivaModuleFeaturePolicy.md) + +### [Add-VivaOrgInsightsDelegatedRole](Add-VivaOrgInsightsDelegatedRole.md) + ### [Connect-ExchangeOnline](Connect-ExchangeOnline.md) ### [Connect-IPPSSession](Connect-IPPSSession.md) ### [Disconnect-ExchangeOnline](Disconnect-ExchangeOnline.md) +### [Get-ConnectionInformation](Get-ConnectionInformation.md) + +### [Get-DefaultTenantBriefingConfig](Get-DefaultTenantBriefingConfig.md) + +### [Get-DefaultTenantMyAnalyticsFeatureConfig](Get-DefaultTenantMyAnalyticsFeatureConfig.md) + ### [Get-EXOCasMailbox](Get-EXOCasMailbox.md) ### [Get-EXOMailbox](Get-EXOMailbox.md) @@ -2189,62 +2359,42 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-VivaInsightsSettings](Get-VivaInsightsSettings.md) -### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) - -### [Set-UserBriefingConfig](Set-UserBriefingConfig.md) - -### [Set-VivaInsightsSettings](Set-VivaInsightsSettings.md) - -## reporting Cmdlets -### [Get-CompromisedUserAggregateReport](Get-CompromisedUserAggregateReport.md) - -### [Get-CompromisedUserDetailReport](Get-CompromisedUserDetailReport.md) - -### [Get-ConnectionByClientTypeDetailReport](Get-ConnectionByClientTypeDetailReport.md) +### [Get-VivaModuleFeature](Get-VivaModuleFeature.md) -### [Get-ConnectionByClientTypeReport](Get-ConnectionByClientTypeReport.md) +### [Get-VivaModuleFeatureEnablement](Get-VivaModuleFeatureEnablement.md) -### [Get-CsActiveUserReport](Get-CsActiveUserReport.md) +### [Get-VivaModuleFeaturePolicy](Get-VivaModuleFeaturePolicy.md) -### [Get-CsAVConferenceTimeReport](Get-CsAVConferenceTimeReport.md) +### [Get-VivaOrgInsightsDelegatedRole](Get-VivaOrgInsightsDelegatedRole.md) -### [Get-CsClientDeviceDetailReport](Get-CsClientDeviceDetailReport.md) +### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md) -### [Get-CsClientDeviceReport](Get-CsClientDeviceReport.md) +### [Remove-VivaOrgInsightsDelegatedRole](Remove-VivaOrgInsightsDelegatedRole.md) -### [Get-CsConferenceReport](Get-CsConferenceReport.md) +### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md) -### [Get-CsP2PAVTimeReport](Get-CsP2PAVTimeReport.md) +### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md) -### [Get-CsP2PSessionReport](Get-CsP2PSessionReport.md) +### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md) -### [Get-CsPSTNConferenceTimeReport](Get-CsPSTNConferenceTimeReport.md) +### [Set-UserBriefingConfig](Set-UserBriefingConfig.md) -### [Get-CsPSTNUsageDetailReport](Get-CsPSTNUsageDetailReport.md) +### [Set-VivaInsightsSettings](Set-VivaInsightsSettings.md) -### [Get-CsUserActivitiesReport](Get-CsUserActivitiesReport.md) +### [Update-VivaModuleFeaturePolicy](Update-VivaModuleFeaturePolicy.md) -### [Get-CsUsersBlockedReport](Get-CsUsersBlockedReport.md) +## reporting Cmdlets +### [Get-CompromisedUserAggregateReport](Get-CompromisedUserAggregateReport.md) -### [Get-GroupActivityReport](Get-GroupActivityReport.md) +### [Get-CompromisedUserDetailReport](Get-CompromisedUserDetailReport.md) ### [Get-HistoricalSearch](Get-HistoricalSearch.md) -### [Get-LicenseVsUsageSummaryReport](Get-LicenseVsUsageSummaryReport.md) - ### [Get-LogonStatistics](Get-LogonStatistics.md) -### [Get-MailboxActivityReport](Get-MailboxActivityReport.md) - -### [Get-MailboxUsageDetailReport](Get-MailboxUsageDetailReport.md) - -### [Get-MailboxUsageReport](Get-MailboxUsageReport.md) - ### [Get-MailDetailDlpPolicyReport](Get-MailDetailDlpPolicyReport.md) -### [Get-MailDetailMalwareReport](Get-MailDetailMalwareReport.md) - -### [Get-MailDetailSpamReport](Get-MailDetailSpamReport.md) +### [Get-MailDetailEncryptionReport](Get-MailDetailEncryptionReport.md) ### [Get-MailDetailTransportRuleReport](Get-MailDetailTransportRuleReport.md) @@ -2252,24 +2402,14 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-MailflowStatusReport](Get-MailflowStatusReport.md) -### [Get-MailTrafficPolicyReport](Get-MailTrafficPolicyReport.md) +### [Get-MailTrafficEncryptionReport](Get-MailTrafficEncryptionReport.md) -### [Get-MailTrafficReport](Get-MailTrafficReport.md) +### [Get-MailTrafficPolicyReport](Get-MailTrafficPolicyReport.md) ### [Get-MailTrafficSummaryReport](Get-MailTrafficSummaryReport.md) -### [Get-MailTrafficTopReport](Get-MailTrafficTopReport.md) - ### [Get-MxRecordReport](Get-MxRecordReport.md) -### [Get-O365ClientBrowserDetailReport](Get-O365ClientBrowserDetailReport.md) - -### [Get-O365ClientBrowserReport](Get-O365ClientBrowserReport.md) - -### [Get-O365ClientOSDetailReport](Get-O365ClientOSDetailReport.md) - -### [Get-O365ClientOSReport](Get-O365ClientOSReport.md) - ### [Get-OutboundConnectorReport](Get-OutboundConnectorReport.md) ### [Get-RecipientStatisticsReport](Get-RecipientStatisticsReport.md) @@ -2280,22 +2420,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-ServiceDeliveryReport](Get-ServiceDeliveryReport.md) -### [Get-SPOActiveUserReport](Get-SPOActiveUserReport.md) - -### [Get-SPOSkyDriveProDeployedReport](Get-SPOSkyDriveProDeployedReport.md) - -### [Get-SPOSkyDriveProStorageReport](Get-SPOSkyDriveProStorageReport.md) - -### [Get-SPOTeamSiteDeployedReport](Get-SPOTeamSiteDeployedReport.md) - -### [Get-SPOTeamSiteStorageReport](Get-SPOTeamSiteStorageReport.md) - -### [Get-SPOTenantStorageMetricReport](Get-SPOTenantStorageMetricReport.md) - -### [Get-StaleMailboxDetailReport](Get-StaleMailboxDetailReport.md) - -### [Get-StaleMailboxReport](Get-StaleMailboxReport.md) - ### [Get-SupervisoryReviewActivity](Get-SupervisoryReviewActivity.md) ### [Get-SupervisoryReviewOverallProgressReport](Get-SupervisoryReviewOverallProgressReport.md) @@ -2306,13 +2430,7 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Get-SupervisoryReviewTopCasesReport](Get-SupervisoryReviewTopCasesReport.md) -### [Get-TenantAnalyticsConfig](Get-TenantAnalyticsConfig.md) - -### [Get-UserAnalyticsConfig](Get-UserAnalyticsConfig.md) - -### [Set-TenantAnalyticsConfig](Set-TenantAnalyticsConfig.md) - -### [Set-UserAnalyticsConfig](Set-UserAnalyticsConfig.md) +### [Test-Message](Test-Message.md] ## role-based-access-control Cmdlets ### [Add-ManagementRoleEntry](Add-ManagementRoleEntry.md) @@ -2691,10 +2809,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [New-DynamicDistributionGroup](New-DynamicDistributionGroup.md) -### [New-EOPDistributionGroup](New-EOPDistributionGroup.md) - -### [New-EOPMailUser](New-EOPMailUser.md) - ### [New-MailContact](New-MailContact.md) ### [New-MailUser](New-MailUser.md) @@ -2707,10 +2821,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Remove-DynamicDistributionGroup](Remove-DynamicDistributionGroup.md) -### [Remove-EOPDistributionGroup](Remove-EOPDistributionGroup.md) - -### [Remove-EOPMailUser](Remove-EOPMailUser.md) - ### [Remove-MailContact](Remove-MailContact.md) ### [Remove-MailUser](Remove-MailUser.md) @@ -2725,14 +2835,6 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Set-DynamicDistributionGroup](Set-DynamicDistributionGroup.md) -### [Set-EOPDistributionGroup](Set-EOPDistributionGroup.md) - -### [Set-EOPGroup](Set-EOPGroup.md) - -### [Set-EOPMailUser](Set-EOPMailUser.md) - -### [Set-EOPUser](Set-EOPUser.md) - ### [Set-Group](Set-Group.md) ### [Set-LinkedUser](Set-LinkedUser.md) @@ -2749,6 +2851,4 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow ### [Update-DistributionGroupMember](Update-DistributionGroupMember.md) -### [Update-EOPDistributionGroupMember](Update-EOPDistributionGroupMember.md) - ### [Upgrade-DistributionGroup](Upgrade-DistributionGroup.md) diff --git a/exchange/exchange-ps/exchange/set-CASMailboxPlan.md b/exchange/exchange-ps/exchange/set-CASMailboxPlan.md deleted file mode 100644 index 397fca859f..0000000000 --- a/exchange/exchange-ps/exchange/set-CASMailboxPlan.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: Microsoft.Exchange.ServerStatus-Help.xml -online version: https://docs.microsoft.com/powershell/module/exchange/set-casmailboxplan -applicable: Exchange Online, Exchange Online Protection -title: Set-CASMailboxPlan -schema: 2.0.0 -author: chrisda -ms.author: chrisda -ms.reviewer: ---- - -# Set-CASMailboxPlan - -## SYNOPSIS -This cmdlet is available only in the cloud-based service. - -Use the Set-CASMailboxPlan cmdlet to modify Client Access services (CAS) mailbox plans in cloud-based organizations. - -**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell). - -For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). - -## SYNTAX - -``` -Set-CASMailboxPlan [-Identity] - [-ActiveSyncEnabled ] - [-Confirm] - [-ImapEnabled ] - [-OwaMailboxPolicy ] - [-PopEnabled ] - [-WhatIf] - [] -``` - -## DESCRIPTION -A CAS mailbox plan is tied to the corresponding mailbox plan that has the same name (and display name). Like mailbox plans, CAS mailbox plans correspond to license types, and are applied to a mailbox when you license the user. The availability of a CAS mailbox plan is determined by your selections when you enroll in the service and the age of your organization. - -You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). - -## EXAMPLES - -### Example 1 -```powershell -Set-CASMailboxPlan -Identity ExchangeOnlineEnterprise -ActiveSyncEnabled $false -PopEnabled $false -``` - -This example disables Exchange ActiveSync and POP3 access to mailboxes in the CAS mailbox plan named ExchangeOnlineEnterprise. - -## PARAMETERS - -### -Identity -The Identity parameter specifies the CAS mailbox plan that you want to modify. You can use any value that uniquely identifies the CAS mailbox plan. For example: - -- Name -- Distinguished name (DN) -- GUID - -The display name and name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, `ExchangeOnlineEnterprise` and `ExchangeOnlineEnterprise-`, respectively). - -```yaml -Type: MailboxPlanIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -ActiveSyncEnabled -The ActiveSyncEnabled parameter enables or disables access to the mailbox by using Exchange Active Sync (EAS). Valid values are: - -- $true: ActiveSync access to the mailbox is enabled. This is the default value. -- $false: ActiveSync access to the mailbox is disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -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`. -- 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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImapEnabled -The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients. Valid values are: - -- $true: IMAP4 access to the mailbox is enabled. This is default value for all CAS mailbox plans except ExchangeOnlineDeskless. -- $false: IMAP4 access to the mailbox is disabled. This is default value for ExchangeOnlineDeskless. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwaMailboxPolicy -The OwaMailboxPolicy parameter specifies the Outlook on the web (formerly known as Outlook Web App) mailbox policy for the mailbox. You can use any value that uniquely identifies the policy. For example: - -- Name -- Distinguished name (DN) -- GUID - -The default value is OwaMailboxPolicy-Default. - -You can use the Get-OwaMailboxPolicy cmdlet to view the available Outlook on the web mailbox policies. - -```yaml -Type: MailboxPolicyIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PopEnabled -The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients. Valid values are: - -- $true: POP3 access to the mailbox is enabled. This is the default value. -- $false: POP3 access to the mailbox is disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Exchange Online, Exchange Online Protection - -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Exchange Online, Exchange Online Protection - -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 - -### - -## OUTPUTS - -### - -## NOTES - -## RELATED LINKS diff --git a/exchange/mapping/MAML2Yaml/monikerMapping.json b/exchange/mapping/MAML2Yaml/monikerMapping.json new file mode 100644 index 0000000000..4e2ae5eca8 --- /dev/null +++ b/exchange/mapping/MAML2Yaml/monikerMapping.json @@ -0,0 +1,12 @@ +{ + "exchange-ps": { + "conceptualToc": "docs-conceptual/toc.yml", + "conceptualTocUrl": "/powershell/exchange/exchange-ps/toc.json", + "referenceTocUrl": "/powershell/module/exchange-ps/toc.json", + "packageRoot": "exchange-ps", + "serviceMap": "mapping/serviceMapping.json", + "modules": { + "exchange": {} + } + } +} \ No newline at end of file diff --git a/exchange/mapping/monikerMapping.json b/exchange/mapping/monikerMapping.json deleted file mode 100644 index 68fde33989..0000000000 --- a/exchange/mapping/monikerMapping.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "exchange-ps": { - "conceptualToc": "docs-conceptual/toc.yml", - "conceptualTocUrl": "/powershell/exchange/exchange-ps/toc.json", - "referenceTocUrl": "/powershell/module/exchange-ps/toc.json", - "packageRoot": "exchange-ps", - "serviceMap": "mapping/serviceMapping.json", - "modules": { - "exchange": {} - } - } -} \ No newline at end of file diff --git a/exchange/mapping/serviceMapping.json b/exchange/mapping/serviceMapping.json index 011774c32a..b6691a949e 100644 --- a/exchange/mapping/serviceMapping.json +++ b/exchange/mapping/serviceMapping.json @@ -15,45 +15,53 @@ "Set-ADSite": "active-directory", "Set-AdSiteLink": "active-directory", "Disable-AntiPhishRule": "defender-for-office-365", + "Disable-ATPProtectionPolicyRule": "defender-for-office-365", "Disable-SafeAttachmentRule": "defender-for-office-365", "Disable-SafeLinksRule": "defender-for-office-365", "Enable-AntiPhishRule": "defender-for-office-365", + "Enable-ATPProtectionPolicyRule": "defender-for-office-365", "Enable-SafeAttachmentRule": "defender-for-office-365", "Enable-SafeLinksRule": "defender-for-office-365", - "Get-AdvancedThreatProtectionDocumentDetail": "defender-for-office-365", - "Get-AdvancedThreatProtectionDocumentReport": "defender-for-office-365", - "Get-AdvancedThreatProtectionTrafficReport": "defender-for-office-365", "Get-AntiPhishPolicy": "defender-for-office-365", "Get-AntiPhishRule": "defender-for-office-365", + "Get-ATPBuiltInProtectionRule": "defender-for-office-365", "Get-AtpPolicyForO365": "defender-for-office-365", + "Get-ATPProtectionPolicyRule": "defender-for-office-365", "Get-ATPTotalTrafficReport": "defender-for-office-365", + "Get-ContentMalwareMdoAggregateReport": "defender-for-office-365", + "Get-ContentMalwareMdoDetailReport": "defender-for-office-365", + "Get-EmailTenantSettings": "defender-for-office-365", "Get-MailDetailATPReport": "defender-for-office-365", "Get-MailTrafficATPReport": "defender-for-office-365", - "Get-PhishFilterPolicy": "defender-for-office-365", "Get-SafeAttachmentPolicy": "defender-for-office-365", "Get-SafeAttachmentRule": "defender-for-office-365", "Get-SafeLinksAggregateReport": "defender-for-office-365", - "Get-SafeLinksDetailRepor": "defender-for-office-365", + "Get-SafeLinksDetailReport": "defender-for-office-365", "Get-SafeLinksPolicy": "defender-for-office-365", "Get-SafeLinksRule": "defender-for-office-365", + "Get-SpoofIntelligenceInsight": "defender-for-office-365", "Get-SpoofMailReport": "defender-for-office-365", - "Get-UrlTrace": "defender-for-office-365", "New-AntiPhishPolicy": "defender-for-office-365", "New-AntiPhishRule": "defender-for-office-365", + "New-ATPBuiltInProtectionRule": "defender-for-office-365", + "New-ATPProtectionPolicyRule": "defender-for-office-365", "New-SafeAttachmentPolicy": "defender-for-office-365", "New-SafeAttachmentRule": "defender-for-office-365", "New-SafeLinksPolicy": "defender-for-office-365", "New-SafeLinksRule": "defender-for-office-365", "Remove-AntiPhishPolicy": "defender-for-office-365", "Remove-AntiPhishRule": "defender-for-office-365", + "Remove-ATPProtectionPolicyRule": "defender-for-office-365", "Remove-SafeAttachmentPolicy": "defender-for-office-365", "Remove-SafeAttachmentRule": "defender-for-office-365", "Remove-SafeLinksPolicy": "defender-for-office-365", "Remove-SafeLinksRule": "defender-for-office-365", "Set-AntiPhishPolicy": "defender-for-office-365", "Set-AntiPhishRule": "defender-for-office-365", + "Set-ATPBuiltInProtectionRule": "defender-for-office-365", "Set-AtpPolicyForO365": "defender-for-office-365", - "Set-PhishFilterPolicy": "defender-for-office-365", + "Set-ATPProtectionPolicyRule": "defender-for-office-365", + "Set-EmailTenantSettings": "defender-for-office-365", "Set-SafeAttachmentPolicy": "defender-for-office-365", "Set-SafeAttachmentRule": "defender-for-office-365", "Set-SafeLinksPolicy": "defender-for-office-365", @@ -65,21 +73,34 @@ "Add-IPBlockListEntry": "antispam-antimalware", "Add-IPBlockListProvider": "antispam-antimalware", "Delete-QuarantineMessage": "antispam-antimalware", + "Disable-EOPProtectionPolicyRule": "antispam-antimalware", "Disable-HostedContentFilterRule": "antispam-antimalware", "Disable-HostedOutboundSpamFilterRule": "antispam-antimalware", "Disable-MalwareFilterRule": "antispam-antimalware", + "Disable-ReportSubmissionRule": "antispam-antimalware", "Enable-AntispamUpdates": "antispam-antimalware", + "Enable-EOPProtectionPolicyRule": "antispam-antimalware", "Enable-HostedContentFilterRule": "antispam-antimalware", "Enable-HostedOutboundSpamFilterRule": "antispam-antimalware", "Enable-MalwareFilterRule": "antispam-antimalware", "Export-QuarantineMessage": "antispam-antimalware", + "Enable-ReportSubmissionRule": "antispam-antimalware", "Get-AgentLog": "antispam-antimalware", + "Get-AggregateZapReport": "antispam-antimalware", + "Get-ArcConfig": "antispam-antimalware", "Get-AttachmentFilterEntry": "antispam-antimalware", "Get-AttachmentFilterListConfig": "antispam-antimalware", + "Get-BlockedConnector": "antispam-antimalware", "Get-BlockedSenderAddress": "antispam-antimalware", + "Get-ConfigAnalyzerPolicyRecommendation": "antispam-antimalware", "Get-ContentFilterConfig": "antispam-antimalware", "Get-ContentFilterPhrase": "antispam-antimalware", + "Get-CustomizedUserSubmission": "antispam-antimalware", + "Get-DetailZapReport": "antispam-antimalware", "Get-DkimSigningConfig": "antispam-antimalware", + "Get-EOPProtectionPolicyRule": "antispam-antimalware", + "Get-ExoPhishSimOverrideRule": "antispam-antimalware", + "Get-ExoSecOpsOverrideRule": "antispam-antimalware", "Get-HostedConnectionFilterPolicy": "antispam-antimalware", "Get-HostedContentFilterPolicy": "antispam-antimalware", "Get-HostedContentFilterRule": "antispam-antimalware", @@ -98,17 +119,24 @@ "Get-MalwareFilterPolicy": "antispam-antimalware", "Get-MalwareFilterRule": "antispam-antimalware", "Get-PhishSimOverridePolicy": "antispam-antimalware", - "Get-PhishSimOverrideRule": "antispam-antimalware", "Get-QuarantineMessage": "antispam-antimalware", "Get-QuarantineMessageHeader": "antispam-antimalware", + "Get-QuarantinePolicy": "antispam-antimalware", "Get-RecipientFilterConfig": "antispam-antimalware", + "Get-ReportSubmissionPolicy": "antispam-antimalware", + "Get-ReportSubmissionRule": "antispam-antimalware", "Get-SecOpsOverridePolicy": "antispam-antimalware", - "Get-SecOpsOverrideRule": "antispam-antimalware", "Get-SenderFilterConfig": "antispam-antimalware", "Get-SenderIdConfig": "antispam-antimalware", "Get-SenderReputationConfig": "antispam-antimalware", + "Get-TeamsProtectionPolicy": "antispam-antimalware", + "Get-TeamsProtectionPolicyRule": "antispam-antimalware", "Get-TenantAllowBlockListItems": "antispam-antimalware", + "Get-TenantAllowBlockListSpoofItems": "antispam-antimalware", "New-DkimSigningConfig": "antispam-antimalware", + "New-EOPProtectionPolicyRule": "antispam-antimalware", + "New-ExoPhishSimOverrideRule": "antispam-antimalware", + "New-ExoSecOpsOverrideRule": "antispam-antimalware", "New-HostedContentFilterPolicy": "antispam-antimalware", "New-HostedContentFilterRule": "antispam-antimalware", "New-HostedOutboundSpamFilterPolicy": "antispam-antimalware", @@ -116,15 +144,24 @@ "New-MalwareFilterPolicy": "antispam-antimalware", "New-MalwareFilterRule": "antispam-antimalware", "New-PhishSimOverridePolicy": "antispam-antimalware", - "New-PhishSimOverrideRule": "antispam-antimalware", + "New-QuarantinePermissions": "antispam-antimalware", + "New-QuarantinePolicy": "antispam-antimalware", + "New-ReportSubmissionPolicy": "antispam-antimalware", + "New-ReportSubmissionRule": "antispam-antimalware", "New-SecOpsOverridePolicy": "antispam-antimalware", - "New-SecOpsOverrideRule": "antispam-antimalware", + "New-TeamsProtectionPolicy": "antispam-antimalware", + "New-TeamsProtectionPolicyRule": "antispam-antimalware", "New-TenantAllowBlockListItems": "antispam-antimalware", + "New-TenantAllowBlockListSpoofItems": "antispam-antimalware", "Preview-QuarantineMessage": "antispam-antimalware", "Release-QuarantineMessage": "antispam-antimalware", "Remove-AttachmentFilterEntry": "antispam-antimalware", + "Remove-BlockedConnector": "antispam-antimalware", "Remove-BlockedSenderAddress": "antispam-antimalware", "Remove-ContentFilterPhrase": "antispam-antimalware", + "Remove-EOPProtectionPolicyRule": "antispam-antimalware", + "Remove-ExoPhishSimOverrideRule": "antispam-antimalware", + "Remove-ExoSecOpsOverrideRule": "antispam-antimalware", "Remove-HostedContentFilterPolicy": "antispam-antimalware", "Remove-HostedContentFilterRule": "antispam-antimalware", "Remove-HostedOutboundSpamFilterPolicy": "antispam-antimalware", @@ -136,14 +173,20 @@ "Remove-MalwareFilterPolicy": "antispam-antimalware", "Remove-MalwareFilterRule": "antispam-antimalware", "Remove-PhishSimOverridePolicy": "antispam-antimalware", - "Remove-PhishSimOverrideRule": "antispam-antimalware", + "Remove-QuarantinePolicy": "antispam-antimalware", + "Remove-ReportSubmissionPolicy": "antispam-antimalware", + "Remove-ReportSubmissionRule": "antispam-antimalware", "Remove-SecOpsOverridePolicy": "antispam-antimalware", - "Remove-SecOpsOverrideRule": "antispam-antimalware", "Remove-TenantAllowBlockListItems": "antispam-antimalware", + "Remove-TenantAllowBlockListSpoofItems": "antispam-antimalware", "Rotate-DkimSigningConfig": "antispam-antimalware", + "Set-ArcConfig": "antispam-antimalware", "Set-AttachmentFilterListConfig": "antispam-antimalware", "Set-ContentFilterConfig": "antispam-antimalware", "Set-DkimSigningConfig": "antispam-antimalware", + "Set-EOPProtectionPolicyRule": "antispam-antimalware", + "Set-ExoPhishSimOverrideRule": "antispam-antimalware", + "Set-ExoSecOpsOverrideRule": "antispam-antimalware", "Set-HostedConnectionFilterPolicy": "antispam-antimalware", "Set-HostedContentFilterPolicy": "antispam-antimalware", "Set-HostedContentFilterRule": "antispam-antimalware", @@ -160,14 +203,19 @@ "Set-MalwareFilterPolicy": "antispam-antimalware", "Set-MalwareFilterRule": "antispam-antimalware", "Set-PhishSimOverridePolicy": "antispam-antimalware", - "Set-PhishSimOverrideRule": "antispam-antimalware", + "Set-QuarantinePermissions": "antispam-antimalware", + "Set-QuarantinePolicy": "antispam-antimalware", "Set-RecipientFilterConfig": "antispam-antimalware", + "Set-ReportSubmissionPolicy": "antispam-antimalware", + "Set-ReportSubmissionRule": "antispam-antimalware", "Set-SecOpsOverridePolicy": "antispam-antimalware", - "Set-SecOpsOverrideRule": "antispam-antimalware", "Set-SenderFilterConfig": "antispam-antimalware", "Set-SenderIdConfig": "antispam-antimalware", "Set-SenderReputationConfig": "antispam-antimalware", + "Set-TeamsProtectionPolicy": "antispam-antimalware", + "Set-TeamsProtectionPolicyRule": "antispam-antimalware", "Set-TenantAllowBlockListItems": "antispam-antimalware", + "Set-TenantAllowBlockListSpoofItems": "antispam-antimalware", "Test-IPAllowListProvider": "antispam-antimalware", "Test-IPBlockListProvider": "antispam-antimalware", "Test-SenderId": "antispam-antimalware", @@ -197,7 +245,7 @@ "Remove-OwaMailboxPolicy": "client-access", "Send-TextMessagingVerificationCode": "client-access", "Set-CASMailbox": "client-access", - "set-CASMailboxPlan": "client-access", + "Set-CASMailboxPlan": "client-access", "Set-ClientAccessRule": "client-access", "Set-ImapSettings": "client-access", "Set-MailboxCalendarConfiguration": "client-access", @@ -383,28 +431,27 @@ "Get-IRMConfiguration": "encryption-and-certificates", "Get-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", "Get-M365DataAtRestEncryptionPolicyAssignment": "encryption-and-certificates", + "Get-MailboxIRMAccess": "encryption-and-certificates", "Get-OMEConfiguration": "encryption-and-certificates", "Get-OMEMessageStatus": "encryption-and-certificates", "Get-RMSTemplate": "encryption-and-certificates", - "Get-RMSTrustedPublishingDomain": "encryption-and-certificates", "Get-SmimeConfig": "encryption-and-certificates", "Import-ExchangeCertificate": "encryption-and-certificates", - "Import-RMSTrustedPublishingDomain": "encryption-and-certificates", "New-DataEncryptionPolicy": "encryption-and-certificates", "New-ExchangeCertificate": "encryption-and-certificates", "New-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", "New-OMEConfiguration": "encryption-and-certificates", "Remove-ExchangeCertificate": "encryption-and-certificates", + "Remove-MailboxIRMAccess": "encryption-and-certificates", "Remove-OMEConfiguration": "encryption-and-certificates", - "Remove-RMSTrustedPublishingDomain": "encryption-and-certificates", "Set-DataEncryptionPolicy": "encryption-and-certificates", "Set-IRMConfiguration": "encryption-and-certificates", "Set-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", "Set-M365DataAtRestEncryptionPolicyAssignment": "encryption-and-certificates", + "Set-MailboxIRMAccess": "encryption-and-certificates", "Set-OMEConfiguration": "encryption-and-certificates", "Set-OMEMessageRevocation": "encryption-and-certificates", "Set-RMSTemplate": "encryption-and-certificates", - "Set-RMSTrustedPublishingDomain": "encryption-and-certificates", "Set-SmimeConfig": "encryption-and-certificates", "Test-IRMConfiguration": "encryption-and-certificates", "Test-M365DataAtRestEncryptionPolicy": "encryption-and-certificates", @@ -416,7 +463,6 @@ "Get-FederationInformation": "federation-and-hybrid", "Get-FederationTrust": "federation-and-hybrid", "Get-HybridConfiguration": "federation-and-hybrid", - "Get-HybridMailflow": "federation-and-hybrid", "Get-HybridMailflowDatacenterIPs": "federation-and-hybrid", "Get-IntraOrganizationConfiguration": "federation-and-hybrid", "Get-IntraOrganizationConnector": "federation-and-hybrid", @@ -437,7 +483,6 @@ "Set-FederatedOrganizationIdentifier": "federation-and-hybrid", "Set-FederationTrust": "federation-and-hybrid", "Set-HybridConfiguration": "federation-and-hybrid", - "Set-HybridMailflow": "federation-and-hybrid", "Set-IntraOrganizationConnector": "federation-and-hybrid", "Set-OnPremisesOrganization": "federation-and-hybrid", "Set-PendingFederatedDomain": "federation-and-hybrid", @@ -470,6 +515,7 @@ "Set-MailboxDatabase": "mailbox-databases-and-servers", "Set-MailboxServer": "mailbox-databases-and-servers", "Set-SearchDocumentFormat": "mailbox-databases-and-servers", + "Start-MailboxAssistant": "mailbox-databases-and-servers", "Test-AssistantHealth": "mailbox-databases-and-servers", "Test-ExchangeSearch": "mailbox-databases-and-servers", "Test-MRSHealth": "mailbox-databases-and-servers", @@ -490,6 +536,7 @@ "Enable-Mailbox": "mailboxes", "Enable-ServiceEmailChannel": "mailboxes", "Enable-SweepRule": "mailboxes", + "Expedite-Delicensing": "mailboxes", "Export-MailboxDiagnosticLogs": "mailboxes", "Export-RecipientDataProperty": "mailboxes", "Get-App": "mailboxes", @@ -522,13 +569,13 @@ "Get-MailboxStatistics": "mailboxes", "Get-MailboxUserConfiguration": "mailboxes", "Get-MessageCategory": "mailboxes", + "Get-PendingDelicenseUser": "mailboxes", "Get-Place": "mailboxes", "Get-RecipientPermission": "mailboxes", "Get-RecoverableItems": "mailboxes", "Get-ResourceConfig": "mailboxes", "Get-SweepRule": "mailboxes", "Get-UserPhoto": "mailboxes", - "Import-ContactList": "mailboxes", "Import-RecipientDataProperty": "mailboxes", "New-App": "mailboxes", "New-InboxRule": "mailboxes", @@ -586,17 +633,25 @@ "Test-MAPIConnectivity": "mailboxes", "Undo-SoftDeletedMailbox": "mailboxes", "Add-ResubmitRequest": "mail-flow", + "Disable-DnssecForVerifiedDomain": "mail-flow", + "Disable-IPv6ForAcceptedDomain": "mail-flow", + "Disable-SmtpDaneInbound": "mail-flow", "Disable-TransportAgent": "mail-flow", + "Enable-DnssecForVerifiedDomain": "mail-flow", + "Enable-IPv6ForAcceptedDomain": "mail-flow", + "Enable-SmtpDaneInbound": "mail-flow", "Enable-TransportAgent": "mail-flow", "Export-Message": "mail-flow", "Get-AcceptedDomain": "mail-flow", "Get-AddressRewriteEntry": "mail-flow", "Get-DeliveryAgentConnector": "mail-flow", + "Get-DnssecStatusForVerifiedDomain": "mail-flow", "Get-EdgeSubscription": "mail-flow", "Get-EdgeSyncServiceConfig": "mail-flow", "Get-ForeignConnector": "mail-flow", "Get-FrontendTransportService": "mail-flow", "Get-InboundConnector": "mail-flow", + "Get-IPv6StatusForAcceptedDomain": "mail-flow", "Get-MailboxTransportService": "mail-flow", "Get-Message": "mail-flow", "Get-MessageTrace": "mail-flow", @@ -612,6 +667,7 @@ "Get-ResubmitRequest": "mail-flow", "Get-RoutingGroupConnector": "mail-flow", "Get-SendConnector": "mail-flow", + "Get-SmtpDaneInboundStatus": "mail-flow", "Get-SystemMessage": "mail-flow", "Get-TransportAgent": "mail-flow", "Get-TransportConfig": "mail-flow", @@ -742,25 +798,32 @@ "Get-CmdletExtensionAgent": "organization", "Get-ExchangeAssistanceConfig": "organization", "Get-ExchangeDiagnosticInfo": "organization", + "Get-ExchangeFeature": "organization", "Get-ExchangeServer": "organization", "Get-ExchangeServerAccessLicense": "organization", "Get-ExchangeServerAccessLicenseUser": "organization", "Get-ExchangeSettings": "organization", + "Get-FeatureConfiguration": "organization", "Get-Notification": "organization", "Get-OrganizationConfig": "organization", "Get-PartnerApplication": "organization", "Get-PerimeterConfig": "organization", + "Get-ServicePrincipal": "organization", "Get-SettingOverride": "organization", "New-ApplicationAccessPolicy": "organization", "New-AuthenticationPolicy": "organization", "New-AuthServer": "organization", "New-ExchangeSettings": "organization", + "New-FeatureConfiguration": "organization", "New-PartnerApplication": "organization", + "New-ServicePrincipal": "organization", "New-SettingOverride": "organization", "Remove-ApplicationAccessPolicy": "organization", "Remove-AuthenticationPolicy": "organization", "Remove-AuthServer": "organization", + "Remove-FeatureConfiguration": "organization", "Remove-PartnerApplication": "organization", + "Remove-ServicePrincipal": "organization", "Remove-SettingOverride": "organization", "Set-AccessToCustomerDataRequest": "organization", "Set-ApplicationAccessPolicy": "organization", @@ -769,15 +832,19 @@ "Set-AuthServer": "organization", "Set-CmdletExtensionAgent": "organization", "Set-ExchangeAssistanceConfig": "organization", + "Set-ExchangeFeature": "organization", "Set-ExchangeServer": "organization", "Set-ExchangeSettings": "organization", + "Set-FeatureConfiguration": "organization", "Set-Notification": "organization", "Set-OrganizationConfig": "organization", "Set-PartnerApplication": "organization", "Set-PerimeterConfig": "organization", + "Set-ServicePrincipal": "organization", "Set-SettingOverride": "organization", "Test-ApplicationAccessPolicy": "organization", "Test-OAuthConnectivity": "organization", + "Test-ServicePrincipalAuthorization": "organization", "Test-SystemHealth": "organization", "Update-ExchangeHelp": "organization", "Disable-JournalArchiving": "policy-and-compliance", @@ -790,10 +857,13 @@ "Execute-AzureADLabelSync": "policy-and-compliance", "Export-JournalRuleCollection": "policy-and-compliance", "Export-TransportRuleCollection": "policy-and-compliance", - "Get-ActivityAlert": "policy-and-compliance", "Get-AdministrativeUnit": "policy-and-compliance", "Get-AutoSensitivityLabelPolicy": "policy-and-compliance", "Get-AutoSensitivityLabelRule": "policy-and-compliance", + "Get-EtrLimits": "policy-and-compliance", + "Get-ExoInformationBarrierPolicy": "policy-and-compliance", + "Get-ExoInformationBarrierRelationship": "policy-and-compliance", + "Get-ExoInformationBarrierSegment": "policy-and-compliance", "Get-InformationBarrierPoliciesApplicationStatus": "policy-and-compliance", "Get-InformationBarrierPolicy": "policy-and-compliance", "Get-InformationBarrierRecipientStatus": "policy-and-compliance", @@ -804,6 +874,7 @@ "Get-OrganizationSegment": "policy-and-compliance", "Get-OutlookProtectionRule": "policy-and-compliance", "Get-ProtectionAlert": "policy-and-compliance", + "Get-ReviewItems": "policy-and-compliance", "Get-SupervisoryReviewPolicyV2": "policy-and-compliance", "Get-SupervisoryReviewRule": "policy-and-compliance", "Get-TransportRule": "policy-and-compliance", @@ -812,7 +883,7 @@ "Import-JournalRuleCollection": "policy-and-compliance", "Import-TransportRuleCollection": "policy-and-compliance", "Install-UnifiedCompliancePrerequisite": "policy-and-compliance", - "New-ActivityAlert": "policy-and-compliance", + "Invoke-ComplianceSecurityFilterAction": "policy-and-compliance", "New-AutoSensitivityLabelPolicy": "policy-and-compliance", "New-AutoSensitivityLabelRule": "policy-and-compliance", "New-InformationBarrierPolicy": "policy-and-compliance", @@ -826,7 +897,6 @@ "New-SupervisoryReviewPolicyV2": "policy-and-compliance", "New-SupervisoryReviewRule": "policy-and-compliance", "New-TransportRule": "policy-and-compliance", - "Remove-ActivityAlert": "policy-and-compliance", "Remove-AutoSensitivityLabelPolicy": "policy-and-compliance", "Remove-AutoSensitivityLabelRule": "policy-and-compliance", "Remove-InformationBarrierPolicy": "policy-and-compliance", @@ -837,10 +907,8 @@ "Remove-OrganizationSegment": "policy-and-compliance", "Remove-OutlookProtectionRule": "policy-and-compliance", "Remove-ProtectionAlert": "policy-and-compliance", - "Remove-RecordLabel": "policy-and-compliance", "Remove-SupervisoryReviewPolicyV2": "policy-and-compliance", "Remove-TransportRule": "policy-and-compliance", - "Set-ActivityAlert": "policy-and-compliance", "Set-AutoSensitivityLabelPolicy": "policy-and-compliance", "Set-AutoSensitivityLabelRule": "policy-and-compliance", "Set-InformationBarrierPolicy": "policy-and-compliance", @@ -859,25 +927,18 @@ "Test-ArchiveConnectivity": "policy-and-compliance", "Get-AdminAuditLogConfig": "policy-and-compliance-audit", "Get-AuditConfig": "policy-and-compliance-audit", - "Get-AuditConfigurationPolicy": "policy-and-compliance-audit", - "Get-AuditConfigurationRule": "policy-and-compliance-audit", "Get-AuditLogSearch": "policy-and-compliance-audit", "Get-MailboxAuditBypassAssociation": "policy-and-compliance-audit", "Get-UnifiedAuditLogRetentionPolicy": "policy-and-compliance-audit", "New-AdminAuditLogSearch": "policy-and-compliance-audit", - "New-AuditConfigurationPolicy": "policy-and-compliance-audit", - "New-AuditConfigurationRule": "policy-and-compliance-audit", "New-MailboxAuditLogSearch": "policy-and-compliance-audit", "New-UnifiedAuditLogRetentionPolicy": "policy-and-compliance-audit", - "Remove-AuditConfigurationPolicy": "policy-and-compliance-audit", - "Remove-AuditConfigurationRule": "policy-and-compliance-audit", "Remove-UnifiedAuditLogRetentionPolicy": "policy-and-compliance-audit", "Search-AdminAuditLog": "policy-and-compliance-audit", "Search-MailboxAuditLog": "policy-and-compliance-audit", "Search-UnifiedAuditLog": "policy-and-compliance-audit", "Set-AdminAuditLogConfig": "policy-and-compliance-audit", "Set-AuditConfig": "policy-and-compliance-audit", - "Set-AuditConfigurationRule": "policy-and-compliance-audit", "Set-MailboxAuditBypassAssociation": "policy-and-compliance-audit", "Set-UnifiedAuditLogRetentionPolicy": "policy-and-compliance-audit", "Write-AdminAuditLog": "policy-and-compliance-audit", @@ -902,6 +963,7 @@ "Start-MailboxSearch": "policy-and-compliance-content-search", "Stop-ComplianceSearch": "policy-and-compliance-content-search", "Stop-MailboxSearch": "policy-and-compliance-content-search", + "Export-ActivityExplorerData": "policy-and-compliance-dlp", "Export-DlpPolicyCollection": "policy-and-compliance-dlp", "Get-ClassificationRuleCollection": "policy-and-compliance-dlp", "Get-DataClassification": "policy-and-compliance-dlp", @@ -911,6 +973,7 @@ "Get-DlpDetailReport": "policy-and-compliance-dlp", "Get-DlpDetectionsReport": "policy-and-compliance-dlp", "Get-DlpEdmSchema": "policy-and-compliance-dlp", + "Get-DlpIncidentDetailReport": "policy-and-compliance-dlp", "Get-DlpKeywordDictionary": "policy-and-compliance-dlp", "Get-DlpPolicy": "policy-and-compliance-dlp", "Get-DlpPolicyTemplate": "policy-and-compliance-dlp", @@ -979,7 +1042,11 @@ "Update-ComplianceCaseMember": "policy-and-compliance-ediscovery", "Update-eDiscoveryCaseAdmin": "policy-and-compliance-ediscovery", "Enable-ComplianceTagStorage": "policy-and-compliance-retention", + "Export-ContentExplorerData": "policy-and-compliance-retention", "Export-FilePlanProperty": "policy-and-compliance-retention", + "Get-AdaptiveScope": "policy-and-compliance-retention", + "Get-AppRetentionCompliancePolicy": "policy-and-compliance-retention", + "Get-AppRetentionComplianceRule": "policy-and-compliance-retention", "Get-ComplianceRetentionEvent": "policy-and-compliance-retention", "Get-ComplianceRetentionEventType": "policy-and-compliance-retention", "Get-ComplianceTag": "policy-and-compliance-retention", @@ -1005,6 +1072,10 @@ "Get-RetentionPolicy": "policy-and-compliance-retention", "Get-RetentionPolicyTag": "policy-and-compliance-retention", "Import-FilePlanProperty": "policy-and-compliance-retention", + "Invoke-HoldRemovalAction": "policy-and-compliance-retention", + "New-AdaptiveScope": "policy-and-compliance-retention", + "New-AppRetentionCompliancePolicy": "policy-and-compliance-retention", + "New-AppRetentionComplianceRule": "policy-and-compliance-retention", "New-ComplianceRetentionEvent": "policy-and-compliance-retention", "New-ComplianceRetentionEventType": "policy-and-compliance-retention", "New-ComplianceTag": "policy-and-compliance-retention", @@ -1023,6 +1094,9 @@ "New-RetentionComplianceRule": "policy-and-compliance-retention", "New-RetentionPolicy": "policy-and-compliance-retention", "New-RetentionPolicyTag": "policy-and-compliance-retention", + "Remove-AdaptiveScope": "policy-and-compliance-retention", + "Remove-AppRetentionCompliancePolicy": "policy-and-compliance-retention", + "Remove-AppRetentionComplianceRule": "policy-and-compliance-retention", "Remove-ComplianceRetentionEventType": "policy-and-compliance-retention", "Remove-ComplianceTag": "policy-and-compliance-retention", "Remove-FilePlanPropertyAuthority": "policy-and-compliance-retention", @@ -1040,6 +1114,9 @@ "Remove-RetentionComplianceRule": "policy-and-compliance-retention", "Remove-RetentionPolicy": "policy-and-compliance-retention", "Remove-RetentionPolicyTag": "policy-and-compliance-retention", + "Set-AdaptiveScope": "policy-and-compliance-retention", + "Set-AppRetentionCompliancePolicy": "policy-and-compliance-retention", + "Set-AppRetentionComplianceRule": "policy-and-compliance-retention", "Set-ComplianceRetentionEventType": "policy-and-compliance-retention", "Set-ComplianceTag": "policy-and-compliance-retention", "Set-FilePlanPropertyAuthority": "policy-and-compliance-retention", @@ -1063,83 +1140,62 @@ "Start-RetentionAutoTagLearning": "policy-and-compliance-retention", "Stop-ManagedFolderAssistant": "policy-and-compliance-retention", "Validate-RetentionRuleQuery": "policy-and-compliance-retention", - "Connect-ExchangeOnline": "powershell-v2-module", - "Connect-IPPSSession": "powershell-v2-module", - "Disconnect-ExchangeOnline": "powershell-v2-module", - "Get-EXOCasMailbox": "powershell-v2-module", - "Get-EXOMailbox": "powershell-v2-module", - "Get-EXOMailboxFolderPermission": "powershell-v2-module", - "Get-EXOMailboxFolderStatistics": "powershell-v2-module", - "Get-EXOMailboxPermission": "powershell-v2-module", - "Get-EXOMailboxStatistics": "powershell-v2-module", - "Get-EXOMobileDeviceStatistics": "powershell-v2-module", - "Get-EXORecipient": "powershell-v2-module", - "Get-EXORecipientPermission": "powershell-v2-module", - "Get-MyAnalyticsFeatureConfig": "powershell-v2-module", - "Get-UserBriefingConfig": "powershell-v2-module", - "Get-VivaInsightsSettings": "powershell-v2-module", - "Set-MyAnalyticsFeatureConfig": "powershell-v2-module", - "Set-UserBriefingConfig": "powershell-v2-module", - "Set-VivaInsightsSettings": "powershell-v2-module", + "Add-VivaModuleFeaturePolicy": "powershell-v3-module", + "Add-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Connect-ExchangeOnline": "powershell-v3-module", + "Connect-IPPSSession": "powershell-v3-module", + "Disconnect-ExchangeOnline": "powershell-v3-module", + "Get-ConnectionInformation": "powershell-v3-module", + "Get-DefaultTenantBriefingConfig": "powershell-v3-module", + "Get-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module", + "Get-EXOCasMailbox": "powershell-v3-module", + "Get-EXOMailbox": "powershell-v3-module", + "Get-EXOMailboxFolderPermission": "powershell-v3-module", + "Get-EXOMailboxFolderStatistics": "powershell-v3-module", + "Get-EXOMailboxPermission": "powershell-v3-module", + "Get-EXOMailboxStatistics": "powershell-v3-module", + "Get-EXOMobileDeviceStatistics": "powershell-v3-module", + "Get-EXORecipient": "powershell-v3-module", + "Get-EXORecipientPermission": "powershell-v3-module", + "Get-MyAnalyticsFeatureConfig": "powershell-v3-module", + "Get-UserBriefingConfig": "powershell-v3-module", + "Get-VivaInsightsSettings": "powershell-v3-module", + "Get-VivaModuleFeature": "powershell-v3-module", + "Get-VivaModuleFeatureEnablement": "powershell-v3-module", + "Get-VivaModuleFeaturePolicy": "powershell-v3-module", + "Get-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Remove-VivaModuleFeaturePolicy": "powershell-v3-module", + "Remove-VivaOrgInsightsDelegatedRole": "powershell-v3-module", + "Set-DefaultTenantBriefingConfig": "powershell-v3-module", + "Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v3-module", + "Set-MyAnalyticsFeatureConfig": "powershell-v3-module", + "Set-UserBriefingConfig": "powershell-v3-module", + "Set-VivaInsightsSettings": "powershell-v3-module", + "Update-VivaModuleFeaturePolicy": "powershell-v3-module", "Get-CompromisedUserAggregateReport": "reporting", "Get-CompromisedUserDetailReport": "reporting", - "Get-ConnectionByClientTypeDetailReport": "reporting", - "Get-ConnectionByClientTypeReport": "reporting", - "Get-CsActiveUserReport": "reporting", - "Get-CsAVConferenceTimeReport": "reporting", - "Get-CsClientDeviceDetailReport": "reporting", - "Get-CsClientDeviceReport": "reporting", - "Get-CsConferenceReport": "reporting", - "Get-CsP2PAVTimeReport": "reporting", - "Get-CsP2PSessionReport": "reporting", - "Get-CsPSTNConferenceTimeReport": "reporting", - "Get-CsPSTNUsageDetailReport": "reporting", - "Get-CsUserActivitiesReport": "reporting", - "Get-CsUsersBlockedReport": "reporting", - "Get-GroupActivityReport": "reporting", "Get-HistoricalSearch": "reporting", - "Get-LicenseVsUsageSummaryReport": "reporting", "Get-LogonStatistics": "reporting", - "Get-MailboxActivityReport": "reporting", - "Get-MailboxUsageDetailReport": "reporting", - "Get-MailboxUsageReport": "reporting", "Get-MailDetailDlpPolicyReport": "reporting", - "Get-MailDetailMalwareReport": "reporting", - "Get-MailDetailSpamReport": "reporting", + "Get-MailDetailEncryptionReport": "reporting", "Get-MailDetailTransportRuleReport": "reporting", "Get-MailFilterListReport": "reporting", "Get-MailflowStatusReport": "reporting", + "Get-MailTrafficEncryptionReport": "reporting", "Get-MailTrafficPolicyReport": "reporting", - "Get-MailTrafficReport": "reporting", "Get-MailTrafficSummaryReport": "reporting", - "Get-MailTrafficTopReport": "reporting", "Get-MxRecordReport": "reporting", - "Get-O365ClientBrowserDetailReport": "reporting", - "Get-O365ClientBrowserReport": "reporting", - "Get-O365ClientOSDetailReport": "reporting", - "Get-O365ClientOSReport": "reporting", "Get-OutboundConnectorReport": "reporting", "Get-RecipientStatisticsReport": "reporting", "Get-ReportExecutionInstance": "reporting", "Get-SCInsights": "reporting", "Get-ServiceDeliveryReport": "reporting", - "Get-SPOActiveUserReport": "reporting", - "Get-SPOSkyDriveProDeployedReport": "reporting", - "Get-SPOSkyDriveProStorageReport": "reporting", - "Get-SPOTeamSiteDeployedReport": "reporting", - "Get-SPOTeamSiteStorageReport": "reporting", - "Get-SPOTenantStorageMetricReport": "reporting", - "Get-StaleMailboxDetailReport": "reporting", - "Get-StaleMailboxReport": "reporting", "Get-SupervisoryReviewActivity": "reporting", "Get-SupervisoryReviewOverallProgressReport": "reporting", "Get-SupervisoryReviewPolicyReport": "reporting", "Get-SupervisoryReviewReport": "reporting", "Get-SupervisoryReviewTopCasesReport": "reporting", - "Get-TenantAnalyticsConfig": "reporting", - "Get-UserAnalyticsConfig": "reporting", - "Set-TenantAnalyticsConfig": "reporting", - "Set-UserAnalyticsConfig": "reporting", + "Test-Message": "reporting", "Add-ManagementRoleEntry": "role-based-access-control", "Add-RoleGroupMember": "role-based-access-control", "Get-ManagementRole": "role-based-access-control", @@ -1326,16 +1382,12 @@ "Get-User": "users-and-groups", "New-DistributionGroup": "users-and-groups", "New-DynamicDistributionGroup": "users-and-groups", - "New-EOPDistributionGroup": "users-and-groups", - "New-EOPMailUser": "users-and-groups", "New-MailContact": "users-and-groups", "New-MailUser": "users-and-groups", "New-UnifiedGroup": "users-and-groups", "Remove-DistributionGroup": "users-and-groups", "Remove-DistributionGroupMember": "users-and-groups", "Remove-DynamicDistributionGroup": "users-and-groups", - "Remove-EOPDistributionGroup": "users-and-groups", - "Remove-EOPMailUser": "users-and-groups", "Remove-MailContact": "users-and-groups", "Remove-MailUser": "users-and-groups", "Remove-UnifiedGroup": "users-and-groups", @@ -1343,10 +1395,6 @@ "Set-Contact": "users-and-groups", "Set-DistributionGroup": "users-and-groups", "Set-DynamicDistributionGroup": "users-and-groups", - "Set-EOPDistributionGroup": "users-and-groups", - "Set-EOPGroup": "users-and-groups", - "Set-EOPMailUser": "users-and-groups", - "Set-EOPUser": "users-and-groups", "Set-Group": "users-and-groups", "Set-LinkedUser": "users-and-groups", "Set-MailContact": "users-and-groups", @@ -1355,6 +1403,5 @@ "Set-User": "users-and-groups", "Undo-SoftDeletedUnifiedGroup": "users-and-groups", "Update-DistributionGroupMember": "users-and-groups", - "Update-EOPDistributionGroupMember": "users-and-groups", "Upgrade-DistributionGroup": "users-and-groups" } \ No newline at end of file diff --git a/images/add_related_link.png b/images/add_related_link.png deleted file mode 100644 index a8b99f8375..0000000000 Binary files a/images/add_related_link.png and /dev/null differ diff --git a/images/auto_fork.png b/images/auto_fork.png deleted file mode 100644 index d2a0c85bbc..0000000000 Binary files a/images/auto_fork.png and /dev/null differ diff --git a/images/comparing-changes-page.png b/images/comparing-changes-page.png deleted file mode 100644 index e0a2290794..0000000000 Binary files a/images/comparing-changes-page.png and /dev/null differ diff --git a/images/contrib-consumption-model-orig.png b/images/contrib-consumption-model-orig.png deleted file mode 100644 index 7ac9b3d330..0000000000 Binary files a/images/contrib-consumption-model-orig.png and /dev/null differ diff --git a/images/contrib-consumption-model.png b/images/contrib-consumption-model.png deleted file mode 100644 index 448657c91e..0000000000 Binary files a/images/contrib-consumption-model.png and /dev/null differ diff --git a/images/edit_icon.png b/images/edit_icon.png deleted file mode 100644 index bb87aa6e19..0000000000 Binary files a/images/edit_icon.png and /dev/null differ diff --git a/images/edit_video_capture.jpg b/images/edit_video_capture.jpg deleted file mode 100644 index 11e0bb0aa7..0000000000 Binary files a/images/edit_video_capture.jpg and /dev/null differ diff --git a/images/m365-cc-sc-edit-icon.png b/images/m365-cc-sc-edit-icon.png new file mode 100644 index 0000000000..46684dca7a Binary files /dev/null and b/images/m365-cc-sc-edit-icon.png differ diff --git a/images/open-a-pull-request-page.png b/images/open-a-pull-request-page.png index b31e5e6fbb..e61752e9fc 100644 Binary files a/images/open-a-pull-request-page.png and b/images/open-a-pull-request-page.png differ diff --git a/images/propose-file-change.png b/images/propose-file-change.png index 88e5b4d415..9b67cdea6e 100644 Binary files a/images/propose-file-change.png and b/images/propose-file-change.png differ diff --git a/images/propose_file_change.png b/images/propose_file_change.png deleted file mode 100644 index 6a68423b09..0000000000 Binary files a/images/propose_file_change.png and /dev/null differ diff --git a/images/quick-update-comparing-changes-page.png b/images/quick-update-comparing-changes-page.png new file mode 100644 index 0000000000..8b75fead9d Binary files /dev/null and b/images/quick-update-comparing-changes-page.png differ diff --git a/images/quick-update-edit-button-on-github-page.png b/images/quick-update-edit-button-on-github-page.png new file mode 100644 index 0000000000..2add79f543 Binary files /dev/null and b/images/quick-update-edit-button-on-github-page.png differ diff --git a/images/quick-update-edit-button-on-learn-page.png b/images/quick-update-edit-button-on-learn-page.png new file mode 100644 index 0000000000..dfb170ad8f Binary files /dev/null and b/images/quick-update-edit-button-on-learn-page.png differ diff --git a/images/quick-update-edit.png b/images/quick-update-edit.png deleted file mode 100644 index 993e4d3ca6..0000000000 Binary files a/images/quick-update-edit.png and /dev/null differ diff --git a/images/quick-update-editor-page.png b/images/quick-update-editor-page.png new file mode 100644 index 0000000000..3b7ba57f92 Binary files /dev/null and b/images/quick-update-editor-page.png differ diff --git a/images/quick-update-fork-this-repository-page.png b/images/quick-update-fork-this-repository-page.png new file mode 100644 index 0000000000..3e78555ce8 Binary files /dev/null and b/images/quick-update-fork-this-repository-page.png differ diff --git a/images/quick-update-github-edit-icon.png b/images/quick-update-github-edit-icon.png new file mode 100644 index 0000000000..ba180b5f75 Binary files /dev/null and b/images/quick-update-github-edit-icon.png differ diff --git a/images/quick-update-github.png b/images/quick-update-github.png deleted file mode 100644 index f0e3dcb2da..0000000000 Binary files a/images/quick-update-github.png and /dev/null differ diff --git a/images/quick-update-open-a-pull-request-page.png b/images/quick-update-open-a-pull-request-page.png new file mode 100644 index 0000000000..7087660ec9 Binary files /dev/null and b/images/quick-update-open-a-pull-request-page.png differ diff --git a/images/quick-update-propose-changes-dialog.png b/images/quick-update-propose-changes-dialog.png new file mode 100644 index 0000000000..54a2d31b33 Binary files /dev/null and b/images/quick-update-propose-changes-dialog.png differ diff --git a/images/upload_files.png b/images/upload_files.png index 2ae1b27ee2..231f5c6a78 100644 Binary files a/images/upload_files.png and b/images/upload_files.png differ diff --git a/ms-commerce/TOC.yml b/ms-commerce/TOC.yml new file mode 100644 index 0000000000..b5ef71ac32 --- /dev/null +++ b/ms-commerce/TOC.yml @@ -0,0 +1,2 @@ +- name: Index + href: index.md \ No newline at end of file diff --git a/ms-commerce/breadcrumb/toc.yml b/ms-commerce/breadcrumb/toc.yml new file mode 100644 index 0000000000..61d8fca61e --- /dev/null +++ b/ms-commerce/breadcrumb/toc.yml @@ -0,0 +1,3 @@ +- name: Docs + tocHref: / + topicHref: / \ No newline at end of file diff --git a/ms-commerce/docfx.json b/ms-commerce/docfx.json new file mode 100644 index 0000000000..87dabf8d0c --- /dev/null +++ b/ms-commerce/docfx.json @@ -0,0 +1,50 @@ +{ + "build": { + "content": [ + { + "files": [ + "**/*.md", + "**/*.yml" + ], + "exclude": [ + "**/obj/**", + "**/includes/**", + "_themes/**", + "_themes.pdf/**", + "**/docfx.json", + "_repo.en-us/**", + "README.md", + "LICENSE", + "LICENSE-CODE", + "ThirdPartyNotices.md" + ] + } + ], + "resource": [ + { + "files": [ + "**/*.png", + "**/*.jpg" + ], + "exclude": [ + "**/obj/**", + "**/includes/**", + "_themes/**", + "_themes.pdf/**", + "**/docfx.json", + "_repo.en-us/**" + ] + } + ], + "overwrite": [], + "externalReference": [], + "globalMetadata": { + "breadcrumb_path": "/powershell/breadcrumb/toc.json", + "extendBreadcrumb": true, + "feedback_system": "None" + }, + "fileMetadata": {}, + "template": [], + "dest": "ms-commerce" + } +} \ No newline at end of file diff --git a/ms-commerce/index.md b/ms-commerce/index.md new file mode 100644 index 0000000000..ac668226df --- /dev/null +++ b/ms-commerce/index.md @@ -0,0 +1 @@ +# Welcome to ms-commerce! \ No newline at end of file diff --git a/officewebapps/docfx.json b/officewebapps/docfx.json index ca4b0d499c..025b927d0f 100644 --- a/officewebapps/docfx.json +++ b/officewebapps/docfx.json @@ -65,20 +65,20 @@ "overwrite": [], "externalReference": [], "globalMetadata": { + "ms.service": "office-online-server-powershell", + "uhfHeaderId": "MSDocsHeader-Dev_Office", "author": "serdarsoysal", "ms.author": "mikeplum", "manager": "laurawi", "ms.date": "11/28/2017", "ms.topic": "reference", - "ms.prod": "office-online-server-powershell", "products": [ "https://authoring-docs-microsoft.poolparty.biz/devrel/e87e9701-158d-46fb-8165-fb54b7c45d88", "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" ], "ms.devlang": "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" + "feedback_system": "Standard", + "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" }, "fileMetadata": {}, "template": [], diff --git a/officewebapps/mapping/MAML2Yaml/monikerMapping.json b/officewebapps/mapping/MAML2Yaml/monikerMapping.json new file mode 100644 index 0000000000..3c722651ec --- /dev/null +++ b/officewebapps/mapping/MAML2Yaml/monikerMapping.json @@ -0,0 +1,11 @@ +{ + "officewebapps-ps": { + "conceptualToc": "docs-conceptual/toc.yml", + "conceptualTocUrl": "/powershell/officewebapps/officewebapps-ps/toc.json", + "referenceTocUrl": "/powershell/module/officewebapps-ps/toc.json", + "packageRoot": "officewebapps-ps", + "modules": { + "officewebapps": {} + } + } +} \ No newline at end of file diff --git a/officewebapps/mapping/monikerMapping.json b/officewebapps/mapping/monikerMapping.json deleted file mode 100644 index f9897aa0d7..0000000000 --- a/officewebapps/mapping/monikerMapping.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "officewebapps-ps": { - "conceptualToc": "docs-conceptual/toc.yml", - "conceptualTocUrl": "/powershell/officewebapps/officewebapps-ps/toc.json", - "referenceTocUrl": "/powershell/module/officewebapps-ps/toc.json", - "packageRoot": "officewebapps-ps", - "modules": { - "officewebapps": {} - } - } -} \ No newline at end of file diff --git a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md index 526c00d268..45ec6f32f5 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md +++ b/officewebapps/officewebapps-ps/officewebapps/Get-OfficeWebAppsMachine.md @@ -38,7 +38,7 @@ This example returns details about the current server that is in an Office Onlin (Get-OfficeWebAppsFarm).Machines ``` -This example returns details about all servers that are in a Office Online Server farm. +This example returns details about all servers that are in an Office Online Server farm. ## PARAMETERS diff --git a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md index 92fa3c24c7..b8b8d28dcf 100644 --- a/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md +++ b/officewebapps/officewebapps-ps/officewebapps/New-OfficeWebAppsHost.md @@ -22,7 +22,7 @@ New-OfficeWebAppsHost -Domain ## DESCRIPTION The New-OfficeWebAppsHost cmdlet adds a host domain to the list of host domains to which Office Online Server allows file operations requests, such as file retrieval, metadata retrieval, and file changes. -This list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to a Office Online Server farm and using it for file operations without your knowledge. +This list, known as the Allow List, is a security feature that prevents unwanted hosts from connecting to an Office Online Server farm and using it for file operations without your knowledge. You may any domain type including: Public, Pool, Farm, and Active Directory domain names. Just make sure that the domain you're granting access to meets your security requirements. diff --git a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md index 9013a5c4de..fa7c33ca21 100644 --- a/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md +++ b/officewebapps/officewebapps-ps/officewebapps/Repair-OfficeWebAppsFarm.md @@ -21,7 +21,7 @@ Repair-OfficeWebAppsFarm [-Force] [-WhatIf] [-Confirm] ``` ## DESCRIPTION -The Repair-OfficeWebAppsFarm cmdlet removes all servers flagged as unhealthy from a Office Online Server farm. +The Repair-OfficeWebAppsFarm cmdlet removes all servers flagged as unhealthy from an Office Online Server farm. This cmdlet updates the farm topology but does not clean up services and web applications on the servers that are removed. For this reason, we recommend making every effort to run the Remove-OfficeWebAppsMachine cmdlet from the unhealthy servers so that they are cleanly removed from the farm. Use the Repair-OfficeWebAppsFarm cmdlet only if the unhealthy servers have failed and you cannot run the Remove-OfficeWebAppsMachine cmdlet directly on them. diff --git a/repo_docs/ADVANCED.md b/repo_docs/ADVANCED.md index 89c6bd7ede..4dda622c87 100644 --- a/repo_docs/ADVANCED.md +++ b/repo_docs/ADVANCED.md @@ -155,13 +155,13 @@ To get your work back into the upstream repo you create a Pull Request. A Pull R The repo maintainers will be notified of your Pull Request. Your Pull Request will have its own page where you can discuss and modify your request if required. -## Confirm your work shows up on docs.microsoft.com +## Confirm your work shows up on learn.microsoft.com -Once your Pull Request is approved and your branch merged into Master your changes will show up on the review.docs.microsoft.com site. Unfortunately this site requires a Microsoft login. +Once your Pull Request is approved and your branch merged into Master your changes will show up on the review.learn.microsoft.com site. Unfortunately this site requires a Microsoft login. -The next step is for a maintainer to merge the Master branch into the Live branch. Once this is done your work will show up on docs.microsoft.com. +The next step is for a maintainer to merge the Master branch into the Live branch. Once this is done your work will show up on learn.microsoft.com. -The easiest way to find a cmdlet on docs.microsoft.com is to use the PowerShell Browser here: . If you know a cmdlet exists but doesn't show up in the PowerShell Browser search then open an Issue (link at top of this repo). +The easiest way to find a cmdlet on learn.microsoft.com is to use the PowerShell Browser here: . If you know a cmdlet exists but doesn't show up in the PowerShell Browser search then open an Issue (link at top of this repo). When the product team releases a new build your work will also show up in the Office products themselves when a user types Get-Help for the cmdlets that you worked on. diff --git a/repo_docs/FAQ.md b/repo_docs/FAQ.md index f18618444c..3cdca633fe 100644 --- a/repo_docs/FAQ.md +++ b/repo_docs/FAQ.md @@ -1,44 +1,31 @@ # Frequently Asked Questions ## What are best practices for content on GitHub? -It is best practice to keep each sentence or idea on its own line. -This is so that anyone that is reviewing a commit can quickly and easily see what changed. -If you have a giant string of text on a single line then Git just flags that entire line as a 'change'. -To learn more about this concept, see https://rhodesmill.org/brandon/2012/one-sentence-per-line/. + +It is best practice to keep each sentence or idea on its own line. This is so that anyone that is reviewing a commit can quickly and easily see what changed. If you have a giant string of text on a single line then Git just flags that entire line as a 'change'. To learn more about this concept, see https://rhodesmill.org/brandon/2012/one-sentence-per-line/. ## When will my content go live? -When you submit a Pull Request it goes through a validation check and the results are shown on the Pull Request page in GitHub. -Once the checks are completed, and there are no errors or warnings, and the appropriate sign off has been completed by the product team, a GitHub maintainer will merged the Pull Request into the Master branch on GitHub. +When you submit a Pull Request it goes through a validation check and the results are shown on the Pull Request page in GitHub. Once the checks are completed, and there are no errors or warnings, and the appropriate sign off has been completed by the product team, a GitHub maintainer will merged the Pull Request into the Master branch on GitHub. -A site located at review.docs.microsoft.com shows a mirror of the docs.microsoft.com and pulls from the Master branch. -Unfortunately the review site requires a Microsoft login at this time. -This review site provides an opportunity for Microsoft product teams, support, and other internal stakeholders to review any changes before they are pushed to the live site. +A site located at review.learn.microsoft.com shows a mirror of the learn.microsoft.com and pulls from the Master branch. Unfortunately the review site requires a Microsoft login at this time. This review site provides an opportunity for Microsoft product teams, support, and other internal stakeholders to review any changes before they are pushed to the live site. -The next step is for a GitHub maintainer to merge the Master branch into the Live branch. -Once this is complete the changes in the Pull Request will show up on docs.microsoft.com (docs.microsoft.com pulls its content from the Live branch). -There is not a set schedule for this to happen but the maintainers are good about doing this fairly quickly. +The next step is for a GitHub maintainer to merge the Master branch into the Live branch. Once this is complete the changes in the Pull Request will show up on learn.microsoft.com (learn.microsoft.com pulls its content from the Live branch). There is not a set schedule for this to happen but the maintainers are good about doing this fairly quickly. ## When does the GitHub content show up in the products with Get-Help? -The one source of truth for Office PowerShell cmdlets is the GitHub repository. -When a product team ships an update or new version they can use the PlatyPS tool to generate XML and add that to the release. +The one source of truth for Office PowerShell cmdlets is the GitHub repository. When a product team ships an update or new version they can use the PlatyPS tool to generate XML and add that to the release. -The XML contains the latest version of the reference content on GitHub. -Ideally the Online versions will always have the latest content from GitHub and the On Premises products will always have the latest help with Update-Help. -The work to make this happen is not yet done so the content is only refreshed on product team releases. +The XML contains the latest version of the reference content on GitHub. Ideally the Online versions will always have the latest content from GitHub and the On Premises products will always have the latest help with Update-Help. The work to make this happen is not yet done so the content is only refreshed on product team releases. -NOTE: For now (3/1/2018) the XML is being placed in skype/update-help. -This help is generated from the New-ExternalHelp command that is part of PlatyPS. -The 2019 release is working towards pulling help from here with Update-Help. -Stay tuned. +NOTE: For now (3/1/2018) the XML is being placed in skype/update-help. This help is generated from the New-ExternalHelp command that is part of PlatyPS. The 2019 release is working towards pulling help from here with Update-Help. Stay tuned. ## What metadata do reference topics need to have? Every cmdlet reference topic needs at least the following in the metadata field at the top of the reference article: ``` -external help file: +external help file: applicable: Skype for Business Server 2015 title: Add-CsSlaDelegates author: @@ -47,59 +34,46 @@ ms.reviewer: manager: schema: 2.0.0 ``` -The *external help file* tag is for the docs.microsoft.com infrastructure. -It can be empty but without it the build will fail. -The *applicable* tag is so that when PlatyPS is run to generate the XML that goes in the product it can only pull help content for specific product versions. -Every applicable tag is located in the [Applicable Tags](https://github.com/MicrosoftDocs/office-docs-powershell/wiki/Applicable-Tags) wiki page. -These tags have to be added to the docs.microsoft.com infrastructure. -If you try to include a tag that has not been added then the build will fail. +The *external help file* tag is for the learn.microsoft.com infrastructure. It can be empty but without it the build will fail. + +The *applicable* tag is so that when PlatyPS is run to generate the XML that goes in the product it can only pull help content for specific product versions. Every applicable tag is located in the [Applicable Tags](https://github.com/MicrosoftDocs/office-docs-powershell/wiki/Applicable-Tags) wiki page. These tags have to be added to the learn.microsoft.com infrastructure. If you try to include a tag that has not been added then the build will fail. The *title* tag is for metrics. More information about metrics coming. The *author* is the GitHub alias of the person that owns this topic. Usually the PM or sometimes a dev that owns the cmdlet. + The *ms.author* is the Microsoft alias of the same author. + The *ms.reviewer* is the Microsoft alias of someone that can approve any technical changes (if different than the author). -The *manager* is the Microsoft alias of a manager for the team that owns the cmdlet. This is useful if the person that owns the cmdlet leaves the company. The manager will be reached to in order to find the new author. +The *manager* is the Microsoft alias of a manager for the team that owns the cmdlet. This is useful if the person that owns the cmdlet leaves the company. The manager will be reached to in order to find the new author. -The *schema* tag let's the build system know what schema to use. -The 2.0.0 is the only supported schema currently. -The schema can be viewed on the PlatyPS site, see https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md. +The *schema* tag let's the build system know what schema to use. The 2.0.0 is the only supported schema currently. The schema can be viewed on the PlatyPS site, see . -There is also metadata at the global level for the folder. -This metadata is contained in the docfx.json file of the folder. -For example, SharePoint is here: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/docfx.json +There is also metadata at the global level for the folder. This metadata is contained in the docfx.json file of the folder. For example, SharePoint is here: . ## What is the special Table of Contents (TOC) file all about? Every folder has a special file that is a table of contents for all the files in the folder. Some examples are: -* Teams: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/teams/teams-ps/teams/teams.md -* Skype: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/skype/skype-ps/skype/skype.md -* SharePoint Server: https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/sharepoint/sharepoint-ps/sharepoint-server/sharepoint-server.md -Every folder must have this TOC file. -When you browse the list of cmdlets in the Reference folder this is the file you see. -For example, https://docs.microsoft.com/powershell/module/skype/?view=skype-ps. -Note that docs.microsoft.com automatically strips out the note about manually entering a description. -It ONLY strips this out if it is in the exact format given. -Any slight deviation from the format and it won't strip it out and you will see that "manually enter description" text. +- Teams: +- Skype: +- Exchange: + +Every folder must have this TOC file. When you browse the list of cmdlets in the Reference folder this is the file you see. For example, . Note that learn.microsoft.com automatically strips out the note about manually entering a description. It ONLY strips this out if it is in the exact format given. Any slight deviation from the format and it won't strip it out and you will see that "manually enter description" text. ## I can't find the cmdlet I am looking for, what can I do? -Finding a cmdlet can sometimes be a challenge. -This is because you might need to use cmdlets that are in various modules and across multiple products. -For example, you might need a Windows cmdlet, then an Azure cmdlet, then a SharePoint cmdlet, then an Office 365 cmdlet. +Finding a cmdlet can sometimes be a challenge. This is because you might need to use cmdlets that are in various modules and across multiple products. For example, you might need a Windows cmdlet, then an Azure cmdlet, then a SharePoint cmdlet, then an Office 365 cmdlet. -The best way to find cmdlets is to use the PowerShell Browser and search. -The PowerShell Browser searches across all products and platforms. -You can find the PowerShell Browser here: https://docs.microsoft.com/powershell/module +The best way to find cmdlets is to use the PowerShell Browser and search. The PowerShell Browser searches across all products and platforms. You can find the PowerShell Browser here: . ## I am a Microsoft employee but new to GitHub, what should I do? -You can learn about working with GitHub as a Microsoft employee here: https://docs.opensource.microsoft.com/github/ +You can learn about working with GitHub as a Microsoft employee here: In a nutshell you need to create a GitHub account and link it with your Microsoft account so you can contribute openly. @@ -111,45 +85,39 @@ They try to get to these every day and verify and merge Pull Requests. If it is an emergency you can look through the merge history and see who has worked on and merged a recent version and contact them directly. -If you are a Microsoft employee you can email the distribution group which includes the maintainers of the repository. -The distribution group is Office Docs PowerShell Maintainers (od-powershell). +If you are a Microsoft employee you can email the distribution group which includes the maintainers of the repository. The distribution group is Office Docs PowerShell Maintainers (od-powershell). ## Git is getting on my nerves, do you have any advice? One of the most confusing things with Git and GitHub is that there are many, many ways to do things. -You can use the command line with a cmd prompt or you can use a command line with git bash or you can use a GUI like GitHub Desktop https://desktop.github.com/. +You can use the command line with a cmd prompt or you can use a command line with git bash or you can use a GUI like GitHub Desktop . -If you are working with the command line using Git Bash, this will help: -https://www.codeproject.com/Articles/457305/Basic-Git-Command-Line-Reference-for-Windows-Users +If you are working with the command line using Git Bash, this will help: . Also check out Git Kraken https://www.gitkraken.com/ which has a great user interface and visualizations. ## Why are all the cmdlets for a given product in a single folder in the repo? Wouldn't it be better to put them in buckets? -GitHub is the single source of truth for Office PowerShell cmdlet reference. -There is a single reference article per cmdlet. -There is a folder for each major product area in order to create a basic structure but this isn't require for the system to work. -Each article is tagged with appropriate metadata for versioning. -Keeping things as simple as possible has a number of benefits. -For more about the design of the system, see the FAQ item *"Why is this open source project designed the way it is?"*. +GitHub is the single source of truth for Office PowerShell cmdlet reference. There is a single reference article per cmdlet. There is a folder for each major product area in order to create a basic structure but this isn't require for the system to work. Each article is tagged with appropriate metadata for versioning. Keeping things as simple as possible has a number of benefits. For more about the design of the system, see the FAQ item *"Why is this open source project designed the way it is?"*. ## Why is this open source project designed the way it is? + The system was designed to be as simple as possible in order to achieve three primary objectives. 1. Increase community engagement. There are many open source projects and every one of them is striving for community involvement. We designed the PowerShell reference project to be easily understood in order to increase community ownership and contributions. - If a person comes to a project and they cannot understand what they can do in 20-30 seconds then they are likely to bounce on to something else. - The open source PowerShell reference project was designed to break down the barriers to understanding and so someone can ‘flow’ directly into contributions once they have discovered the project. + If a person comes to a project and they cannot understand what they can do in 20-30 seconds then they are likely to bounce on to something else. + The open source PowerShell reference project was designed to break down the barriers to understanding and so someone can 'flow' directly into contributions once they have discovered the project. A vibrant and active community results in the best reference content that goes directly back into PowerShell Get-Help. - + 1. Central location for content that feeds multiple surfacing mechanisms. - The first two places the PowerShell reference content is surfaces is Get-Help in PowerShell itself and the docs.microsoft.com website. - In the future the content can also be surfaced in an iOS app, Android app, Windows Universal app, and other mechanisms. - With a simple, centralized, system for the source of truth, in GitHub, it becomes much easier to surface content using multiple mechanisms since GitHub is not tailored for once specific location, such as Get-Help. + The first two places the PowerShell reference content is surfaces is Get-Help in PowerShell itself and the learn.microsoft.com website. + In the future the content can also be surfaced in an iOS app, Android app, Windows Universal app, and other mechanisms. + With a simple, centralized, system for the source of truth, in GitHub, it becomes much easier to surface content using multiple mechanisms since GitHub is not tailored for once specific location, such as Get-Help. If the GitHub repo focused on one specific site or mechanism then surfacing from other mechanisms could become too complex or could exponentially expound the effort required. 1. Keep content fresh and up to date. @@ -158,5 +126,3 @@ The system was designed to be as simple as possible in order to achieve three pr The system was designed so that the process can be automated, perhaps with a GitHub webhook that triggers on any merge. The idea is that in the past the Get-Help content was immediately outdated once a product shipped. With the new system the content in Get-Help will always be up-to-date by running an Update-Help, or equivalent, command in PowerSHell. - - diff --git a/repo_docs/NEW_CMDLETS.md b/repo_docs/NEW_CMDLETS.md index fb13da3af5..fbbbaaefc1 100644 --- a/repo_docs/NEW_CMDLETS.md +++ b/repo_docs/NEW_CMDLETS.md @@ -4,59 +4,49 @@ Cmdlet reference topics follow a very strict schema that's difficult to duplicat ## Step 1: Install platyPS -If you're running Windows 10 or Windows Server 2016, you already have Windows PowerShell 5.x installed, so installing platyPS is easy. - -Run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): +On Windows 10, Windows Server 2016, or later, run the following command in an elevated Windows PowerShell window (a Windows PowerShell window you open by selecting **Run as administrator**): ```powershell Install-Module -Name platyPS -Scope CurrentUser ``` -**Notes**: +If you need to install platyPS on old versions of Windows (Windows 8.1 or Windows 2012 R2 or earlier), you need to install Windows PowerShell 5.1 before you can install platyPS. For instructions, see the [Install platyPS on older versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this article. -- You need platyPS v0.14.0 or later, released on or about April 3 2019. If you have an earlier version of platyPS installed, close all open Windows PowerShell windows where the platyPS module is currently loaded (or run the command `Remove-Module platyPS`) and then run `Update-Module platyPS` from an elevated Windows PowerShell window. +If you need to install platyPS on really old versions of Windows (a server running a product that lacks support for WMF 5.1 or its requirements), see the [Install platyPS on really old versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this article. -- Windows PowerShell 5.x is part of the Windows Management Framework (WMF) and can be [downloaded](https://aka.ms/wmf5download) and installed on these versions of Windows: - - - Windows Server 2012 R2 - - Windows Server 2012 - - Windows Server 2008 R2 SP1 - - Windows 8.1 - - Windows 7 - - If you need to install platyPS on an older version of Windows (for example, a server running a product that lacks support for WMF 5.x or its requirements), see the [Install platyPS on older versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this topic. +You need platyPS v0.14.0 or later (released April 2019). If you have an earlier version of platyPS installed, close all open Windows PowerShell windows where the platyPS module is currently loaded and then run `Update-Module platyPS` from a new elevated Windows PowerShell window. Or, run the command `Remove-Module platyPS` and then run `Install-Module -Name platyPS -Scope CurrentUser` to get the current version. ## Step 2: Connect to the PowerShell environment that has the cmdlet You probably know how to do this already, but the available workloads and connection methods are: -- Skype for Business Online: - -- Microsoft Teams: [Install Microsoft Teams PowerShell](https://docs.microsoft.com/MicrosoftTeams/teams-powershell-install) +- Microsoft Teams: [Install Microsoft Teams PowerShell](https://learn.microsoft.com/MicrosoftTeams/teams-powershell-install) - **HINT:** Use `Upgrade-Module` and also `Uninstall-Module` depending on the module version you have installed. - -- SharePoint Online: [Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + > [!TIP] + > Use `Upgrade-Module` and also `Uninstall-Module` depending on the module version you have installed. - Exchange: + - Exchange Online PowerShell: [Connect to Exchange Online PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) + - Security & Compliance PowerShell: [Connect to Security & Compliance PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-scc-powershell) + - Exchange Online Protection PowerShell: [Connect to Exchange Online Protection PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-online-protection-powershell) + - Exchange Server PowerShell: [Connect to Exchange servers using remote PowerShell](https://learn.microsoft.com/powershell/exchange/connect-to-exchange-servers-using-remote-powershell) - - Exchange Online: [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell) - - - Security & Compliance Center: [Connect to Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-scc-powershell) - - - Exchange Online Protection: [Connect to Exchange Online Protection PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-protection-powershell) - - - Exchange Server: [Connect to Exchange servers using remote PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-servers-using-remote-powershell) - -**Notes**: - -- You might need to connect to the service in an elevated Windows PowerShell prompt (required for Skype for Business Online and Teams, but not Exchange). The connection instructions topic should contain this and other connection requirements. - -- In Exchange environments, the cmdlets available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are available to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles). +> [!TIP] +> You might need to connect to the service in an elevated Windows PowerShell prompt (Teams and Exchange environments don't require an elevated Windows PowerShell prompt). The connection instructions article should plainly state this and other connection requirements. +> +> In Exchange and Security & Compliance PowerShell environments, the cmdlets that are available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are available to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles. +> +> Remote PowerShell connections are deprecated in Exchange Online PowerShell and Security & Compliance PowerShell in favor of REST API connections. For more information, see the following articles: +> +> - [REST API connections in the EXO V3 module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#rest-api-connections-in-the-exo-v3-module). +> - [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). +> - [Deprecation of Remote PowerShell (RPS) Protocol in Security & Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). +> +> REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. The true parameter type values are visible in product code. ## Step 3: Load platyPS in the PowerShell environment -After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), run the following command to make the platyPS cmdlets available in your session: +After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), you likely don't need to do anything to make the platyPS cmdlets available to you in your session. However, it you're having issues, run the following command to manually load the platyPS module: ```powershell Import-Module platyPS @@ -64,7 +54,8 @@ Import-Module platyPS ### Step 4: Find your module name -**Note**: This step is required only if you're interested in creating cmdlet reference topics for **all** available cmdlets in your product (the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (the _Command_ parameter in `New-MarkdownHelp`), you can skip this step. +> [!NOTE] +> This step is required only if you're interested in creating cmdlet reference articles for **all** available cmdlets in the product (using the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (using the _Command_ parameter in `New-MarkdownHelp`), you can skip this step. platyPS needs the name of the loaded PowerShell module or snap-in that contains the cmdlets you want to update. To find the name, run the following command: @@ -81,9 +72,8 @@ Manifest 3.1.0.0 Microsoft.PowerShell.Management {Add-Computer, Add-Con Manifest 3.0.0.0 Microsoft.PowerShell.Security {ConvertFrom-SecureString, ConvertTo-SecureString, Get-Acl... Manifest 3.1.0.0 Microsoft.PowerShell.Utility {Add-Member, Add-Type, Clear-Variable, Compare-Object...} Binary 1.0.0.1 PackageManagement {Find-Package, Find-PackageProvider, Get-Package, Get-Pack... -Script 0.14.0 platyps {Get-HelpPreview, Get-MarkdownMetadata, Merge-MarkdownHelp... -Script 1.0.0.1 PowerShellGet {Find-Command, Find-DscResource, Find-Module, Find-RoleCap... -Script 1.2 PSReadline {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PS... +Script 2.2.5 PowerShellGet {Find-Command, Find-DscResource, Find-Module, Find-RoleCap... +Script 2.0.0 PSReadline {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remove-PS... Script 1.0 tmp_byivwzpq.e1k {Add-AvailabilityAddressSpace, Add-DistributionGroupMember... ``` @@ -92,138 +82,85 @@ or this: ```powershell ModuleType Version Name ExportedCommands ---------- ------- ---- ---------------- -Binary 16.0.7723.0 Microsoft.Online.SharePoint.PowerShell {Add-SPOGeoAdministrator, Add-SPOHubSiteAssociation, A... -Manifest 3.1.0.0 Microsoft.PowerShell.Management {Add-Computer, Add-Content, Checkpoint-Computer, Clear... -Manifest 3.0.0.0 Microsoft.PowerShell.Security {ConvertFrom-SecureString, ConvertTo-SecureString, Get... -Manifest 3.1.0.0 Microsoft.PowerShell.Utility {Add-Member, Add-Type, Clear-Variable, Compare-Object...} -Script 1.2 PSReadline {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remov... +Manifest 3.1.0.0 Microsoft.PowerShell.Management {Add-Computer, Add-Content, Checkpoint-Computer, Clear-Content...} +Manifest 3.1.0.0 Microsoft.PowerShell.Utility {Add-Member, Add-Type, Clear-Variable, Compare-Object...} +Script 4.2.0 MicrosoftTeams {Add-TeamChannelUser, Add-TeamUser, Connect-MicrosoftTeams, Disconnect-Microso... +Script 1.4.7 PackageManagement {Find-Package, Find-PackageProvider, Get-Package, Get-PackageProvider...} +Script 2.2.5 PowerShellGet {Find-Command, Find-DscResource, Find-Module, Find-RoleCapability...} +Script 2.0.0 PSReadline {Get-PSReadLineKeyHandler, Get-PSReadLineOption, Remove-PSReadLineKeyHandler, ... ``` -For services that use remote PowerShell (Skype for Business Online, Teams, Exchange Online, Security & Compliance Center, and Exchange Online Protection), the module name is a temporary value that changes every time you connect. In this output, the module name is `tmp_byivwzpq.e1k`, but yours will be different. +For services that use remote connections (Exchange), the module name is a temporary value that changes every time you connect. In the example output, the module name is `tmp_byivwzpq.e1k`, but yours will be different. -For SharePoint Online in the SharePoint Online Management Shell, the module name is always `Microsoft.Online.SharePoint.PowerShell`. +For Microsoft Teams, the module name is always `MicrosoftTeams`. Either way, take note of your module name. You'll need it in the next steps. -### Step 5: Verify your PSSession variable name - -**Note**: This step is required in Exchange, Skype for Business Online and other products that use remote PowerShell. **If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell, you can skip this step**. - -Check the details of your connection instructions, but your session information is stored in a variable. For example, in the Exchange connection instructions, the variable is `$Session`. You'll use this variable name in later steps. - -**If you connected via a custom script or your remote PowerShell session variable isn't apparent, do the following steps**: - -1. Run the following command to find your session: - - ```powershell - Get-PSSession | Format-Table -Auto - ``` - - The output will resemble this: - - ```powershell - Id Name ComputerName ComputerType State ConfigurationName Availability - -- ---- ------------ ------------ ----- ----------------- ------------ - 1 ExchangeOnlineInternalSession_1 outlook.office365.com RemoteMachine Opened Microsoft.Exchange Available - ``` - - or this: - - ```powershell - Id Name ComputerName ComputerType State ConfigurationName Availability - -- ---- ------------ ------------ ----- ----------------- ------------ - 1 WinRM1 admin2a.online.lync.com RemoteMachine Opened Microsoft.PowerShell Available - ``` - - **Note**: If you see multiple sessions, either start over in a new PowerShell window or confirm the session you want to use. The first connection is 1, the second is 2, and so on. - -2. Use the following syntax to store the session in a variable: - - ```powershell - $ = Get-PSSession - ``` - - For example, using the sample output in the previous step: - - ```powershell - $Session = Get-PSSession 1 - ``` - - The variable name you choose doesn't matter, but you'll use it in later steps. - -### Step 6: Run platyPS to generate topic files +### Step 5: Run platyPS to generate topic files You have two choices: -- **Dump _all_ cmdlets in the module/snap-in to files**: This is simple but could take a while, and you'll end up with dozens or possibly hundreds of cmdlets files you don't need. The basic syntax is: +- **Dump _all_ cmdlets in the module/snap-in to files**: This is simple but could take a while, and you'll end up with dozens or possibly hundreds of cmdlet files you don't need. The basic syntax is: ```powershell - New-MarkdownHelp -Module -OutputFolder " [-Session ] + New-MarkdownHelp -Module -OutputFolder " ``` - **Dump specific cmdlets to files**: This is a bit harder to set up, but the output is much quicker, and there are no extra topic files created. The basic syntax is: ```powershell - New-MarkdownHelp -Command -OutputFolder " [-Session ] + New-MarkdownHelp -Command -OutputFolder " ``` or ```powershell $x = "","",..."" - New-MarkdownHelp -Command $x -OutputFolder " [-Session ] + + New-MarkdownHelp -Command $x -OutputFolder " ``` **Notes**: -- \ is the value you found in [Step 4](#step-4-find-your-module-name) (for example, `tmp_byivwzpq.e1k` or `Microsoft.Online.SharePoint.PowerShell`). - -- \ is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) _and is required only if the connection uses remote PowerShell_. - - Failure to use the _Session_ parameter in remote PowerShell environments leads to weird results: multiple syntax blocks/parameter sets aren't recognized and are collapsed into one big block, the Type value is Object for all parameters, the Required value is False for all parameters, etc. +- \ is the value you found in [Step 4](#step-4-find-your-module-name) (for example, `tmp_byivwzpq.e1k` or `MicrosoftTeams`). - If the \ location doesn't exist, it's created for you. #### Dump all cmdlets in the module/snap-in to files -This example creates topic files for all available cmdlets in the Skype for Business Online PowerShell session where the module is `tmp_byivwzpq.e1k` and the session variable is `$Session` in the folder C:\My Docs\SfBO. +This example creates topic files for all available cmdlets in the Microsoft Teams module `MicrosoftTeams` in the folder C:\My Docs\Teams. ```powershell -New-MarkdownHelp -Module tmp_byivwzpq.e1k -OutputFolder "C:\My Docs\SfBO" -Session $Session +New-MarkdownHelp -Module MicrosoftTeams -OutputFolder "C:\My Docs\Teams" ``` #### Dump specific cmdlets to files -This example creates a topic file for the cmdlet named **Get-CoolFeature** in the Exchange Online PowerShell session where the session variable is `$Session` in the folder "C:\My Docs\ExO". +This example creates a topic file for the cmdlet named **Get-CoolFeature** in the Exchange Online PowerShell session in the folder "C:\My Docs\ExO". ```powershell -New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" -Session $Session +New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" ``` -This example creates topic files for the **Get-CoolFeature**, **New-CoolFeature**, **Remove-CoolFeature**, and **Set-CoolFeature** cmdlets from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO. +This example creates topic files for the **Get-CoolFeature**, **New-CoolFeature**, **Remove-CoolFeature**, and **Set-CoolFeature** cmdlets from the Exchange Online session in the folder C:\My Docs\ExO. The first command stores the cmdlet names in a variable. The second command uses that variable to identify the cmdlets and write the output files. ```powershell $NewCmdlets = "Get-CoolFeature","New-CoolFeature","Remove-CoolFeature","Set-CoolFeature" -``` -```powershell -New-MarkdownHelp -Command $NewCmdlets -OutputFolder "C:\My Docs\ExO" -Session $Session +New-MarkdownHelp -Command $NewCmdlets -OutputFolder "C:\My Docs\ExO" ``` -### Step 7: Document the new cmdlet +### Step 6: Document the new cmdlet Now that you have topic files for the new cmdlets, you can actually document them. The topics are plain text UTF-8 files that are formatted using [markdown](https://guides.github.com/features/mastering-markdown/). Office writers use [Visual Studio Code](https://code.visualstudio.com/) to edit topic files, but you can use Notepad or your favorite text editor. These are the basic topic elements that require your attention, regardless of the product or service: - **The SYNOPSIS section**: Be brief. Use the DESCRIPTION section for less critical information. - - **The DESCRIPTION section**: More details (for example, permissions required to run the cmdlet) - - **One or more code examples in the EXAMPLES section**: The code block (only one code block) goes first, then the description text. - - **A description for every parameter in each parameter section** We highly encourage you to plagiarize existing content and formatting from other cmdlet topics in the product or service. Many parameters are common across a wide variety of cmdlets. @@ -234,12 +171,12 @@ Less obvious but still important information that's often manually required in e ##### Cmdlet metadata -Every cmdlet reference topic needs at least the following in the metadata field at the top of the reference article: +Every cmdlet reference topic needs (at a minimum) the following properties in the metadata field at the top of the reference article: ```text external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets -online version: https://docs.microsoft.com/powershell/module/skype/add-cssladelegates +online version: https://learn.microsoft.com/powershell/module/skype/add-cssladelegates applicable: Skype for Business Server 2015 title: Add-CsSlaDelegates author: @@ -249,9 +186,9 @@ manager: schema: 2.0.0 ``` -- **external help file**: Defines which MAML/XML file the cmdlet help topic goes in for `Get-Help` at the command line. This value very product-specific, and the location is specified somewhere in product code. Some products (Skype) use only one XML file that's well-known and the same for all cmdlets; others (Exchange, SharePoint) use multiple XML files. See other topics for available values. Don't guess; a wrong value here will affect the availability of the help topic at the command line. +- **external help file**: Defines which MAML/XML file the cmdlet help topic goes in for `Get-Help` at the command line. This value very product-specific, and the location is specified somewhere in product code. Some products (Skype) use only one XML file that's well-known and the same for all cmdlets; others (Exchange) use multiple XML files. See other topics for available values. Don't guess; a wrong value here will affect the availability of the help topic at the command line. -- **Module Name**: Not used in Exchange topics (remove it). For other products, this is the module name of the product. +- **Module Name**: In Exchange topics, this value is `ExchangeOnlineManagement` for those few cmdlets that are [baked into the Exchange Online PowerShell V3 module itself](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#cmdlets-in-the-exchange-online-powershell-module). For other products, this is the module name of the product. - **online version**: This is the URL of the topic. This URL value is what makes the `Get-Help -Online` command work, so it's very important. @@ -288,60 +225,44 @@ Accept wildcard characters: False Most of the attributes and values are generated automatically by platyPS. The ones that require manual intervention are: +- **Type**: In any environment, the values `Object` or `Object[]` are wrong. As previously described, REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. Other values like `String`, `Boolean`, and `DateTime` are detected correctly. The true parameter type values are visible in product code. + - **Applicable**: You need to add this attribute and value yourself. Notice the capital 'A'. See other topics for available values (same available values as the **applicable** attribute at the top of the topic). Don't invent new values here. The value **must** come from the list of predefined values. - **Default value** and **Accept wildcard characters**: These attributes are present, but the values are never truthfully populated by platyPS **or any other PowerShell utility** (they're always None and False, respectively). You can correct the values if you think it's important. Otherwise, leave them as is. ### Step 8: Add the new cmdlet topic files to the repository -When you're done editing the topics, upload them to GitHub. Note that you need to fork, upload your files to your fork, then submit a Pull Request. +When you're done editing the topics, upload them to GitHub. Note that you need to fork the repo, upload your files to your fork, and then submit a Pull Request. 1. Go to the correct location in the appropriate GitHub repository: - Exchange: - - Office Web Apps: - - - SharePoint Online: - - - SharePoint PNP: - - - SharePoint Server: - - Skype: - - StaffHub: - - Teams: - - Whiteboard: + - SharePoint / OneDrive: -2. Click **Upload files** +2. Select **Add file** \> **Upload files** ![Upload file.](../images/upload_files.png) -3. After you're done adding files, go to the **Propose file change** section at the bottom of the page: +3. After you're done adding files, go to the **Propose changes** section at the bottom of the page: - A brief title is required. By default, the title is the name of the file, but you can change it. - - Optionally, you can enter more details in the **Add an optional extended description** box. + - Optionally, you can enter more details in the **Add an optional extended description** box. You should @ include the GitHub alias of someone who can review and approve your upload. - When you're ready, click the green **Propose file change** button. + When you're ready, click the green **Propose changes** button. ![Propose file change section.](../images/propose-file-change.png) -4. On the **Comparing changes** page that appears, click the green **Create pull request** button. - - ![Comparing changes page.](../images/comparing-changes-page.png) - -5. On the **Open a pull request** page that appears, click the green **Create pull request** button. +4. On the **Open a pull request** page that appears, click the green **Create pull request** button. ![Open a pull request page.](../images/open-a-pull-request-page.png) -> [!NOTE] -> -> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages. -> -> The point is: click any green buttons that are presented to you until there are no more. +5. That's it. There's nothing more for you to do. ### Step 9: Add the new cmdlets to the TOC file @@ -349,16 +270,11 @@ Add the cmdlet to Table of Contents (TOC) file in the GitHub repo. TOC file is t - Exchange - **Note**: Exchange also uses pseudo folders to organize cmdlets. You need to add any new cmdlets in the proper location in the file: . + > [!TIP] + > Exchange also uses pseudo folders to organize cmdlets. You need to add any new cmdlets in the proper location in the file: . - Office Web Apps: -- SharePoint Online: - -- SharePoint PNP: - -- SharePoint Server: - - Skype: - StaffHub: @@ -369,53 +285,45 @@ Add the cmdlet to Table of Contents (TOC) file in the GitHub repo. TOC file is t In the TOC file, you can fill in a description or remove the template text line. However, if you leave the template text line make sure it's in _exactly_ the right format so it won't render as a template text. -After you're done editing the TOC files: +The steps to edit and publish the TOC file are identical to modifying any existing topic. The instructions are [here](https://github.com/MicrosoftDocs/office-docs-powershell/blob/main/README.md) (you're starting at Step 4). -1. Go to the **Propose file change** section at the bottom of the page: - - - A brief title is required. By default, the title is the name of the file, but you can change it. - - Optionally, you can enter more details in the **Add an optional extended description** box. +## Appendix - When you're ready, click the green **Propose file change** button. +### Reference - ![Propose file change section.](../images/propose-file-change.png) +- -2. On the **Comparing changes** page that appears, click the green **Create pull request** button. +- - ![Comparing changes page.](../images/comparing-changes-page.png) +- -3. On the **Open a pull request** page that appears, click the green **Create pull request** button. +- - ![Open a pull request page.](../images/open-a-pull-request-page.png) +### Install platyPS on older versions of Windows > [!NOTE] -> -> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages. -> -> The point is: click any green buttons that are presented to you until there are no more. - -## Appendix - -### Reference +> The procedures in this section aren't required in current versions of Windows (Windows 10, Windows Server 2016, or later) or other versions of Windows where the WMF 5.1 is already installed. -- +The following older versions of Windows don't automatically include Windows PowerShell 5.1, but they support it. You need to download and install the Windows Management Framework (WMF) 5.1 from on these versions of Windows: -- - -- +- Windows 8.1 +- Windows Server 2012 or Windows Server 2012 R2 +- Windows 7 Service Pack 1 (SP1)1,2 +- Windows Server 2008 R2 SP11,2 -- +- 1 This version of Windows has reached its end of support, and is now supported only in Azure virtual machines. +- 2 Windows PowerShell 5.1 on this version of Windows requires the .NET Framework 4.5 or later. For more information, see [Windows Management Framework 5.1](https://aka.ms/wmf5download). -### Install platyPS on older versions of Windows (WMF 3.0 or 4.0) +### Install platyPS on really old versions of Windows (WMF 3.0 or 4.0) > [!NOTE] -> These procedures aren't required on Windows 10, Windows Server 2016 or later, or other versions of Windows where the WMF 5.x is already installed. +> The procedures in this section aren't required in current versions of Windows (Windows 10, Windows Server 2016, or later) or other versions of Windows where the WMF 5.1 is already installed. -To install platyPS on Windows clients or servers that are using PowerShell 3.0 or 4.0 and don't have access to the **Install-Module** cmdlet, do the steps in this section. +To install platyPS for use with products that require PowerShell 3.0 or 4.0 and don't initially have access to the **Install-Module** cmdlet, do the steps in this section. -1. Download and install PowerShellGet. The steps are described in [Installing PowerShellGet](https://docs.microsoft.com/powershell/scripting/gallery/installing-psget) and are summarized here as follows: +1. Download and install PowerShellGet. The steps are described in [Installing PowerShellGet](https://learn.microsoft.com/powershell/scripting/gallery/installing-psget) and are summarized here as follows: - a. **PowerShell 3.0 only**: Run the following command in an elevated Windows PowerShell window: + a. **PowerShell 3.0 only**: On the target computer, run the following command in an elevated Windows PowerShell window: ```powershell [Environment]::SetEnvironmentVariable( @@ -437,30 +345,30 @@ To install platyPS on Windows clients or servers that are using PowerShell 3.0 o - `PackageManagement\\` - `PowerShellGet\\` - You need to move the \ out from under the \ and delete the now empty \ so the contents of the folders look like this: + d. Move the \ out from under the \ and delete the now empty \ so the contents of the folders look like this: - `PackageManagement\` - `PowerShellGet\` -2. Delete the following folders from your computer or move them to a remote location for safekeeping: +2. On the target computer, delete the following folders or move them to a remote location for safekeeping: - `C:\Program Files\WindowsPowerShell\Modules\PackageManagement` - `C:\Program Files\WindowsPowerShell\Modules\PowerShellGet` -3. Copy the `PackageManagement` and `PowerShellGet` folders that you downloaded and fixed in Step 1 to `C:\Program Files\WindowsPowerShell\Modules`. +3. Copy the `PackageManagement` and `PowerShellGet` folders that you downloaded and fixed in Step 1b to `C:\Program Files\WindowsPowerShell\Modules` on the target computer. - You should now have the following folders again: + You should have the following folders on the target computer: - `C:\Program Files\WindowsPowerShell\Modules\PackageManagement` - `C:\Program Files\WindowsPowerShell\Modules\PowerShellGet` -4. From an elevated Windows PowerShell window, run the following command: +4. From an elevated Windows PowerShell window on the target computer, run the following command: ```powershell Set-PSRepository -Name PSGallery -InstallationPolicy Trusted ``` -5. Now you can finally install platyPS by running the usual command: +5. Now you can finally install platyPS on the target computer by running the usual command: ```powershell Install-Module -Name platyPS -Scope CurrentUser diff --git a/repo_docs/UPDATE_CMDLETS.md b/repo_docs/UPDATE_CMDLETS.md index 6a50503376..0f89ae5ffa 100644 --- a/repo_docs/UPDATE_CMDLETS.md +++ b/repo_docs/UPDATE_CMDLETS.md @@ -28,6 +28,15 @@ The steps are the same as [Create new cmdlet topics](NEW_CMDLETS.md#step-1-insta You probably know how to do this already, but the available workloads and connection methods are also described in [Create new cmdlet topics](NEW_CMDLETS.md#step-2-connect-to-the-powershell-environment-that-has-the-cmdlet). +> [!NOTE] +> Remote PowerShell connections are deprecated in Exchange Online PowerShell and Security & Compliance PowerShell in favor of REST API connections. For more information, see the following articles: +> +> - [REST API connections in the EXO V3 module](https://learn.microsoft.com/powershell/exchange/exchange-online-powershell-v2#rest-api-connections-in-the-exo-v3-module). +> - [Deprecation of Remote PowerShell in Exchange Online](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-in-exchange-online-re-enabling/ba-p/3779692). +> - [Deprecation of Remote PowerShell (RPS) Protocol in Security & Compliance PowerShell](https://techcommunity.microsoft.com/t5/exchange-team-blog/deprecation-of-remote-powershell-rps-protocol-in-security-and/ba-p/3815432). +> +> REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. The true parameter type values are visible in product code. + ### Step 3: Load platyPS in the PowerShell environment After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), run the following command to make the platyPS cmdlets available in your session: @@ -36,50 +45,41 @@ After you've connected in PowerShell to the server or service (either in a regul Import-Module platyPS ``` -### Step 4: Verify your PSSession variable name - -This step is the same as in [Create new cmdlet topics](NEW_CMDLETS.md#step-5-verify-your-your-pssession-variable-name). - -To recap: this step is required in Exchange, Skype for Business Online and other products that use remote PowerShell, and the value is most likely `$Session`. - -If you're using SharePoint, SharePoint Online or another product that doesn't use remote PowerShell, you can skip this step. - -### Step 5: Use New-MarkdownHelp to dump the latest version of the cmdlet to a file +### Step 4: Use New-MarkdownHelp to dump the latest version of the cmdlet to a file These instructions are the same (up to a point) as in [Create new cmdlet topics](NEW_CMDLETS.md): The basic syntax is: ```powershell -New-MarkdownHelp -Command -OutputFolder " [-Session ] +New-MarkdownHelp -Command -OutputFolder " ``` or ```powershell $x = "","",..."" -New-MarkdownHelp -Command $x -OutputFolder " [-Session ] + +New-MarkdownHelp -Command $x -OutputFolder " ``` -This example create a topic file for the updated cmdlet named **Get-CoolFeature** in the Exchange Online PowerShell session where the session variable is `$Session` in the folder "C:\My Docs\ExO". +This example create a topic file for the updated cmdlet named **Get-CoolFeature** in the Exchange Online PowerShell session in the folder "C:\My Docs\ExO". ```powershell -New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" -Session $Session +New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" ``` -This example creates topic files for the updated cmdlets **Get-CoolFeature**, **New-CoolFeature**, **Remove-CoolFeature**, and **Set-CoolFeature** from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO. +This example creates topic files for the updated cmdlets **Get-CoolFeature**, **New-CoolFeature**, **Remove-CoolFeature**, and **Set-CoolFeature** from the Exchange Online session in the folder C:\My Docs\ExO. The first command stores the cmdlet names in a variable. The second command uses that variable to identify the cmdlets and write the output files. ```powershell $Delta = "Get-CoolFeature","New-CoolFeature","Remove-CoolFeature","Set-CoolFeature" -``` -```powershell -New-MarkdownHelp -Command $Delta -OutputFolder "C:\My Docs\ExO" -Session $Session +New-MarkdownHelp -Command $Delta -OutputFolder "C:\My Docs\ExO" ``` -### Step 6: Document the new parameters +### Step 5: Document the new parameters The resulting topics are plain text UTF-8 files that are formatted using [markdown](https://guides.github.com/features/mastering-markdown/). Office writers use [Visual Studio Code](https://code.visualstudio.com/) to edit topic files, but you can use Notepad or your favorite text editor. @@ -106,63 +106,31 @@ The resulting topics are plain text UTF-8 files that are formatted using [markdo Most of the attributes and values are generated automatically by platyPS. The ones that require manual intervention are: + - **Type**: In any environment, the values `Object` or `Object[]` are wrong. As previously described, REST API connections in the Exchange Online PowerShell V3 module incorrectly identify many parameter **Type** values as `Object` or `Object[]`. Other values like `String`, `Boolean`, and `DateTime` are detected correctly. The true parameter type values are visible in product code. + - **Applicable**: You need to add this attribute and value yourself. Notice the capital 'A'. See other topics for available values (same available values as the **applicable** attribute at the top of the topic). Don't invent new values here. The value **must** come from the list of predefined values. - **Default value** and **Accept wildcard characters**: These attributes are present, but the values are never truthfully populated by platyPS **or any other PowerShell utility** (they're always None and False, respectively). You can correct the values if you think it's important. Otherwise, leave them as is. -### Step 7: Copy your changes into the existing topic on GitHub - -At this point, the steps are basically identical to [Short URL: aka.ms/office-powershell](../README.md): +### Step 6: Copy your changes into the existing topic on GitHub 1. Go to the cmdlet topics location in the appropriate GiHub repository: - Exchange: - - Office Web Apps: - - - SharePoint Online: - - - SharePoint PNP: - - - SharePoint Server: - - Skype: - - StaffHub: - - Teams: - - Whiteboard: -2. Find the topic and click **Edit** +2. Find the existing topic and click **Edit**. 3. Copy/paste your updates (and only your updates) from your new, local copy of the topic into the existing topic (click the **Preview** tab to see what they'll look like). - **IMPORTANT**: The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help. - Any deviation will throw errors in the Pull Request. The schema can be found here: . - -4. After you're done modifying files, go to the **Propose file change** section at the bottom of the page: - - - A brief title is required. By default, the title is the name of the file, but you can change it. - - Optionally, you can enter more details in the **Add an optional extended description** box. - - When you're ready, click the green **Propose file change** button. + > [!IMPORTANT] + > The layout of headings and subheadings must follow a very specific schema that is required for PowerShell Get-Help. Any deviation will throw errors in the Pull Request. The schema can be found here: . - ![Propose file change section.](../images/propose-file-change.png) - -5. On the **Comparing changes** page that appears, click the green **Create pull request** button. - - ![Comparing changes page.](../images/comparing-changes-page.png) - -6. On the **Open a pull request** page that appears, click the green **Create pull request** button. - - ![Open a pull request page.](../images/open-a-pull-request-page.png) - -> [!NOTE] -> -> Your permissions in the repo determine what you see. People with no special privileges will see the **Propose file change** section and subsequent confirmation pages as described. People with permissions to create and approve their own pull requests will see a similar **Commit changes** section with extra options for creating a new branch and fewer confirmation pages. -> -> The point is: click any green buttons that are presented to you until there are no more. +4. At this point, the steps are identical to [Short URL: aka.ms/office-powershell](../README.md) (You're starting at Step 4). ## Remove existing parameters from existing topics diff --git a/sharepoint/docfx.json b/sharepoint/docfx.json deleted file mode 100644 index 6554b5d049..0000000000 --- a/sharepoint/docfx.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "build": { - "content": [ - { - "files": [ - "**/*.md", - "**/**.yml" - ], - "src": "docs-conceptual", - "version": "sharepoint-ps", - "dest": "sharepoint", - "exclude": [ - "**/obj/**", - "**/includes/**", - "README.md", - "LICENSE", - "LICENSE-CODE", - "ThirdPartyNotices" - ] - }, - { - "files": [ - "toc.yml" - ], - "src": "docs-conceptual", - "version": "sharepoint-ps", - "dest": "sharepoint/sharepoint-ps" - }, - { - "files": [ - "**/*.yml" - ], - "exclude": [ - "toc.yml" - ], - "src": "sharepoint-ps", - "version": "sharepoint-ps", - "dest": "module" - }, - { - "files": [ - "toc.yml" - ], - "src": "sharepoint-ps", - "version": "sharepoint-ps", - "dest": "module/sharepoint-ps" - } - ], - "resource": [ - { - "files": [ - "**/*.png", - "**/*.jpg" - ], - "exclude": [ - "**/obj/**", - "**/includes/**" - ] - } - ], - "versions": { - "sharepoint-ps": { - "dest": "sharepoint-ps" - } - }, - "overwrite": [], - "externalReference": [], - "globalMetadata": { - "author": "pamgreen-msft", - "ms.author": "pamgreen", - "manager": "pamgreen", - "ms.date": "11/28/2017", - "ms.topic": "reference", - "products": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/9d7be3ef-f27c-4c7f-9eba-67c3cd429995", - "https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3" - ], - "ms.devlang": "powershell", - "feedback_system": "GitHub", - "feedback_github_repo": "MicrosoftDocs/office-docs-powershell", - "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues" - }, - "fileMetadata": { - "ms.service": { - "sharepoint-ps/sharepoint-online/*.yml": "sharepoint-powershell", - "sharepoint-ps/sharepoint-pnp/*.yml": "sharepoint-powershell" - }, - "ms.prod": { - "sharepoint-ps/sharepoint-server/*.yml": "sharepoint-2016-powershell" - } - }, - "template": [], - "dest": "sharepoint-ps" - } -} \ No newline at end of file diff --git a/sharepoint/docs-conceptual/index.yml b/sharepoint/docs-conceptual/index.yml deleted file mode 100644 index 88d95e6b1f..0000000000 --- a/sharepoint/docs-conceptual/index.yml +++ /dev/null @@ -1,73 +0,0 @@ -### YamlMime:Landing - -title: SharePoint PowerShell # < 60 chars -summary: Learn about using PowerShell cmdlets for SharePoint in Microsoft 365 and SharePoint Server. # < 160 chars - -metadata: - title: SharePoint PowerShell # Required; page title displayed in search results. Include the brand. < 60 chars. - description: Use PowerShell cmdlets for SharePoint in Microsoft 365 and SharePoint Server # Required; article description that is displayed in search results. < 160 chars. - ms.service: sharepoint-online #Required; service per approved list. service slug assigned to your service by ACOM. - ms.subservice: subservice - ms.topic: landing-page # Required - ms.collection: M365-collaboration - author: kaarins #Required; your GitHub user alias, with correct capitalization. - ms.author: kaarins #Required; microsoft alias of author; optional team alias. - ms.date: 03/16/2020 #Required; mm/dd/yyyy format - localization_priority: Priority - -# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new - -landingContent: -# Cards and links should be based on top customer tasks or top subjects -# Start card title with a verb - # Card (optional) - - title: SharePoint in Microsoft 365 - linkLists: - - linkListType: reference - links: - - text: Intro to SharePoint Online Management Shell - url: sharepoint-online/introduction-sharepoint-online-management-shell.md - - text: Get started with SharePoint Online Management Shell - url: sharepoint-online/connect-sharepoint-online.md - - text: Cmdlet reference - url: /powershell/module/sharepoint-online - - text: Manage SharePoint with Office 365 PowerShell - url: /office365/enterprise/powershell/manage-sharepoint-online-with-office-365-powershell - - - # Card - - title: SharePoint Server - linkLists: - - linkListType: reference - links: - - text: Overview - url: /powershell/sharepoint/sharepoint-server/sharepoint-server-cmdlets - - text: Cmdlet reference - url: /powershell/module/sharepoint-server - - # Card - - title: SharePoint Patterns and Practices (PnP) - linkLists: - - linkListType: reference - links: - - text: Overview - url: /powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets - - text: Cmdlet reference - url: /powershell/module/sharepoint-pnp - - text: PowerShell Gallery - url: https://www.powershellgallery.com/ - - # Card - - title: Learning PowerShell - linkLists: - - linkListType: learn - links: - - text: PowerShell documentation - url: /powershell - - text: Overview - url: /powershell/scripting/overview - - text: More resources for learning PowerShell - url: /powershell/scripting/learn/more-powershell-learning - - - \ No newline at end of file diff --git a/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md b/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md deleted file mode 100644 index b3abb36b1a..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-online/connect-sharepoint-online.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: Get started with the SharePoint Online Management Shell -ms.service: sharepoint-powershell -description: "Learn how to connect to SharePoint Online PowerShell." ---- - -# Get started with SharePoint Online Management Shell # - -To get started using PowerShell to manage SharePoint Online, you need to install the SharePoint Online Management Shell and connect to SharePoint Online. - -Install the SharePoint Online Management Shell by downloading and running the [SharePoint Online Management Shell](https://go.microsoft.com/fwlink/p/?LinkId=255251) or installing the module from the [PowerShell Gallery](https://www.powershellgallery.com/packages/Microsoft.Online.SharePoint.PowerShell/). Once installed, the module is available for use, and you do not need to install it again until you need features introduced in a later version. For example, you may need to install a new version for TLS 1.2 negotiation after October 2018. - -First you can check if you have already installed the SharePoint Online Management Shell by running the following command in administrative mode in PowerShell: - -```powershell -Get-Module -Name Microsoft.Online.SharePoint.PowerShell -ListAvailable | Select Name,Version -``` - -> [!NOTE] -> -> - You should always check to see if you have multiple versions of the management shell installed. -> -> - If you find multiple versions installed, please uninstall the lowest version number to ensure you have all the newest commands. -> -> Example: `Uninstall-Module -Name Microsoft.Online.SharePoint.PowerShell -RequiredVersion 16.0.21211.12000` - - -If your operating system is using PowerShell 5 or newer, you can also install the SharePoint Online Management Shell by running the following command in administrative mode: - -```powershell -Install-Module -Name Microsoft.Online.SharePoint.PowerShell -``` - -If you don't have administrative privileges on the system, you can install the SharePoint Online Management Shell only for the current user by running the following command: - -```powershell -Install-Module -Name Microsoft.Online.SharePoint.PowerShell -Scope CurrentUser -``` - -To ensure you have all available cmdlets, you should always make sure the module is up to date. You can update the SharePoint Online Management Shell by running the following command in administrative mode: - -```powershell -Update-Module -Name Microsoft.Online.SharePoint.PowerShell -``` - -To open the SharePoint Online Management Shell command prompt, from the **Start** screen, type **sharepoint**, and then click **SharePoint Online Management Shell**. - -> [!VIDEO https://www.youtube.com/embed/TMzHAWEQjlk] - -## To connect with a user name and password - -1. Run the following command at the SharePoint Online Management Shell command prompt: - - ```powershell - Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential admin@contoso.com - ``` - -2. When prompted with the Windows PowerShell credential request dialog box, type the password for the SharePoint admin account. - -To assign a user the SharePoint admin role, see [Assign admin roles](/microsoft-365/admin/add-users/assign-admin-roles) or [Assign admin roles to Microsoft 365 user accounts with PowerShell](/microsoft-365/enterprise/assign-roles-to-user-accounts-with-microsoft-365-powershell). - -## To connect with multifactor authentication (MFA) - -1. Run the following command at the SharePoint Online Management Shell command prompt: - - ```powershell - Connect-SPOService -Url https://contoso-admin.sharepoint.com - ``` - -2. When prompted with the **Microsoft SharePoint Online Management Shell** dialog box, type the account name and password for a SharePoint administrator account, and then click **Sign in**. - -3. Follow the instructions in the **Microsoft SharePoint Online Management Shell** dialog box to provide the additional authentication information, such as a verification code, and then click **Sign in**. - -You are now ready to use SharePoint Online commands. - -> [!NOTE] -> -> - If you encounter issues trying to connect using MFA, please see [Cannot force Modern Authentication when using Connect-SPOService cmdlet in SharePoint Online Management Shell](/sharepoint/troubleshoot/security/cannot-force-modern-authentication). -> -> - There is a known issue between the SharePoint Online Management Shell module and SharePoint Client Components SDK where the module will fail to load if both are installed on the same computer. If you encounter this issue, uninstall the SharePoint Client Components SDK. -> -> - If you need to specify the region of your SharePoint Online environment, use the -Region parameter, for more information refer to [Connect-SPOService](/powershell/module/sharepoint-online/connect-sposervice) documentation. diff --git a/sharepoint/docs-conceptual/sharepoint-online/introduction-sharepoint-online-management-shell.md b/sharepoint/docs-conceptual/sharepoint-online/introduction-sharepoint-online-management-shell.md deleted file mode 100644 index f525d64776..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-online/introduction-sharepoint-online-management-shell.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Intro to SharePoint Online Management Shell -ms.service: sharepoint-powershell -description: "Learn about the SharePoint Online Management Shell." ---- - -# Intro to SharePoint Online Management Shell - -The SharePoint Online Management Shell is a Windows PowerShell module that you can use to manage SharePoint settings at the organization level and site collection level. Command-line operations in Windows PowerShell are composed of a series of commands. Each command uses a cmdlet and a set of settings known as parameters. For example, you use the **New-SPOSite** cmdlet to create a new site collection with a specified title, URL, owner, storage quota, and template (the parameters). - -SharePoint Online PowerShell commands can be very efficient for batch operations — for example, creating a dozen new site collections or adding hundreds of new users to a site. For more information, see [Why you need to use Office 365 PowerShell](/office365/enterprise/powershell/why-you-need-to-use-office-365-powershell). - -## Getting Started with SharePoint Online PowerShell - -To use SharePoint Online PowerShell commands, you must have the SharePoint Admin role or Global Administrator role in Office 365. - -You must install the SharePoint Online Management Shell module and connect to the SharePoint Online service. For more information, see [Connect SharePoint Online](connect-sharepoint-online.md). - -## What's the difference between SharePoint Online PowerShell commands and Office 365 PowerShell commands? - -The major and obvious difference is the nouns they use. Every SharePoint Online cmdlet will start with SPO as its noun. Conversely, Office 365 will start with MSO as its noun. - -SharePoint Online Management Shell commands manage SharePoint settings and site collections, whereas Office 365 commands manage Office 365-level tasks such as users, licenses, organization information, and services. They both manage users and groups. However, Office 365 PowerShell commands manage users and groups for all of the Office 365 services. The SharePoint Online commands manage users and groups only for SharePoint Online. - -## Should I use the SharePoint admin center or SharePoint Online PowerShell commands? - -If you are new to Office 365 and SharePoint Online and you have not done much managing of SharePoint sites or users, the SharePoint admin center is a good place to start. - -After you get familiar with SharePoint sites and users, try using SharePoint Online PowerShell commands, especially when you want to manage lots of site collections or users. - -> [!NOTE] -> For the complete list of SharePoint Online cmdlets, see [SharePoint Online PowerShell](/powershell/module/sharepoint-online) - -## How do I get permissions and set up the environment? - -To use SharePoint Online PowerShell commands, you must be a SharePoint admin in your organization. For info about installing the SharePoint Online Management Shell module and connecting to the SharePoint Online service, see [Get started with SharePoint Online Management Shell](connect-sharepoint-online.md) diff --git a/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md b/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md deleted file mode 100644 index d016c329e7..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-pnp/sharepoint-pnp-cmdlets.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: PnP PowerShell Overview -ms.service: sharepoint-powershell -description: "SharePoint PnP PowerShell Overview" ---- - - -# PnP PowerShell -PnP PowerShell is a **cross-platform** PowerShell Module providing over 500 cmdlets that work with Microsoft 365 environments and more specifically SharePoint Online, Microsoft Teams, Microsoft Planner and Microsoft Flow. - -> [!NOTE] -> This module is a successor of the [SharePointPnPPowerShellOnline](https://github.com/pnp/pnp-powershell) module, which is now regarded legacy and not maintained anymore. This newer version of the PowerShell module is cross-platform (e.g. it works on Windows, MacOS and Linux) however will only support SharePoint Online. Going forward will only be actively maintaining the cross-platform PnP PowerShell module. - -## Getting up and running - -To install PnP PowerShell: - -```powershell -Install-Module -Name PnP.PowerShell -``` - -To install a nightly build of PnP PowerShell: -```powershell -Install-Module -Name PnP.PowerShell -AllowPrerelease -``` - -See the [authentication](https://pnp.github.io/powershell/articles/authentication.html) page for more information on authentication and configuration. All [cmdlets](https://pnp.github.io/powershell/cmdlets/Add-PnPAlert.html) have been documented too. - -## I've found a bug, where do I need to log an issue or create a PR - -You can create an issue at https://github.com/pnp/powershell/issues, but please consider first if asking a question at https://github.com/pnp/powershell/discussions is more appropriate. We would like to focus the issues on actual bugs whereas PnP PowerShell related questions can be asked in the discussions section. - -> [!NOTE] -> As some of the code being PnP PowerShell is actually coming from other PnP repositories, we can move your issue over to that specific repository. You will be notified by email about that. - -Before you start to work on code change consider starting a discussion in the repository first. It could potentially safe you a lot of time if someone is about to submit a change with exactly the same functionality. It will also allow you to discuss a possible change with the maintainers of the repository before you start to work on it. - -## Building the source code - -Make a clone of the repository, navigate to the build folder in the repository and run Build-Debug.ps1. See more details [here](https://pnp.github.io/powershell/articles/buildingsource.html). - -## Updating the documentation - -All cmdlet documentation has been moved to the https://github.com/pnp/powershell/tree/dev/documentation folder. If you want to make changes, make sure to follow the format as used in the other files present there. These files follow a specific schema which allows us to generate the correct files. - -------- -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. diff --git a/sharepoint/docs-conceptual/sharepoint-server/sharepoint-server-cmdlets.md b/sharepoint/docs-conceptual/sharepoint-server/sharepoint-server-cmdlets.md deleted file mode 100644 index 0e70f5c0b9..0000000000 --- a/sharepoint/docs-conceptual/sharepoint-server/sharepoint-server-cmdlets.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: SharePoint Server Cmdlets -ms.service: sharepoint-powershell ---- - -# SharePoint Server Cmdlets - -For a listing of the SharePoint Server cmdlets, see [SharePoint Server cmdlets](xref:SharePointServer) - -## Accessing PowerShell for SharePoint Server - -After you install SharePoint Server, applicable PowerShell cmdlets are available in the SharePoint 2016 Management Shell. You can manage most aspects of SharePoint Server in the SharePoint Management Shell. You can create new site collections, web applications, user accounts, service applications, proxies, and more. Commands that you type in the SharePoint Management Shell return SharePoint objects that are based on the Microsoft .NET Framework. You can apply these objects as input to subsequent commands or store the objects in local variables for later use. - -With the SharePoint Management Shell, you do not have to register the snap-in that contains the cmdlets. Registration of the Microsoft.SharePoint.PowerShell.dll module for SharePoint Server cmdlets is automatic, as a result of the **Add-PSSnapin Microsoft.SharePoint.PowerShell** line in the SharePoint.ps1 file that is located in %CommonProgramFiles%\Microsoft Shared\Web Server Extensions\\Config\PowerShell\Registration, where version "15" equals SharePoint Server 2013, and version "16" equals SharePoint Server 2016. To use the PowerShell console, you must register this snap-in manually. - -Whether you use the SharePoint Management Shell or the PowerShell console, you can also load additional snap-ins. - -> [!NOTE] -> The SharePoint Management Shell and the PowerShell console also differ in the use of the **ReuseThread** option, which defines how the threading model is used. The SharePoint Management Shell's use is defined by this line, {Host.Runspace.ThreadOptions = "ReuseThread"}, which is in the SharePoint.ps1 file. For more information, see [PS Thread Options](/dotnet/api/system.management.automation.runspaces.psthreadoptions). - -## Permissions - -Before you can use the Add-SPShellAdmin cmdlet to grant permissions for users to run SharePoint Server cmdlets, verify that you meet all of the following minimum requirements: - -* You must have membership in the **securityadmin** fixed server role on the SQL Server instance. -* You must be a member of the Administrators group on the server on which you are running the PowerShell cmdlet. - -> [!NOTE] -> If these permissions are not satisfied, contact your Setup administrator or SQL Server administrator to request these permissions. - -For additional information about PowerShell permissions, see [Add-SPShellAdmin](xref:SharePointServer.Add-SPShellAdmin). - -If you do not have membership in the **SharePoint_Shell_Access** role or **WSS_Admin_WPG** local group, use the **Add-SPShellAdmin** cmdlet to add the **WSS_Admin_WPG** group in all front-end web servers in the SharePoint farm and the **SharePoint_Shell_Access** role. If the SQL Server database does not have a **SharePoint_Shell_Access** role, the role is automatically created when you run the **Add-SPShellAdmin** cmdlet. After you run the **Add-SPShellAdmin** cmdlet, users can run SharePoint PowerShell cmdlets in a multiple-server farm environment. - -> [!NOTE] -> When you install SharePoint Server, the user account from which you run the installation is granted the appropriate permissions to run PowerShell cmdlets. If any users have not been added to run a PowerShell cmdlet, you can use the **Add-SPShellAdmin** cmdlet to add them. - -To see a list of all of the **SPShellAdmin** cmdlets, from a PowerShell command prompt, type _Get-Command -Noun SPShellAdmin_. - -## Scripts and execution policies - -Although you can use Microsoft PowerShell to perform a single administrative task, you can also use a script to automate a series of tasks. A script is a text file that contains one or more Microsoft PowerShell commands. Microsoft PowerShell scripts have a .ps1 file name extension. - -To run scripts, the minimum required execution policy for SharePoint Server is **RemoteSigned**, although the default policy for PowerShell is Restricted. If the policy is left as Restricted, the SharePoint Management Shell will change the policy for PowerShell to RemoteSigned. This means that you must select **Run as administrator** to start the SharePoint Management Shell with elevated administrative permission. This change will apply to all PowerShell sessions. For more information, see [ExecutionPolicy Enumeration](/dotnet/api/microsoft.powershell.executionpolicy). - -For additional information about scripts and execution policies, see [about_scripts](/powershell/module/microsoft.powershell.core/about/about_scripts) and [About Execution Policies](/powershell/module/microsoft.powershell.core/about/about_execution_policies). diff --git a/sharepoint/docs-conceptual/toc.yml b/sharepoint/docs-conceptual/toc.yml deleted file mode 100644 index f65925cf94..0000000000 --- a/sharepoint/docs-conceptual/toc.yml +++ /dev/null @@ -1,13 +0,0 @@ -- name: SharePoint PowerShell - href: index.yml -- name: SharePoint in Microsoft 365 - items: - - name: Intro to SharePoint Online Management Shell - href: sharepoint-online/introduction-sharepoint-online-management-shell.md - - name: Get started with SharePoint Online Management Shell - href: sharepoint-online/connect-sharepoint-online.md -- name: SharePoint PnP - href: sharepoint-pnp/sharepoint-pnp-cmdlets.md -- name: SharePoint Server - href: sharepoint-server/sharepoint-server-cmdlets.md - diff --git a/sharepoint/mapping/monikerMapping.json b/sharepoint/mapping/monikerMapping.json deleted file mode 100644 index f6808a117f..0000000000 --- a/sharepoint/mapping/monikerMapping.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "sharepoint-ps": { - "conceptualToc": "docs-conceptual/toc.yml", - "conceptualTocUrl": "/powershell/sharepoint/sharepoint-ps/toc.json", - "referenceTocUrl": "/powershell/module/sharepoint-ps/toc.json", - "packageRoot": "sharepoint-ps", - "modules": { - "sharepoint-online": {}, - "sharepoint-server": {}, - "sharepoint-pnp": {} - } - } -} \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md deleted file mode 100644 index 6b0c086f83..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOGeoAdministrator.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spogeoadministrator -applicable: SharePoint Online -title: Add-SPOGeoAdministrator -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Add-SPOGeoAdministrator - -## SYNOPSIS - -Adds a new SharePoint user or security group as GeoAdministrator to a multi-geo tenant. - -## SYNTAX - -### User (Default) -``` -Add-SPOGeoAdministrator [-UserPrincipalName] [] -``` - -### Group -``` -Add-SPOGeoAdministrator [-GroupAlias] [] -``` - -### ObjectId -``` -Add-SPOGeoAdministrator [-ObjectId] [] -``` - -## DESCRIPTION - -This cmdlet requires a connection to a multi-geo tenant to run correctly. -You must be a SharePoint Online administrator or Global Administrator to run this cmdlet. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Add-SPOGeoAdministrator -UserPrincipalName admin@contoso.onmicrosoft.com -``` - -Adds the user **admin\@contoso.onmicrosoft.com** as administrator to the SharePoint Online multi-geo tenant. - -## PARAMETERS - -### -GroupAlias - -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 -Parameter Sets: Group -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -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://docs.microsoft.com/office365/enterprise/add-a-sharepoint-geo-admin). - -```yaml -Type: Guid -Parameter Sets: ObjectId -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName - -UserPrincipalName or UPN defined for the specific user on the SharePoint Online tenant. - -```yaml -Type: String -Parameter Sets: User -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/p/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md) - -[Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md deleted file mode 100644 index 6ca5580b35..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubSiteAssociation.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spohubsiteassociation -applicable: SharePoint Online -title: Add-SPOHubSiteAssociation -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Add-SPOHubSiteAssociation - -## SYNOPSIS - -Associates a site with a hub site. - -## SYNTAX - -```powershell -Add-SPOHubSiteAssociation [-Site] -HubSite [] -``` - -## DESCRIPTION - -Use this cmdlet to associate a site with a hub site. - -## EXAMPLES - -### Example 1 - -```powershell -Add-SPOHubSiteAssociation https://contoso.sharepoint.com/sites/Research -HubSite https://contoso.sharepoint.com/sites/Marketing -``` - -This example associates the research site with the marketing hub site. - -## PARAMETERS - -### -Site - -URL of the site to join to the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -HubSite - -URL of the hub site. - -```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/p/?LinkID=113216). - -## NOTES - -If the site or hub 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. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubToHubAssociation.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubToHubAssociation.md deleted file mode 100644 index c12f434874..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOHubToHubAssociation.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spohubtohubassociation -applicable: SharePoint Online -title: Add-SPOHubToHubAssociation -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Add-SPOHubToHubAssociation - -## SYNOPSIS - -Associates a hub site to a hub site. -Note: This feature is currently in preview and may not be available in your tenant. - -## SYNTAX - -```powershell -Add-SPOHubToHubAssociation [-Source] -Target [] -``` - -## DESCRIPTION - -Use this cmdlet to associate a hub site to a hub site. - -## EXAMPLES - -### Example 1 - -```powershell -Add-SPOHubToHubAssociation -Source 7b6fd3a3-b029-4eb0-8e00-ba4a3949807d -Target 43a36572-37ec-45c3-9058-061a2db4cd26 -``` - -This example associates the source hub site with the HubSiteId 7b6fd3a3-b029-4eb0-8e00-ba4a3949807d with the target hub site with the HubSiteId 43a36572-37ec-45c3-9058-061a2db4cd26. - -## PARAMETERS - -### -Source - -HubSiteId of the Source Hub site to be associated with the Target Hub Site. - -```yaml -Type: SpoHubSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Target - -HubSiteId of the Target Hub to associate the source Hub to. - -```yaml -Type: SpoHubSitePipeBind -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/p/?LinkID=113216). - -## NOTES -SPOHubToHubAssociation is just a placeholder and not yet ready for production. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOOrgAssetsLibrary.md deleted file mode 100644 index 3352683156..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOOrgAssetsLibrary.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spoorgassetslibrary -applicable: SharePoint Online -title: Add-SPOOrgAssetsLibrary -author: Maralesfahanpoor -ms.author: maesfaha -ms.reviewer: -manager: paulac -schema: 2.0.0 ---- - -# Add-SPOOrgAssetsLibrary - -## SYNOPSIS - -Designates a library to be used as a central location for organization assets across the tenant. - -## SYNTAX - -```powershell -Add-SPOOrgAssetsLibrary -LibraryUrl [-ThumbnailUrl ] [-OrgAssetType ] [-CdnType ] [] -``` - -## DESCRIPTION - -The Add-SPOOrgAssetsLibrary cmdlet designates a library to be a central location for organization assets across the tenant. Once this cmdlet is run, assets stored within this library are available to sites across the tenant. The name publicly displayed for the library will be the name of the library on the SharePoint site. Note that it may take from a couple of hours to a day for changes to be reflected. - -## EXAMPLES - -### Example 1 - -This example adds https://contoso.sharepoint.com/sites/branding/Assets as a designated library for organization assets. Assets is the name of the SharePoint library added and will be the name publicly displayed for the library. The thumbnail publicly displayed for the library is contosologo.jpg, from that same library. - -```powershell -Add-SPOOrgAssetsLibrary -LibraryURL https://contoso.sharepoint.com/sites/branding/Assets -ThumbnailURL https://contoso.sharepoint.com/sites/branding/Assets/contosologo.jpg -``` -### Example 2 - -This example adds https://contoso.sharepoint.com/sites/branding/Templates as a designated library for organization assets. Templates is the name of the SharePoint library added and will be the name publicly displayed for the library. The thumbnail publicly displayed for the library is contosologo.jpg, from that same library. OrgAssetType is the type of SharePoint library. - -```powershell -Add-SPOOrgAssetsLibrary -LibraryURL https://contoso.sharepoint.com/sites/branding/Templates -ThumbnailURL https://contoso.sharepoint.com/sites/branding/Templates/contosologo.jpg -OrgAssetType OfficeTemplateLibrary -``` - -## PARAMETERS - -### -CdnType - -Specifies the CDN type. The valid values are public or private. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Accepted values: Public, Private - -Required: False -Position: Named -Default value: Private -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -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". - -ImageDocumentLibrary is the default OrgAssetType and is best used for images. You can access the contents of this library from any site or page in the SharePoint filepicker. -OfficeTemplateLibrary is the suggested type for Office files and will show up in the UI of all Office desktop apps and Office online in the templates section. - -In order to benefit from both UIs you can choose "ImageDocumentLibrary,OfficeTemplateLibrary" as OrgAssetType. - -```yaml -Type: OrgAssetType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Accepted values: ImageDocumentLibrary, OfficeTemplateLibrary - -Required: False -Position: Named -Default value: ImageDocumentLibrary -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThumbnailUrl - -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 -Parameter Sets: (All) -Aliases: -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/p/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/get-spoorgassetslibrary?view=sharepoint-ps) - -[Set-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/set-spoorgassetslibrary?view=sharepoint-ps) - -[Remove-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spoorgassetslibrary?view=sharepoint-ps) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteCollectionAppCatalog.md deleted file mode 100644 index 08e3b24a93..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteCollectionAppCatalog.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spositecollectionappcatalog -applicable: SharePoint Online -title: Add-SPOSiteCollectionAppCatalog -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Add-SPOSiteCollectionAppCatalog - -## SYNOPSIS - -Adds a Site Collection scoped App Catalog to a site. - -## SYNTAX - -```powershell -Add-SPOSiteCollectionAppCatalog -Site [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Use this cmdlet to add a site collection scoped app catalog to the specified site. To run this cmdlet user must have the following roles: -* SharePoint Admin role or Global Administrator role -* Site Collection Administrator of the tenant app catalog -* Site Collection Administrator of the site collection of the site specified in the `-Site` parameter - -## EXAMPLES - -### Example 1 - -```powershell -Add-SPOSiteCollectionAppCatalog -Site "https://contoso.sharepoint.com/sites/FinanceTeamsite" -``` - -This example adds a SiteCollection app catalog to the specified site. - -## PARAMETERS - -### -Site - -Url of the site to add the app catalog 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 -``` - -### -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 -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). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md deleted file mode 100644 index ce642df0c2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spositedesign -applicable: SharePoint Online -title: Add-SPOSiteDesign -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Add-SPOSiteDesign - -## SYNOPSIS - -Creates a new site design available to users when they create a new site from the SharePoint home page. - -## SYNTAX - -```powershell -Add-SPOSiteDesign - -Title - -WebTemplate - -SiteScripts - [-Description ] - [-ThumbnailUrl ] - [-PreviewImageUrl ] - [-PreviewImageAltText ] - [-IsDefault] - [] -``` - -## DESCRIPTION - -Creates a new site design available to users when they create a new site from the SharePoint home page. - -## EXAMPLES - -### Example 1 - -This example creates a new site design. - -```powershell -Add-SPOSiteDesign ` - -Title "Contoso customer tracking" ` - -WebTemplate "64" ` - -SiteScripts "" ` - -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" -``` - -## PARAMETERS - -### -Title - -The display name of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebTemplate - -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://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-overview). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteScripts - -An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. - -```yaml -Type: SPOSiteScriptPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -The display description of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThumbnailUrl - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewImageUrl - -The URL of a preview image. If none is specified, SharePoint uses a generic image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewImageAltText - -The alt text description of the image for accessibility. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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](https://docs.microsoft.com/sharepoint/dev/declarative-customization/customize-default-site-design). - -```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 -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md deleted file mode 100644 index 0cb1095c39..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesignTask.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spositedesigntask -applicable: SharePoint Online -title: Add-SPOSiteDesignTask -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Add-SPOSiteDesignTask - -## SYNOPSIS - -Similar to Invoke-SPOSiteDesign, this command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-SPOSiteDesign is limited to 30 actions and subactions). - -The supported site templates you can apply a site design to include: "modern" team site (with O365 group), "modern" team site (without an O365 group); communication site; classic team site; and classic publishing site. - -## SYNTAX - -```powershell -Add-SPOSiteDesignTask -SiteDesignId -WebUrl [] -``` - -## DESCRIPTION - -This command is used to apply a published site design to a specified site collection target. It schedules the operation, allowing for the application of larger site scripts (Invoke-SPOSiteDesign is limited to 30 actions and subactions). - -This command is intended to replace Invoke-SPOSiteDesign and is useful when you need to apply a large number of actions or multiple site scripts. - -> [!NOTE] -> This command only creates the request. To check on the job status or to view details of the scheduled run, use the commands in the related section below. - -## EXAMPLES - -### Example 1 - -This example applies a site design that includes two site scripts - totaling over 30 site script actions. Executing the commands will schedule the site design to be queued and run against the designated site collection. - -```powershell -Add-SPOSiteDesignTask -SiteDesignId 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectawesome" -``` - -## PARAMETERS - -### -SiteDesignId - -The ID of the site design to apply. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebUrl - -The URL of the site collection where the site design will be applied. - -```yaml -Type: String -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/p/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-SPOSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositedesigntask?view=sharepoint-ps) - -[Invoke-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/invoke-spositedesign?view=sharepoint-ps) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md deleted file mode 100644 index 5f41477ad5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spositescript -applicable: SharePoint Online -title: Add-SPOSiteScript -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Add-SPOSiteScript - -## SYNOPSIS - -Uploads a new site script for use either directly or in a site design. - -## SYNTAX - -```powershell -Add-SPOSiteScript -Title -Content [-Description ] [] -``` - -## DESCRIPTION - -Uploads a new site script for use either directly or in a site design. - -## EXAMPLES - -### Example 1 - -This example adds a new site logo from the following script in a file. - -```json -{ - "$schema": "schema.json", - "actions": [ - { - "verb": "setSiteLogo", - "url": "https://contoso.sharepoint.com/SiteAssets/company-logo.png" - } - ] -} -``` - -```powershell -Get-Content 'c:\scripts\site-script.json' -Raw | Add-SPOSiteScript -Title "Customer logo" -Description "Applies customer logo for customer sites" -``` - -### Example 2 - -This example sets the external sharing capabilities of the site to the ExternalUserAndGuestSharing option. We also add a site design for a Communication site (68) which uses this script. - -```powershell -$script = @' -{ - "$schema": "schema.json", - "actions": [ - { - "verb": "setSiteExternalSharingCapability", - "capability": "ExternalUserAndGuestSharing" - } - ], - "bindata": { }, - "version": 1 - }; -'@ - -Add-SPOSiteScript -Title "External User and Guest Sharing site script" -Description "A site script to manage the -guest access of a site" -Content $script -``` - -```powershell -Id : ea9e3a52-7c12-4da8-a901-4912be8a76bc -Title : External User and Guest Sharing site script -Description : A site script to manage theguest access of a site -Content : -Version : 0 -``` - -```powershell -Add-SPOSiteDesign -Title "Communication Site with External Users and Guest Sharing" -WebTemplate "68" -SiteScripts "ea9e3a52-7c12-4da8-a901-4912be8a76bc" -``` - -## PARAMETERS - -### -Title - -The display name of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Content - -The JSON value that describes the script. For more information, see the [JSON reference](https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -A description of the script. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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/p/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md deleted file mode 100644 index 03e1a89bdf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTenantCdnOrigin.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spotenantcdnorigin -applicable: SharePoint Online -title: Add-SPOTenantCdnOrigin -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Add-SPOTenantCdnOrigin - -## SYNOPSIS - -Configures a new origin to public or private content delivery network (CDN). Requires Tenant administrator permissions. - -## SYNTAX - -```powershell -Add-SPOTenantCdnOrigin -CdnType [-Confirm] -OriginUrl [-WhatIf] [] -``` - -## DESCRIPTION - -Configures a new origin to public or private CDN, on either Tenant level or on a single Site level. Effectively, a tenant admin points out to a document library, or a folder in the document library and requests that content in that library should be retrievable by using a CDN. - -You must have the SharePoint Admin role or Global Administrator role and be a site collection administrator to run the cmdlet. - -## EXAMPLES - -### Example 1 - -``` -Add-SPOTenantCdnOrigin -CdnType public -OriginUrl /sites/site/subfolder -``` - -This example configures a public CDN on a site level. - -## PARAMETERS - -### -CdnType - -Specifies the CDN type. The valid values are: public or private. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online - -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: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online -Required: False -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 within a document library. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -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 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]( - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md deleted file mode 100644 index 4d32148df6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOTheme.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spotheme -applicable: SharePoint Online -title: Add-SPOTheme -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Add-SPOTheme - -## SYNOPSIS - -Creates a new custom theme, or overwrites an existing theme to modify its settings. - -## SYNTAX - -```powershell -Add-SPOTheme -Identity -IsInverted -Overwrite -Palette [] -``` - -## DESCRIPTION - -The **Add-SPOTheme** cmdlet creates a new theme or updates an existing theme. The color palette settings can be passed as either a hash table or a dictionary. - -Adding a theme does not apply the theme to any sites. It adds the theme to your tenant store, and then the theme is available in the list of themes under the **Change the look** option for modern pages. - -## EXAMPLES - -### Example 1 - -In this example, a new theme named `"Custom Cyan"` is created, with color palette settings that are various shades of cyan. Note that the settings are passed as a hash table. - -```powershell -$themepalette = @{ - "themePrimary" = "#00ffff"; - "themeLighterAlt" = "#f3fcfc"; - "themeLighter" = "#daffff"; - "themeLight" = "#affefe"; - "themeTertiary" = "#76ffff"; - "themeSecondary" = "#39ffff"; - "themeDarkAlt" = "#00c4c4"; - "themeDark" = "#009090"; - "themeDarker" = "#005252"; - "neutralLighterAlt" = "#f8f8f8"; - "neutralLighter" = "#f4f4f4"; - "neutralLight" = "#eaeaea"; - "neutralQuaternaryAlt" = "#dadada"; - "neutralQuaternary" = "#d0d0d0"; - "neutralTertiaryAlt" = "#c8c8c8"; - "neutralTertiary" = "#a6a6a6"; - "neutralSecondaryAlt" = "#767676"; - "neutralSecondary" = "#666666"; - "neutralPrimary" = "#333"; - "neutralPrimaryAlt" = "#3c3c3c"; - "neutralDark" = "#212121"; - "black" = "#000000"; - "white" = "#fff"; - "primaryBackground" = "#fff"; - "primaryText" = "#333" - } - -Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false -``` - -> [!NOTE] -> Prior to the December 2017 release of the SPO Management Shell, the **Add-SPOTheme** cmdlet required that color palette settings be passed as a dictionary. We recommend that you use the latest version of the SPO Management Shell, or use the `HashToDictionary` function to convert a hash table to a dictionary if needed. - -### Example 2 - -If you want to update an existing theme (to modify some of its color settings, for example), use the same syntax as shown previously, but add the `-Overwrite` flag to the **Add-SPOTheme** cmdlet. - -```powershell -Add-SPOTheme -Identity "Custom Cyan" -Palette $themepalette -IsInverted $false -Overwrite -``` - -## PARAMETERS - -### -Identity - -Specifies the name of the theme. This must uniquely identify the theme. - -```yaml -Type: SpoThemePalettePipeBind -Parameter Sets: (All) -Aliases: Name -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsInverted - -Specifies whether the theme is inverted, with a dark background and a light foreground. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: None -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite - -Overwrites a theme of the same name in case it exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: None -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Palette - -Specifies the palette of colors in the theme, as a dictionary of theme slot values. - -```yaml -Type: SpoThemePalettePipeBind -Parameter Sets: (All) -Aliases: None -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md deleted file mode 100644 index 94fef75928..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOUser.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/add-spouser -applicable: SharePoint Online -title: Add-SPOUser -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Add-SPOUser - -## SYNOPSIS - -Adds an existing Office 365 user or an Office 365 security group to a SharePoint group. - -## SYNTAX - -```powershell -Add-SPOUser -Group -LoginName -Site [] -``` - -## DESCRIPTION - -Along with the group memberships that are normally required to run Windows PowerShell, you must have the SharePoint Admin role or Global Administrator 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -Add-SPOUser -Site https://contoso.sharepoint.com/sites/sc1 -LoginName joe.healy@contoso.com -Group "SC1 Owners" -``` - -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 -------------------- - -```powershell -Add-SPOUser -Site https://contoso.sharepoint.com -LoginName melissa.kerr@contoso.com -Group "Team Site Members" -``` - -Example 2 adds a user who has the e-mail address melissa.kerr@contoso.com to the group "Team Site Members" in the site collection - -## PARAMETERS - -### -Group - -Specifies the name of the SharePoint group to add the user or the security group to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginName - -Specifies the login name of the user to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the URL of the site collection to which you want to add the user. - -```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). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - [Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[New-SPOSiteGroup](New-SPOSiteGroup.md) - -[Get-SPOUser](Get-SPOUser.md) - -[Set-SPOUser](Set-SPOUser.md) - -[Remove-SPOUser](Remove-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md b/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md deleted file mode 100644 index 3fcdbdbcd4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionGrant.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/approve-spotenantserviceprincipalpermissiongrant -applicable: SharePoint Online -title: Approve-SPOTenantServicePrincipalPermissionGrant -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Approve-SPOTenantServicePrincipalPermissionGrant - -## SYNOPSIS - -Approves a permission request for the current tenant's "SharePoint Online Client" service principal. - -## SYNTAX - -### Default - -```powershell -Approve-SPOTenantServicePrincipalPermissionGrant -Resource -Scope -``` - -## DESCRIPTION - -Adds a permission for the current tenant's "SharePoint Online Client" service principal. Can be used to add needed permissions to the service principal without specifically requesting them in the SharePoint Framework solution file (sppkg). - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell - Approve-SPOTenantServicePrincipalPermissionGrant -Resource "Microsoft Graph" -Scope "Mail.Read" -``` - -Adds a permission scope for the 'Microsoft Graph' resource with scope claim 'Mail.Read'. - -## PARAMETERS - -### -Resource - -Resource of the permission request to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope - -Scope of the permission request to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md deleted file mode 100644 index c0bb11d783..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Approve-SPOTenantServicePrincipalPermissionRequest.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/approve-spotenantserviceprincipalpermissionrequest -applicable: SharePoint Online -title: Approve-SPOTenantServicePrincipalPermissionRequest -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Approve-SPOTenantServicePrincipalPermissionRequest - -## SYNOPSIS - -Approves a permission request for the current tenant's "SharePoint Online Client" service principal - -## SYNTAX - -### Default - -```powershell -Approve-SPOTenantServicePrincipalPermissionRequest -RequestId -``` - -## 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://docs.microsoft.com/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://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantserviceprincipalpermissiongrants) command. - -Approving a permission request also removes that request from the list of permission requests. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell -$requests = Get-SPOTenantServicePrincipalPermissionRequests -$requestToApprove = $requests | ? { $_.Resource -eq 'Office 365 SharePoint Online' -and $_.Scope -eq 'MyFiles.Read' } | Select-Object -First 1 - -if ($requestToApprove -ne $null) -{ - Approve-SPOTenantServicePrincipalPermissionRequest -RequestId $requestToApprove.Id -} -``` - -Approves the permission request for the 'Office 365 SharePoint Online' resource with scope claim 'MyFiles.Read'. -If there is no request with those properties, then no approve action will be taken. - -## PARAMETERS - -### -RequestId - -The ID of the permission request to approve - -```yaml -Type: Guid - -Required: True -Position: Named -Accept pipeline input: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md b/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md deleted file mode 100644 index 56a919412f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Connect-SPOService.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/connect-sposervice -applicable: SharePoint Online -title: Connect-SPOService -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Connect-SPOService - -## SYNOPSIS - -Connects a SharePoint Online administrator or Global Administrator to a SharePoint Online connection (the SharePoint Online Administration Center). -This cmdlet must be run before any other SharePoint Online cmdlets can run. - -## SYNTAX - -### AuthenticationUrl - -```powershell -Connect-SPOService -AuthenticationUrl [-ClientTag ] [-Credential ] - -Url [] -``` - -### AuthenticationLocation - -```powershell -Connect-SPOService [-ClientTag ] [-Credential ] - [-Region ] -Url [] -``` - -## DESCRIPTION - -The `Connect-SPOService` cmdlet connects a SharePoint Online administrator or Global Administrator to the SharePoint Online Administration Center. - -Only a single SharePoint Online service connection is maintained from any single Windows PowerShell session. -In other words, this is a per-organization administrator connection. -Running the `Connect-SPOService` cmdlet twice implicitly disconnects the previous connection. -The Windows PowerShell session will be set to serve the new SharePoint Online administrator specified. - -A delegated partner administrator has to swap connections for different organizations within the same Windows PowerShell session. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Connect-SPOService -Url https://contoso-admin.sharepoint.com -credential admin@contoso.com -``` - -Example 1 shows how a SharePoint Online administrator or Global Administrator with credential admin@contoso.com connects to a SharePoint Online Administration Center that has the URL - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -$username = "admin@contoso.sharepoint.com" -$password = "password" -$cred = New-Object -TypeName System.Management.Automation.PSCredential -argumentlist $userName, $(convertto-securestring $Password -asplaintext -force) -Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential $cred -``` - -Example 2 shows how a SharePoint Online administrator or Global Administrator with a username and password connects to a SharePoint Online Administration Center that has the URL - -### -----------------------EXAMPLE 3----------------------------- - -```powershell -Connect-SPOService -Url https://contoso-admin.sharepoint.com -``` - -Prompts for credentials. This is required if the account is using multi-factor authentication. - -## PARAMETERS - -### -AuthenticationUrl - -Location for AAD Cross-Tenant Authentication service. Can be optionally used if non-default Cross-Tenant Authentication Service is used. - -```yaml -Type: String -Parameter Sets: AuthenticationUrl -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientTag - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential - -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 or Global Administrator who can access the SharePoint Online Administration Center site. - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Region - -The valid values are: Default | ITAR | Germany | China - -The default value is "default". - -> [!NOTE] -> The ITAR value is for United States Government cloud tenancies only. - -```yaml -Type: AADCrossTenantAuthenticationLocation -Parameter Sets: AuthenticationLocation -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url - -Specifies the URL of the SharePoint Online Administration Center site. - -```yaml -Type: UrlCmdletPipeBind -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 - -## 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Disconnect-SPOService](Disconnect-SPOService.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md b/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md deleted file mode 100644 index a07b3a1792..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationEncryptedPackage.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/convertto-spomigrationencryptedpackage -applicable: SharePoint Online -title: ConvertTo-SPOMigrationEncryptedPackage -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# ConvertTo-SPOMigrationEncryptedPackage - -## SYNOPSIS - -Use this Cmdlet to convert your XML files into a new encrypted migration package. - -## SYNTAX - -### ImplicitSourceParameterSet - -```powershell -ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters -MigrationSourceLocations [-NoLogFile] -TargetFilesPath -TargetPackagePath [] -``` - -### ExplicitSourceParameterSet - -```powershell -ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters [-NoLogFile] - -SourceFilesPath -SourcePackagePath -TargetFilesPath -TargetPackagePath - [] -``` - -## DESCRIPTION - -This command convert the XML file on your temporary XML folder files into a new set of targeted migration encrypted metadata files to the target directory. - -## EXAMPLES - -### Example 1 - -```powershell -ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters SHA256 -MigrationSourceLocations $MigrationPackageLocation -NoLogFile -TargetFilesPath $TargetFilesPath -TargetPackagePath $TargetPackagePath -``` - -Changes a migration package to a migration encrypted package on the "migrationSourceLocations" , with log file on the current tenant - -### Example 2 - -```powershell -ConvertTo-SPOMigrationEncryptedPackage -EncryptionParameters SHA384 -MigrationSourceLocations $MigrationPackageLocation -TargetFilesPath $TargetFilesPath -TargetPackagePath $TargetPackagePath -``` - -Same as example1 but without log file and using an encryption type SHA384 - -## PARAMETERS - -### -EncryptionParameters - -Parameters of the encryption, it doesn't accept wildcard characters. -It accepts parameters like SHA384, SHA256, etc. - -```yaml -Type: EncryptionParameters -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationSourceLocations - -Possible Source locations to migrate - -```yaml -Type: MigrationPackageLocation -Parameter Sets: ImplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile - -Switch Parameter to determine if you should get or not a log file. - -```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 -``` - -### -SourceFilesPath - -Defines the temporary Path where are located the XML source files. - -```yaml -Type: String -Parameter Sets: ExplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePackagePath - -Defines the source package path location. - -```yaml -Type: String -Parameter Sets: ExplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFilesPath - -Defines the temporary Path where are located the XML source files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPackagePath - -Defines the source package path location of the package to be encrypted. - -```yaml -Type: String -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[ConvertTo-SPOMigrationTargetedPackage](ConvertTo-SPOMigrationTargetedPackage.md) -[Migrate to SharePoint Online using PowerShell](https://docs.microsoft.com/sharepointmigration/overview-spmt-ps-cmdlets) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md b/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md deleted file mode 100644 index 6184aef713..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/convertto-spomigrationtargetedpackage -applicable: SharePoint Online -title: ConvertTo-SPOMigrationTargetedPackage -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# ConvertTo-SPOMigrationTargetedPackage - -## SYNOPSIS - -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 ] [] -``` - -### ListImport - -```powershell -ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] [-SourcePackagePath] [[-OutputPackagePath] ] [-TargetWebUrl] [-AzureADUserCredentials ] -Credentials [-NoAzureADLookup] [-NoLogFile] [-ParallelImport] [-PartitionSizeInBytes ] [-TargetEnvironment ] -TargetListPath [-UserMappingFile ] [] -``` - -## DESCRIPTION -Use this cmdlet to create a migration package from one Library to Another Library in form of a package. It converts the XML files and saves them as a new set of targeted migration package metadata files to the target directory. - -## EXAMPLES - -### Example 1 - -This example shows how to convert a package to a targeted one by looking up data in the target site collection. It uses the '-ParallelImport' parameter to boost file share migration performance. -```Powershell -$finalPackages = ConvertTo-SPOMigrationTargetedPackage -ParallelImport -SourceFilesPath $sourceFiles -SourcePackagePath $sourcePackage -OutputPackagePath $targetPackage -Credentials $cred -TargetWebUrl $targetWeb -TargetDocumentLibraryPath $targetDocLib -``` - -## PARAMETERS - -### -AzureADUserCredentials - -Receives Azure Active Directory User Credentials - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials - -Fill out the Regular Credentials (Get-Credential) - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoAzureADLookup - -Switch parameter that says if the command should or should not look up for Azure AD. - -```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 -``` - -### -NoLogFile - -Switch Parameter to determine if you should get or not a log file. - -```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 -``` - -### -OutputPackagePath - -Output package path - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParallelImport - -Switch parameter to boost file share migration performance. - -```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 -``` - -### -PartitionSizeInBytes - -Define the partition size in Bytes where it will be located the target package. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFilesPath - -Defines the temporary Path where are located the XML source files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePackagePath - -Defines the source package path location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDocumentLibraryPath - -Defines the target document library path. - -```yaml -Type: String -Parameter Sets: DocumentLibraryImport -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDocumentLibrarySubFolderPath - -Defines the target document library subfolder path. - -```yaml -Type: String -Parameter Sets: DocumentLibraryImport -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetEnvironment - -Defines the Target environment: Production, ProductionChina, None or OnPremises. - -```yaml -Type: TargetEnvironment -Parameter Sets: (All) -Aliases: -Accepted values: Production, ProductionChina, None, OnPremises -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetListPath - -Defines the Target list path - -```yaml -Type: String -Parameter Sets: ListImport -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl - -Defines the Target Web URL of the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserMappingFile - -Defines the file mapping of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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). - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[ConvertTo-SPOMigrationEncryptedPackage](ConvertTo-SPOMigrationEncryptedPackage.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md b/sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md deleted file mode 100644 index 1441221afa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Deny-SPOTenantServicePrincipalPermissionRequest.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/deny-spotenantserviceprincipalpermissionrequest -applicable: SharePoint Online -title: Deny-SPOTenantServicePrincipalPermissionRequest -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Deny-SPOTenantServicePrincipalPermissionRequest - -## SYNOPSIS - -Denies a permission request for the current tenant's "SharePoint Online Client" service principal - -## SYNTAX - -### Default - -```powershell -Deny-SPOTenantServicePrincipalPermissionRequest -RequestId -``` - -## DESCRIPTION - -Denies a permission request for the current tenant's "SharePoint Online Client" service principal - -Denying a permission request removes that request from the list of permission requests. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell -$requests = Get-SPOTenantServicePrincipalPermissionRequests -$requestToDeny = $requests | ? { $_.Resource -eq 'Office 365 SharePoint Online' -and $_.Scope -eq 'MyFiles.Read' } | Select-Object -First 1 - -if ($requestToDeny -ne $null) -{ - Deny-SPOTenantServicePrincipalPermissionRequest -RequestId $requestToDeny.Id -} -``` - -Denies the permission request for the 'Office 365 SharePoint Online' resource with scope claim 'MyFiles.Read'. -If there is no request with those properties, then no deny action will be taken. - -## PARAMETERS - -### -RequestId - -The ID of the permission request to deny - -```yaml -Type: Guid - -Required: True -Position: Named -Accept pipeline input: False -``` 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 d25e6df374..0000000000 --- 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://docs.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/Disconnect-SPOService.md b/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOService.md deleted file mode 100644 index f0da130992..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Disconnect-SPOService.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/disconnect-sposervice -applicable: SharePoint Online -title: Disconnect-SPOService -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Disconnect-SPOService - -## SYNOPSIS - -Disconnects from a SharePoint Online service. - -## SYNTAX - -```powershell -Disconnect-SPOService [] -``` - -## DESCRIPTION - -The `Disconnect-SPOService` cmdlet explicitly disconnects a previously created SharePoint Online service connection. - -Global administrators can disconnect the service by running the `Disconnect-SPOService` cmdlet or by running the `Connect-SPOService` cmdlet to initiate another connection. -For more information, see `Connect-SPOService`. - -Even after a connection is terminated, operations that were started before the connection is terminated will run to completion. -In other words, long-running operations will not be terminated by running the `Disconnect-SPOService` cmdlet or the `Connect-SPOService` cmdlet. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -Disconnect-SPOService -``` - -This example disconnects the service for the tenant. - -## 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Connect-SPOService](Connect-SPOService.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOCommSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOCommSite.md deleted file mode 100644 index 981228c27f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOCommSite.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/enable-spocommsite -applicable: SharePoint Online -title: Enable-SPOCommSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Enable-SPOCommSite - -## SYNOPSIS - -Enables the communication site experience on an existing classic team site. Please read instructions in [modernize classic team site](https://docs.microsoft.com/en-us/sharepoint/modernize-classic-team-site) before attempting to execute this cmdlet. - -## SYNTAX - -```powershell -Enable-SPOCommSite [-SiteUrl] [-DesignPackageId] -``` - -## DESCRIPTION - -Use this cmdlet to enable the modern communication site experience in classic team sites. You must use the SharePoint admin powershell version 20122.1200 or greater. Use of this cmdlet is subject to rollout of capability. - -## EXAMPLES - -### Example 1 - -```powershell -Enable-SPOCommSite -SiteUrl https://contoso.sharepoint.com -``` - -This example enables the communication site experience at this site. - -### Example 2 - -```powershell -$orgName="" -$SiteURL = "" -Connect-SPOService -Url https://$orgName-admin.sharepoint.com -Enable-SPOCommSite -SiteUrl $SiteURL -``` - -**TROUBLESHOOTING** - -**Error case 1: Wrong credentials** - -If the SharePoint admin user credentials is wrong or invalid, you will see this error: - ->*Connect-SPOService : The sign-in name or password does not match one in the Microsoft account system.* - -**Error case 2: Feature is not yet enabled for your tenant** - -The use of this cmdlet is subject to the feature rollout. If the feature is not yet available for your tenant, the cmdlet will not execute and will show this error: - ->*Enable-SPOCommSite : The requested operation is part of an experimental feature that is not supported in the current environment.* - -**Error case 3: Site URL input is invalid** - -If the site URL input points to a site that does not exist, you will see the following error message: - ->*Enable-SPOCommSite : File Not Found.* - -**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://docs.microsoft.com/sharepoint/modernize-classic-team-site). - ->*Enable-SPOCommSite : The operation cannot be performed because the Publishing feature is enabled on the site.* - -## PARAMETERS - -### -SiteUrl - -URL of the site for enabling the modern communication site experience. **This is a required parameter** - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -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: - -1. Topic: 96c933ac-3698-44c7-9f4a-5fd17d71af9e -2. Showcase: 6142d2a0-63a5-4ba0-aede-d9fefca2c767 -3. Blank: f6cc5403-0d63-442e-96c0-285923709ffc - -```yaml -Type: GUID -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: 96c933ac-3698-44c7-9f4a-5fd17d71af9e -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). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md b/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md deleted file mode 100644 index e5ec4a7ac7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/enable-spotenantserviceprincipal -applicable: SharePoint Online -title: Enable-SPOTenantServicePrincipal -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Enable-SPOTenantServicePrincipal - -## SYNOPSIS - -Enables the current tenant's "SharePoint Online Client" service principal. - -## SYNTAX - -```powershell -Enable-SPOTenantServicePrincipal [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Enables the current tenant's "SharePoint Online Client" service principal. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell -Enable-SPOTenantServicePrincipal -``` - -Enables the current tenant's "SharePoint Online Client" service principal. - -## 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 -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: 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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md b/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md deleted file mode 100644 index 4ffe139d41..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOQueryLogs.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -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/export-spoquerylogs -applicable: SharePoint Online -title: Export-SPOQueryLogs -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - - -# Export-SPOQueryLogs - -## SYNOPSIS - -Export query logs for a user in an Office 365 tenant. - -## SYNTAX - -```powershell -Export-SPOQueryLogs [-StartTime ] -LoginName -OutputFolder [] -``` - -## DESCRIPTION - -Export the query logs for a user in an Office 365 tenant. The result of the export is stored in the current working folder or a specified folder, in the two files loginName_queries.csv and loginName_personalQueries.csv. - -The output of the queries.csv will be for example: - -| QueryTime | QueryText | -| ------------- | ------------- | -| 5/31/2018 09:16 | Querytext1 | -| 5/31/2018 08:16 | Querytext2 | - -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -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 -------------------- - -```powershell -Export-SPOQueryLogs -LoginName user1@contoso.sharepoint.com -StartTime "2018-10-21" -OutputFolder "c:\users\contosoadmin\Documents" -``` - -Example 2 exports the query log from the starting time 21. October 2018, 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 folder c:\users\contosoadmin\Documents. - -## PARAMETERS - -### -LoginName - -Specifies the login name of the user to export. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFolder - -Target folder where the CSV file is generated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime - -Specifies from which point of time to export the logs from. Use the date format YYYY-MM-DD. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Introduction to the SharePoint Online management shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps) - -[Set up the SharePoint Online Management Shell Windows PowerShell environment](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md b/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md deleted file mode 100644 index 11516b35f1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserInfo.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/export-spouserinfo -applicable: SharePoint Online -title: Export-SPOUserInfo -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Export-SPOUserInfo - -## SYNOPSIS - -Export user information from site user information list. - -## SYNTAX - -```powershell -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -Export-SPOUserInfo -LoginName joe.healy@contoso.com -site https://contoso.sharepoint.com/sites/sc1 -OutputFolder "C:\users\admin\exportfolder" -``` - -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 -------------------- - -```powershell -$sites = Get-SPOSite -IncludePersonalSite $true -$user = "joe.healy@contoso.com" -foreach ($site in $sites) -{ -Export-SPOUserInfo -LoginName $user -site $site.Url -OutputFolder -"C:\users\admin\exportfolder" -} -``` - -Example 2 exports user data who has email address joe.healy@contoso.com from all site collections to folder C:\users\admin\exportfolder. - -## PARAMETERS - -### -LoginName - -Specifies the login name of the user to export. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the URL of the site collection to which you want to export the user. - -```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 -``` - -### -OutputFolder - -Target folder where the CSV file is generated. - -```yaml -Type: String -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[New-SPOSiteGroup](New-SPOSiteGroup.md) - -[Get-SPOUser](Get-SPOUser.md) - -[Set-SPOUser](Set-SPOUser.md) - -[Remove-SPOUser](Remove-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md b/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md deleted file mode 100644 index 82b2605eee..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Export-SPOUserProfile.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/export-spouserprofile -applicable: SharePoint Online -title: Export-SPOUserProfile -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Export-SPOUserProfile - -## SYNOPSIS - -Export user profile data to csv file. - -## SYNTAX - -```powershell -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -Export-SPOUserProfile -LoginName joe.healy@contoso.com -OutputFolder "C:\users\admin\exportfolder" -``` - -Example 1 exports user data who has the e-mail address joe.healy@contoso.com to a folder "C:\users\admin\exportfolder". - -## PARAMETERS - -### -LoginName - -Specifies the login name of the user whose data is exported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputFolder - -Specifies the output folder location where the CSV file is created. - -```yaml -Type: String -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Export-SPOUserInfo](Export-SPOUserInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-FileSensitivityLabelInfo.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-FileSensitivityLabelInfo.md deleted file mode 100644 index eb4939be9a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-FileSensitivityLabelInfo.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/Get-FileSensitivityLabelInfo -applicable: SharePoint Online -title: Get-FileSensitivityLabelInfo -schema: 2.0.0 -author: Sanjoyanm -ms.author: samust -ms.reviewer: ---- - -# Get-FileSensitivityLabelInfo - -## SYNOPSIS - -Extracts and displays the sensitivity label related information attached to an office file stored in SharePoint. - -## SYNTAX - -```powershell -Get-FileSensitivityLabelInfo -FileUrl [] -``` - -## DESCRIPTION - -The `Get-FileSensitivityLabelInfo` cmdlet runs on a single office online file. If the file has a sensitivity label attached then it returns the id, displayname, isProtectionEnabled flag and id of the parent label (if applicable). You must be a SharePoint Online administrator or Global Administrator to run the `GetFileSensitivityLabelInfo` cmdlet. Note that this cmdlet does not work on files that have labels with custom permission or user defined permission or double key encryption. -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-FileSensitivityLabelInfo -FileUrl "https://contoso.com/sites/Marketing/Shared%20Documents/Doc1.docx" -``` - -## PARAMETERS - -### -FileUrl - -Full URL for the file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[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-SPOAppErrors.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppErrors.md deleted file mode 100644 index 7f386d07ff..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppErrors.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spoapperrors -applicable: SharePoint Online -title: Get-SPOAppErrors -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOAppErrors - -## SYNOPSIS - -Returns application errors. - -## SYNTAX - -```powershell -Get-SPOAppErrors [-EndTimeInUtc ] -ProductId [-StartTimeInUtc ] [] -``` - -## DESCRIPTION - -The `Get-SPOAppErrors` cmdlet returns application monitoring errors (if available) for the application that is specified by ProductId between StartTimeInUtc in Coordinated Universal Time (UTC) and EndTimeInUtc in UTC. - -Based on server configuration, errors are available for a limited time. -The default is seven days. -Older errors are purged. -Date time values that are older than 50 years or later than 20 years from today are considered invalid - -Each error includes the error message, time in UTC that error happened, the site where the error happened, and the error type. -Values for error type are as follows: 0 - None, 1 - Install Error, 2 - Upgrade Error, 3 - Runtime Error. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -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 -------------------- - -```powershell -Get-SPOAppErrors -ProductId ba51729b-e017-409d-681a-66f1dd18f0f4 -StartTimeInUtc (Get-Date).AddHours(-1).ToUniversalTime() -``` - -This example returns a collection of monitoring error message(s) for application whose GUID is ba51729b-e017-409d-681a-66f1dd18f0f4 in the last hour. - -## PARAMETERS - -### -EndTimeInUtc - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId - -Specifies the application's GUID. - -```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 -``` - -### -StartTimeInUtc - -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 -Parameter Sets: (All) -Aliases: -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppInfo](Get-SPOAppInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md deleted file mode 100644 index 67575b0757..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppInfo.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spoappinfo -applicable: SharePoint Online -title: Get-SPOAppInfo -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOAppInfo - -## SYNOPSIS - -Returns all installed applications. - -## SYNTAX - -```powershell -Get-SPOAppInfo [[-ProductId] ] [[-Name] ] [] -``` - -## DESCRIPTION - -The `Get-SPOAppInfo` cmdlet gets all the installed applications from an external marketplace or from the App Catalog that contain Name in their application names or the installed application with mentioned ProductId. ProductId takes precedence if not empty. - -Either ProductId or Name must be given. Name is ignored if ProductId is specified. - -The returned collection of installed applications contains Product ID (GUID), Product name and Source. Values for source type are as follows: 0 = App Catalog and 1 = Marketplace. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -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 -------------------- - -```powershell -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 -------------------- - -```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. - -## PARAMETERS - -### -Name - -Specifies the application's name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId - -Specifies the application's GUID. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -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-SPOBrowserIdleSignOut.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBrowserIdleSignOut.md deleted file mode 100644 index e4f77443b2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBrowserIdleSignOut.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spobrowseridlesignout -applicable: SharePoint Online -title: Get-SPOBrowserIdleSignOut -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOBrowserIdleSignOut - -## SYNOPSIS - -Used to retrieve the current configuration values for Idle session sign-out policy. - -## SYNTAX - -```powershell -Get-SPOBrowserIdleSignOut [] -``` - -## DESCRIPTION - -Use this cmdlet to retrieve the current configuration values for Idle session sign-out policy, the time at which users are warned and subsequently signed out of Office 365 after a period of browser inactivity in SharePoint and OneDrive. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOBrowserIdleSignOut -``` - -This example retrieves the current configuration values for Idle session sign-out - -## 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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInDesignPackageVisibility.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInDesignPackageVisibility.md deleted file mode 100644 index 66812d8416..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOBuiltInDesignPackageVisibility.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spobuiltindesignpackagevisibility -applicable: SharePoint Online -title: Get-SPOBuiltInDesignPackageVisibility -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOBuiltInDesignPackageVisibility - -## SYNOPSIS - -Gets the visibility of the available built-in Design Packages. - -## SYNTAX - -```powershell -Get-SPOBuiltInDesignPackageVisibility [-DesignPackage ] [] -``` - -## DESCRIPTION - -Use this cmdlet to retrieve the current visibility state of each built-in design package. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOBuiltInDesignPackageVisibility -DesignPackage Showcase -``` - -This example retrieves the current visibility state of Showcase built-in design package. - -### Example 2 - -```powershell -Get-SPOBuiltInDesignPackageVisibility -``` - -This example retrieves the current visibility state of each built-in design package. - -## PARAMETERS - -### -DesignPackage - -Name of the design package, available names are -- Topic -- Showcase -- Blank -- TeamSite - -```yaml -Type: DesignPackageType -Parameter Sets: (All) -Aliases: -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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMoveReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMoveReport.md deleted file mode 100644 index 650d94e692..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMoveReport.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spocrossgeomovereport -applicable: SharePoint Online -title: Get-SPOCrossGeoMoveReport -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOCrossGeoMoveReport - -## SYNOPSIS - -Provides a report of objects moved between geo locations. - -## SYNTAX - -```powershell -Get-SPOCrossGeoMoveReport -MoveJobType [-Limit ] [-MoveStartTime ] [-MoveEndTime ] [-MoveState ] [-MoveDirection ] [] -``` - -## DESCRIPTION - -Use this cmdlet to return a report of objects moved between geo locations based on the specified parameters. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOCrossGeoMoveReport -MoveJobType SiteMove -MoveState Failed -``` - -This example returns the failed site moves between geo locations. - -## PARAMETERS - -### -MoveJobType - -The type of job to limit the report to. Valid values are: - -* GroupMove -* SiteMove -* UserMove - -```yaml -Type: JobType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit - -Limit the number of items to return for the report. - -```yaml -Type: uint32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveStartTime - -The start time to limit the move report to. - -```yaml -Type: datetime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveEndTime - -The end time to limit the move report to. - -```yaml -Type: datetime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -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: - -* All -* Failed -* InProgress -* NotStarted -* NotSupported -* Queued -* Rescheduled -* Stopped -* Success - -```yaml -Type: MoveState -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveDirection - -The direction of the move to limit the report to. Valid values are: - -* All -* MoveIn -* MoveOut - -```yaml -Type: MoveDirection -Parameter Sets: (All) -Aliases: -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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md deleted file mode 100644 index 89f87c3e35..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoMovedUsers.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spocrossgeomovedusers -applicable: SharePoint Online -title: Get-SPOCrossGeoMovedUsers -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOCrossGeoMovedUsers - -## SYNOPSIS - -In a multi-geo tenant returns the SharePoint Online user (or users) that had been moved. - -## SYNTAX - -```powershell -Get-SPOCrossGeoMovedUsers -Direction [] -``` - -## DESCRIPTION - -This cmdlet allows you to get the moved users out and in the current SPO Site. It requires a connection to a multi-geo tenant to run correctly. You must be a SharePoint Online global Administrator to get the moved users out and in the current SPO site. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOCrossGeoMovedUsers -Direction MoveIn -``` - -Get the cross users that have been moved in the current SPO site - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Get-SPOCrossGeoMovedUsers -Direction MoveOut -``` - -Get the cross users that have been moved out the current SPO site - -## PARAMETERS - -### -Direction -Used to specify move direction. - -Possible values - -- MoveIn -- MoveOut - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: MoveIn, MoveOut -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md deleted file mode 100644 index c4b584b682..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCrossGeoUsers.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spocrossgeousers -applicable: SharePoint Online -title: Get-SPOCrossGeoUsers -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOCrossGeoUsers - -## SYNOPSIS - -Returns the SharePoint Online users in a multi-geo tenant that match the criteria. - -## SYNTAX - -```Powershell -Get-SPOCrossGeoUsers -ValidDataLocation [] -``` - -## DESCRIPTION - -The Get-SPOCrossGeoUsers cmdlet is used to return the SharePoint Online users that match a given criteria. The ValidDataLocation parameter is a switch used to validate the location of the data. This cmdlet requires a connection to a multi-geo tenant to run correctly. You must have the SharePoint Online Admin role or Global Administrator role to execute this cmdlet. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```Powershell -Get-SPOCrossGeoUsers -ValidDataLocation $true -``` - -Returns all of the SharePoint Online users in a multi-geo tenant and validates the data location. - -### -----------------------EXAMPLE 2----------------------------- - -```Powershell -Get-SPOCrossGeoUsers -``` - -Returns all of the SharePoint Online users in a multi-geo tenant without validating data location. - -### -----------------------EXAMPLE 3----------------------------- - -```Powershell -Get-SPOCrossGeoUsers -ValidDataLocation $true | where {$_.UserPrincipalName -eq 'jane@contoso.com'} -``` - -Returns a single user from SharePoint Online in a multi-geo tenant and validates the data location. - -## PARAMETERS - -### -ValidDataLocation - -Use this parameter to validate the location of the data. The acceptable values for this parameter are: - -- $False -- $True - -```yaml -Type: Boolean -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[ConvertTo-SPOMigrationTargetedPackage](ConvertTo-SPOMigrationTargetedPackage.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md deleted file mode 100644 index b6afee8a68..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODataEncryptionPolicy.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spodataencryptionpolicy -applicable: SharePoint Online -title: Get-SPODataEncryptionPolicy -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPODataEncryptionPolicy - -## SYNOPSIS - -. - -## SYNTAX - -```powershell -Get-SPODataEncryptionPolicy -``` - -## DESCRIPTION - -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://docs.microsoft.com/en-us/microsoft-365/compliance/controlling-your-data-using-customer-key) - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPODataEncryptionPolicy -``` - -The output from this cmdlet includes: - -- The URI of the primary key. - -- The URI of the secondary key. - -- The encryption status for the geo. Possible states include: - - - **Unregistered:** Customer Key encryption has not yet been applied. - - - **Registering:** Customer Key encryption has been applied and your files are in the process of being encrypted. If your geo is in this state, you'll also be shown information on what percentage of sites in the geo are complete so that you can monitor encryption progress. - - - **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. - -## 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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md deleted file mode 100644 index 426ba7b778..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPODeletedSite.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spodeletedsite -applicable: SharePoint Online -title: Get-SPODeletedSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPODeletedSite - -## SYNOPSIS - -Returns all deleted site collections from the Recycle Bin. - -## SYNTAX - -### ParameterSetPersonalSitesOnly - -```powershell -Get-SPODeletedSite [[-Identity] ] [-IncludeOnlyPersonalSite] [-Limit ] [] -``` - -### ParameterSetAllSites - -```powershell -Get-SPODeletedSite [[-Identity] ] [-IncludePersonalSite] [-Limit ] [] -``` - -## DESCRIPTION - -The `Get-SPODeletedSite` cmdlet returns all deleted site collections that match the given criteria from the Recycle Bin. - -By default the cmdlet only returns site and site collections that are not Personal Sites (My Sites). -To include personal sites, use the IncludePersonalSite parameter. -To return only Personal Sites, use the IncludeOnlyPersonalSite parameter. - -These two Switch Parameters are in different parameter sets, so you can only use either one of them but not both. - -This action does not restore these returned sites or site collection. -It only returns their properties so that you can see what sites or site collections have been deleted. -To restore the site or site collections, forward the results to the `Restore-SPODeletedSite` cmdlet in the pipeline. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -Get-SPODeletedSite -IncludePersonalSite -``` - -The command in this example returns all deleted site collections from the Recycle Bin including Personal Sites. - -## PARAMETERS - -### -IncludeOnlyPersonalSite - -Use this switch parameter to only include Personal Sites in the returned results. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetPersonalSitesOnly -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the URL of the deleted site collection to be returned. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludePersonalSite - -Use this switch parameter to include Personal Sites with the returned results. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAllSites -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit - -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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Restore-SPODeletedSite](Restore-SPODeletedSite.md) - -[Remove-SPODeletedSite](Remove-SPODeletedSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md deleted file mode 100644 index 5b275955e6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOExternalUser.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spoexternaluser -applicable: SharePoint Online -title: Get-SPOExternalUser -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOExternalUser - -## SYNOPSIS - -Returns external users in the tenant. - -## SYNTAX - -```powershell -Get-SPOExternalUser [[-Position] ] [[-PageSize] ] [[-Filter] ] [[-SortOrder] ] [[-SiteUrl] ] [-ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount ] [] -``` - -## DESCRIPTION - -The `Get-SPOExternalUser` cmdlet returns external users that are located in the tenant based on specified criteria. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251832](https://go.microsoft.com/fwlink/p/?LinkId=251832). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOExternalUser -Position 0 -PageSize 2 -``` - -Example 1 returns the first two external users in the collection. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Get-SPOExternalUser -Position 2 -PageSize 2 -``` - -Example 2 returns two external users from the third page of the collection. - -### -----------------------EXAMPLE 3----------------------------- - -```powershell -Get-SPOExternalUser -Position 0 -PageSize 30 -SiteUrl https://contoso.sharepoint.com -``` - -Example 3 returns the first 30 users that match the SiteUrl . - -## PARAMETERS - -### -Filter - -Limits the results to only those users whose first name, last name, or email address begins with the text in the string using a case-insensitive comparison. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PageSize - -Specifies the maximum number of users to be returned in the collection. - -The value must be less than or equal to 50. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Position - -Use to specify the zero-based index of the position in the sorted collection of the first result to be returned. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteUrl - -Specifies the site to retrieve external users for. - -If no site is specified, the external users for all sites are returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SortOrder - -Specifies the sort results in Ascending or Descending order on the SPOUser.Email property should occur. - -```yaml -Type: SortOrder -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount - -Shows users who have accepted an invite but not using the account the invite was sent to. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Remove-SPOExternalUser](Remove-SPOExternalUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md deleted file mode 100644 index f0f4c3f5a6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoAdministrator.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spogeoadministrator -applicable: SharePoint Online -title: Get-SPOGeoAdministrator -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOGeoAdministrator - -## SYNOPSIS - -This cmdlet returns the SharePoint Online user or security group accounts with global administrative privileges in the current Multi-Geographics tenant. - -## 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://docs.microsoft.com/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. - -Running this cmdlet on a non-multi-geo tenant organization will return error -4. - -You must be a SharePoint Online or global administrator and you must have a the Multi-Geo Capabilities in Office 365 service plan to run the `Get-SPOGeoAdministrator` cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [https://go.microsoft.com/fwlink/p/?LinkId=251832](https://go.microsoft.com/fwlink/p/?LinkId=251832). - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOGeoAdministrator -``` - -This cmdlet will output a SharePoint Online user or security group that is Multi-Geographic administrators on the current multi-geo tenant. - -## 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). - -## RELATED LINKS - -[Add or remove a geo administrator](https://docs.microsoft.com/Office365/Enterprise/add-a-sharepoint-geo-admin) - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) - -[Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md deleted file mode 100644 index cb86034781..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoMoveCrossCompatibilityStatus.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spogeomovecrosscompatibilitystatus -applicable: SharePoint Online -title: Get-SPOGeoMoveCrossCompatibilityStatus -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOGeoMoveCrossCompatibilityStatus - -## SYNOPSIS - -This cmdlet returns the compatibility status between geographic locations. - -## SYNTAX - -```powershell -Get-SPOGeoMoveCrossCompatibilityStatus [] -``` - -## DESCRIPTION - -This cmdlet returns the compatibility between sites and locations for a move in a multi-geo SharePoint Online tenant. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Get-SPOGeoMoveCrossCompatibilityStatus -``` - -Get the compatibility status for all locations. - -## 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md deleted file mode 100644 index cc9fae668f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOGeoStorageQuota.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spogeostoragequota -applicable: SharePoint Online -title: Get-SPOGeoStorageQuota -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOGeoStorageQuota - -## SYNOPSIS - -This cmdlet gets the storage quota on a multi-geo tenant. - -## SYNTAX - -```Powershell -Get-SPOGeoStorageQuota [-AllLocations] [] -``` - -## DESCRIPTION - -This cmdlet shows the storage on the current location or all locations in a multi-geo tenant. - -This Cmdlet requires a connection to a multi-geo tenant to run correctly. You must be a SharePoint Online global Administrator to get the storage on current location or all locations in a multi-geo SPO tenant. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```Powershell -Get-SPOGeoStorageQuota -AllLocations -``` - -Get the storage size quota of all locations. - -### -----------------------EXAMPLE 2----------------------------- - -```Powershell -Get-SPOGeoStorageQuota -``` - -Get the storage size quota of the current location. - -## PARAMETERS - -### -AllLocations - -Use this parameter to retrieve the storage size quota of all locations. - -```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 -``` - -### 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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Set-SPOGeoStorageQuota](set-SPOGeoStorageQuota.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md deleted file mode 100644 index 8030cfec76..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHideDefaultThemes.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spohidedefaultthemes -applicable: SharePoint Online -title: Get-SPOHideDefaultThemes -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOHideDefaultThemes - -## SYNOPSIS - -Queries the current SPOHideDefaultThemes setting. SPO stands for SharePoint Online. - -## 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. - -> [!NOTE] -> This cmdlet was named **Get-HideDefaultThemes** until the December 2017 release of the SPO Management Shell. We recommend that you use the latest version of the PowerShell cmdlets. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOHideDefaultThemes -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Set-SPOHideDefaultThemes](Set-SPOHideDefaultThemes.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHomeSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHomeSite.md deleted file mode 100644 index 2a7aec0e40..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHomeSite.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spohomesite -applicable: SharePoint Online -title: Get-SPOHomeSite -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOHomeSite - -## SYNOPSIS - -Returns the home site url for your tenant. - -## SYNTAX - -```powershell -Get-SPOHomeSite [] -``` - -## DESCRIPTION - -Use this cmdlet to get the home site url for your tenant. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOHomeSite -``` - -This example returns the home site url for your tenant. - -## 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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md deleted file mode 100644 index 9965ff0448..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOHubSite.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spohubsite -applicable: SharePoint Online -title: Get-SPOHubSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOHubSite - -## SYNOPSIS - -Lists hub sites or hub site information. - -## SYNTAX - -```powershell -Get-SPOHubSite [-Identity] -[] -``` - -## DESCRIPTION - -Lists all hub sites found on the SharePoint tenant. If you provide **-Identity** the cmdlet returns detailed information about the specific hub. You can find which hub a site is associated with by providing the site's identity with this cmdlet. - -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://docs.microsoft.com/powershell/module/sharepoint-online/unregister-spohubsite) on the deleted hub site. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOHubSite -``` - -This example lists all hub sites in the tenant. - -### Example 2 - -```powershell -Get-SPOHubSite -Identity https://contoso.sharepoint.com/sites/online-marketing - -ID : 44252d09-62c4-4913-9eb0-a2a8b8d7f863 -Title : Marketing Hub -SiteId : 44252d09-62c4-4913-9eb0-a2a8b8d7f863 -SiteUrl : https://contoso.sharepoint.com/sites/Marketing -LogoUrl : https://contoso.sharepoint.com/sites/Marketing/SiteAssets/hublogo.png -Description : Hub for the Marketing division -Permissions : {Wilke, Nestor} -SiteDesignId : 00000000-0000-0000-0000-000000000000 -RequiresJoinApproval : False -HideNameInNavigation : False -``` - -This example begins with the online-marketing site. The cmdlet finds the associated hub site, which is marketing. Then it lists all the details about the marketing hub site. - -## PARAMETERS - -### -Identity - -URL of the hub site. If not specified, the cmdlet lists all hub sites in the tenant. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md deleted file mode 100644 index 18f6a5306d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobProgress.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spomigrationjobprogress -applicable: SharePoint Online -title: Get-SPOMigrationJobProgress -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOMigrationJobProgress - -## SYNOPSIS - -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 ] [] -``` - -### AzureLocationsImplicit - -``` -Get-SPOMigrationJobProgress -Credentials [-DontWaitForEndJob] - [-EncryptionParameters ] [-JobIds ] - -MigrationPackageAzureLocations [-NoLogFile] [-TargetWebUrl ] - [] -``` - -## DESCRIPTION - -This cmdlet lets you report on SPO migration jobs that are in progress. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -$myQueueUri = - -Get-SPOMigrationJobProgress -AzureQueueUri $myQueueUri -``` - -This will report on ALL jobs within the report queue. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -$jobIds = @(,....) - -Get-SPOMigrationJobProgress -AzureQueueUri $myQueueUri -JobIds $jobIds -``` - -This will report only jobs defined within the $jobIds collection from the report queue. - -### -----------------------EXAMPLE 3----------------------------- - -```powershell -$targetWebUrl = -$creds = - -Get-SPOMigrationJobProgress - AzureQueueUri $myQueueUri - TargetWebUrl $targetWebUrl -Credentials $creds -``` - -This will report on any currently queued or in progress jobs and wait for all jobs to complete. - -### -----------------------EXAMPLE 4----------------------------- - -```powershell -$targetWebUrl = -$creds = - -Get-SPOMigrationJobProgress - AzureQueueUri $myQueueUri - TargetWebUrl $targetWebUrl -Credentials $creds -DontWaitForJobEnd -``` - -This will report on any currently queued or in progress jobs and not wait for all jobs to complete. - -## PARAMETERS - -### -AzureQueueUri - -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 -Parameter Sets: AzureLocationsInline -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DontWaitForEndJob - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionParameters - -An EncryptionParameters object. See New-SPOMigrationEncryptionParameters https://docs.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters for more information. - -```yaml -Type: EncryptionParameters -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobIds - -Id of a previously created migration job that exists on the target site collection. - -```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 -``` - -### -MigrationPackageAzureLocations - -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 -Parameter Sets: AzureLocationsImplicit -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl - -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 -Parameter Sets: (All) -Aliases: -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md deleted file mode 100644 index 77671f9867..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMigrationJobStatus.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spomigrationjobstatus -applicable: SharePoint Online -title: Get-SPOMigrationJobStatus -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOMigrationJobStatus - -## SYNOPSIS - -Use this cmdlet to monitor the status of a submitted SharePoint Online migration job. - -## SYNTAX - -```powershell -Get-SPOMigrationJobStatus -Credentials [-JobId ] [-NoLogFile] - -TargetWebUrl [] -``` - -## DESCRIPTION - -This cmdlet will check the status of a migration job. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -$targetWebUrl = "https://contoso.sharepoint.com/sites/migrationtest" -$credentials = Get-Credential -Get-SPOMigrationJobStatus -TargetWebUrl $targetWebUrl -Credentials $credentials -JobId "779c4b3b-ec24-4705-bb58-c38f4329418c" -``` - -Get the status of your SPO Migration Job. -You can obtain the Job id when submit package data to create new SPO migration job via the Invoke-SPOMigrationEncryptUploadSubmit cmdlet - -## PARAMETERS - -### -Credentials - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId - -(optional) The ID of a migration job that exists on the target site collection. - -```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 -``` - -### -NoLogFile - -(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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl - -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 -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[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/sharepoint-online/Get-SPOMultiGeoCompanyAllowedDataLocation.md deleted file mode 100644 index 043f2deda3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoCompanyAllowedDataLocation.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spomultigeocompanyalloweddatalocation -applicable: SharePoint Online -title: Get-SPOMultiGeoCompanyAllowedDataLocation -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOMultiGeoCompanyAllowedDataLocation - -## SYNOPSIS - -Returns the SharePoint Online Multi geo allowed data locations. - -## SYNTAX - -```powershell -Get-SPOMultiGeoCompanyAllowedDataLocation [] -``` - -## DESCRIPTION - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOMultiGeoCompanyAllowedDataLocation -``` - -This example returns the SharePoint Online Multi geo allowed data locations. - -## 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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoExperience.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoExperience.md deleted file mode 100644 index b54881c0df..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOMultiGeoExperience.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spomultigeoexperience -applicable: SharePoint Online -title: Get-SPOMultiGeoExperience -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOMultiGeoExperience - -## SYNOPSIS - -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://docs.microsoft.com/office365/enterprise/enabling-sp-multigeo-satellite-geolocation) - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOMultiGeoExperience -``` - -This example will show you whether the geo location is in SPO or ODB mode. - -## 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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgAssetsLibrary.md deleted file mode 100644 index 8a18210ae5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgAssetsLibrary.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spoorgassetslibrary -applicable: SharePoint Online -title: Get-SPOOrgAssetsLibrary -author: Maralesfahanpoor -ms.author: maesfaha -ms.reviewer: -manager: paulac -schema: 2.0.0 ---- - -# Get-SPOOrgAssetsLibrary - -## SYNOPSIS - -Displays information about all libraries designated as locations for organization assets. - -## SYNTAX - -```powershell -Get-SPOOrgAssetsLibrary [] -``` - -## DESCRIPTION - -The Get-SPOOrgAssetsLibrary cmdlet displays information about all libraries designated as locations for organization assets. - -Once this cmdlet is run, it will display the name and URL of the site where assets are originally stored, as well as the display name, server relative library URL, list ID, OrgAssetType and thumbnail URL for any associated libraries. - -## EXAMPLES - -### Example 1 - -This example displays the name and URL of the site where assets are originally stored. It also provides a list of any associated libraries and shows the respective display name, server relative library URL, list ID, OrgAssetType and thumbnail URL. - -```powershell -Get-SPOOrgAssetsLibrary -``` - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/add-spoorgassetslibrary?view=sharepoint-ps) - -[Set-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/set-spoorgassetslibrary?view=sharepoint-ps) - -[Remove-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spoorgassetslibrary?view=sharepoint-ps) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgNewsSite.md deleted file mode 100644 index 9630054aab..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOOrgNewsSite.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spoorgnewssite -applicable: SharePoint Online -title: Get-SPOOrgNewsSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen ---- - -# Get-SPOOrgNewsSite - -## SYNOPSIS - -Lists URLs of all the configured organizational news sites. Requires Tenant administrator permissions. - -## SYNTAX - -```powershell -Get-SPOOrgNewsSite [] -``` - -## DESCRIPTION - -Lists URLs of all the organizational authoritative news sites. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Get-SPOOrgNewsSite -``` - -The example returns a list of organizational news sites from the Tenant. - -## 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-SPOOrgNewsSite](Set-SPOOrgNewsSite.md) - -[Remove-SPOOrgNewsSite](Remove-SPOOrgNewsSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md deleted file mode 100644 index c53c9bdc10..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOPublicCdnOrigins.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spopubliccdnorigins -applicable: SharePoint Online -title: Get-SPOPublicCdnOrigins -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOPublicCdnOrigins - -## SYNOPSIS - -This cmdlet returns a list of CDN Origins in your SharePoint Online Tenant - -## SYNTAX - -```powershell -Get-SPOPublicCdnOrigins [] -``` - -## DESCRIPTION - -List CDN Origins in your Tenant by id or url. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOPublicCdnOrigins | Fl - -Id : 16530053476cf3efe88b499076356d0205504b2451688c20a65d561c951783e0859ac590 -Url : HTTPS:/CONTOSO.SHAREPOINT.COM/SITES/CDN/CDNFILESLIBRARY -``` - -This example returns a list of CDN Origins. - -## 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). - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[New-SPOPublicCdnOrigin](New-SPOPublicCdnOrigin.md) - -[Remove-SPOPublicCdnOrigin](Remove-SPOPublicCdnOrigin.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md deleted file mode 100644 index 1c95efad8a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSite.md +++ /dev/null @@ -1,352 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-sposite -applicable: SharePoint Online -title: Get-SPOSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSite - -## SYNOPSIS - -Returns one or more site collections. - -## SYNTAX - -### ParamSet1 - -```powershell -Get-SPOSite [[-Identity] ] [-Detailed] [-Limit ] [] -``` - -### ParamSet2 - -```powershell -Get-SPOSite [-Detailed] [-Filter ] [-IncludePersonalSite ] [-Limit ] - [-Template ] [-GroupIdDefined] [] -``` - -### ParamSet3 - -```powershell -Get-SPOSite [-Identity] [-DisableSharingForNonOwnersStatus] [] -``` - -## 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. - -The `Get-SPOSite` cmdlet retrieves and returns properties of all site collections that match the given criteria. - -With version 5361 of the SharePoint Online Management Shell, you may experience the following: - -Additional site collections are now displayed. For example, all group and video sites along with team sites will be displayed. - -The Detailed parameter has been deprecated. It will continue to work with earlier versions - -> [!NOTE] -> Site collections in the Recycle Bin will not be retrieved by using the `Get-SPOSite` cmdlet. - -You need to be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -> [!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. - -> [!NOTE] -> If the Limit or Filter parameters are provided then the following site collection properties will not be populated and may contain a default value: -> AllowDownloadingNonWebViewableFiles, AllowEditing, AllowSelfServiceUpgrade, AnonymousLinkExpirationInDays, ConditionalAccessPolicy, DefaultLinkPermission, DefaultLinkToExistingAccess, DefaultSharingLinkType, DenyAddAndCustomizePages, DisableCompanyWideSharingLinks, ExternalUserExpirationInDays, LimitedAccessFileType, OverrideTenantAnonymousLinkExpirationPolicy, OverrideTenantExternalUserExpirationPolicy, PWAEnabled, SandboxedCodeActivationCapability, SensitivityLabel, SharingAllowedDomainList, SharingBlockedDomainList, SharingCapability, SharingDomainRestrictionMode. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOSite -``` - -Example 1 returns all site collections. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Get-SPOSite -Identity https://contoso.sharepoint.com -``` - -Example 2 lists the site collection with detailed properties. - -### -----------------------EXAMPLE 3----------------------------- - -```powershell -Get-SPOSite -Identity https://contoso.sharepoint.com -DisableSharingForNonOwnersStatus -``` - -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----------------------------- - -```powershell -Get-SPOSite -Template GROUP#0 -IncludePersonalSite:$false -``` - -This example enumerates Group Site Collections in a tenant. - -### -----------------------EXAMPLE 5----------------------------- - -```powershell -Get-SPOSite -Identity https://contoso.sharepoint.com/sites/groupname -detailed |fl -``` - -This example gets quota details for a Group Site. - -### -----------------------EXAMPLE 6----------------------------- - -```powershell -Get-SPOSite -Identity https://contoso.sharepoint.com/sites/research | Select InformationSegment -``` - -This example returns the InformationSegments associated to the site. - -### -----------------------EXAMPLE 7----------------------------- - -```powershell -Get-SPOSite -Filter { Url -like "contoso.sharepoint.com/sites/18" } -``` - -This example uses server side filtering to return sites matching 18. - - -### -----------------------EXAMPLE 8----------------------------- - -```powershell -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----------------------------- - -```powershell -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----------------------------- - -```powershell -Get-SPOSite -Limit ALL -GroupIdDefined $true -``` -This example uses server-side filtering to return all sites that have an associated Microsoft 365 Group. - - -## PARAMETERS - -### -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. - -The following properties are returned: - -- ResourceUsageCurrent - -- ResourceUsageAverage - -- StorageUsageCurrent - -- LockIssue - -- WebsCount - -- CompatibilityLevel - -- AllowSelfServiceUpgrade - -- SiteDefinedSharingCapability - -Returns the stored value of the site policy. - -- SharingCapability - -Returns the effective access level, which is the site policy and the tenant policy combined. - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet1, ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSharingForNonOwnersStatus - -This parameter prevents non-owners from sharing. - -> [!NOTE] -> This parameter is available only in SharePoint Online Management Shell Version 16.0.4613.1211 or later. - -```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 -``` - -### -Filter - -Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value must be in the form `{ PropertyName "filterValue"}`. Valid operators are as follows: -eq, -ne, -like, -notlike. - Currently, you can filter by these properties: Owner, Template (can be used to filter if it is the only property present in the filter), LockState, Url. - Using the -or operator to include an additional filter is not supported. - -Note: The operator values are case-sensitive. - -```yaml -Type: String -Parameter Sets: ParamSet2 -Aliases: -Applicable: SharePoint Online - -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 -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludePersonalSite - -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: Boolean -Parameter Sets: ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit - -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: ParamSet1, ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template - -Displays sites of a specific template. For example, STS, STS#0, STS#1, STS#3, GROUP#0, SRCHCEN#0 or SITEPAGEPUBLISHING#0. - -```yaml -Type: String -Parameter Sets: ParamSet2 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### InformationSegment -This parameter displays the segments associated with a site. - -It is applicable for tenants who have enabled Microsoft 365 Information barriers capability. Please read https://docs.microsoft.com/microsoft-365/compliance/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: Collection of GUIDs -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -``` - -### -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. - -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 -Parameter Sets: ParamSet2 -Aliases: -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 - -### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteCollectionAppCatalogs.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteCollectionAppCatalogs.md deleted file mode 100644 index 72ebbc1f07..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteCollectionAppCatalogs.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositecollectionappcatalogs -applicable: SharePoint Online -title: Get-SPOSiteCollectionAppCatalogs -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOSiteCollectionAppCatalogs - -## SYNOPSIS - -Use this cmdlet to get the Site Collection App Catalog. - -## SYNTAX - -```powershell - 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://docs.microsoft.com/sharepoint/use-app-catalog) - -## EXAMPLES - -### Example 1 - -```powershell - Get-SPOSiteCollectionAppCatalogs -Site https://contoso.sharepoint.com/sites/Research -``` - -This example returns the Site Collection App Catalog for the site - -## PARAMETERS - -### -Site - -Url of the site - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteContentMoveState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteContentMoveState.md deleted file mode 100644 index 8bcf0a18a5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteContentMoveState.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositecontentmovestate -applicable: SharePoint Online -title: Get-SPOSiteContentMoveState -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteContentMoveState - -## SYNOPSIS - -This Cmdlet allows a SharePoint administrators to check the status of a site or group move. - -## SYNTAX - -### MoveReport (Default) -``` -Get-SPOSiteContentMoveState [-Limit ] [-MoveStartTime ] [-MoveEndTime ] - [-MoveState ] [-MoveDirection ] [] -``` - -### SourceSiteUrl -``` -Get-SPOSiteContentMoveState -SourceSiteUrl [] -``` - -### SiteMoveId -``` -Get-SPOSiteContentMoveState -SiteMoveId [] -``` - -## 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. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOSiteContentMoveState -SourceSiteUrl $siteurl -``` - -Gets the status of the site content give on the variable $siteurl - -## PARAMETERS - -### -Limit -Specifies the maximum number of Content move states to return. - -```yaml -Type: UInt32 -Parameter Sets: MoveReport -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveDirection -Possible values for this parameter are: -- MoveOut -- MoveIn -- All - -```yaml -Type: 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 -End date and time for the time window between which Content move states are to be retrieved. - -```yaml -Type: DateTime -Parameter Sets: MoveReport -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveStartTime -Start date and time for the time window between which Content move states are to be retrieved. - -```yaml -Type: DateTime -Parameter Sets: MoveReport -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -MoveState -This parameter is used to specify the move state of the Content move states to retrieve. -Possible values: -- NotStarted -- InProgress -- Success -- Failed -- Stopped -- Queued -- NotSupported -- Rescheduled -- All - -```yaml -Type: 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 -``` - -### -SiteMoveId -Id of the Site move to retrieve. - -```yaml -Type: Guid -Parameter Sets: SiteMoveId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSiteUrl -Specifies the source URL of the site collection. - -```yaml -Type: String -Parameter Sets: SourceSiteUrl -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). - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDataEncryptionPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDataEncryptionPolicy.md deleted file mode 100644 index bee0d43d7b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDataEncryptionPolicy.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositedataencryptionpolicy -applicable: SharePoint Online -title: Get-SPOSiteDataEncryptionPolicy -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOSiteDataEncryptionPolicy - -## SYNOPSIS - -Validates the encryption of a Group Site, Team Site, or OneDrive for Business site if a Customer Key has been registered for the site. - -## SYNTAX - -```powershell -Get-SPOSiteDataEncryptionPolicy [-Identity] [] -``` - -## DESCRIPTION - -When a Customer Key has been configured in the Azure tenant, it is possible to set and subsequently verify the encryption status of a SharePoint Online or OneDrive for Business site. This cmdlet verifies the encryption status of the particular site. - -This cmdlet will return an error if the Azure tenant has not been configured with a Customer Key. See the Related Links section for more information on how to configure the Customer Key. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOSiteDataEncryptionPolicy https://contoso.sharepoint.com/sites/Research -``` - -Verifies the encryption of the site https://contoso.sharepoint.com/sites/Research. - -## PARAMETERS - -### -Identity - -The URL of the Site Collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -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/p/?LinkID=113216). - -## OUTPUTS -### System.String - -The URI of the primary key. - -### System.String - -The URI of the secondary key. - -### System.Object - -The encryption status for the geo. Possible states include: - -* Unregistered: Customer Key encryption has not yet been applied. -* Registering: Customer Key encryption has been applied and your files are in the process of being encrypted. If your geo is in this state, you'll also be shown information on what percentage of sites in the geo are complete so that you can monitor encryption progress. -* 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. - -## RELATED LINKS - -[Register-SPODataEncryptionPolicy](https://docs.microsoft.com/powershell/module/sharepoint-online/register-spodataencryptionpolicy) - -[Controlling your data in Office 365 using Customer Key](https://docs.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) - -[Office 365: Setting up Customer Key for SharePoint Online and OneDrive for Business](https://docs.microsoft.com/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/sharepoint-online/Get-SPOSiteDesign.md deleted file mode 100644 index 099aa77e85..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositedesign -applicable: SharePoint Online -title: Get-SPOSiteDesign -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteDesign - -## SYNOPSIS - -Gets details about site designs that are on the SharePoint tenant. You can specify an ID of a specific site design to retrieve. If there are no parameters listed, details about all site designs are listed. - -## SYNTAX - -```powershell -Get-SPOSiteDesign [[-Identity] ] [] -``` - -## DESCRIPTION - -Gets details about site designs that are on the SharePoint tenant. You can specify an ID of a specific site design to retrieve. If there are no parameters listed, details about all site designs are listed. - -## EXAMPLES - -### Example 1 - -This example and sample response show how to get site design details. - -```powershell -Get-SPOSiteDesign 44252d09-62c4-4913-9eb0-a2a8b8d7f863 - -Id : 44252d09-62c4-4913-9eb0-a2a8b8d7f863 -Title : Contoso - Team Project -WebTemplate : 64 -SiteScriptIds : {1306913c-8463-42ca-bd63-efad0fcdbba4} -Description : Use this design to apply Contoso theme and create - custom lists and add to nav -``` - -## PARAMETERS - -### -Identity - -The ID of the site design to retrieve. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md deleted file mode 100644 index b47bef9d0f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositedesignrights -applicable: SharePoint Online -title: Get-SPOSiteDesignRights -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteDesignRights - -## SYNOPSIS - -Displays a list of principals and their rights for usage of the site design. This can be used to determine the scope that your site design has with users on the tenant. - -## SYNTAX - -```powershell -Get-SPOSiteDesignRights [-Identity] [] -``` - -## DESCRIPTION - -Displays a list of principals and their rights for usage of the site design. This can be used to determine the scope that your site design has with users on the tenant. - -## EXAMPLES - -### Example 1 - -This example gets the rights for a site design. - -```powershell -Get-SPOSiteDesignRights 607aed52-6d61-490a-b692-c0f58a6981a1 - -DisplayName PrincipalName Rights ------------ ------------- ------ -Nestor Wilke i:0#.f|membership|nestorw@contoso.onmicrosoft.com View -``` - -## PARAMETERS - -### -Identity - -The ID of the site design to get scoping information. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md deleted file mode 100644 index 7d3801bd50..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRun.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -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/get-spositedesignrun -applicable: SharePoint Online -title: Get-SPOSiteDesignRun -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteDesignRun - -## SYNOPSIS - -Retrieves a list of site designs applied to a specified site collection. - -## SYNTAX - -```powershell -Get-SPOSiteDesignRun [-WebUrl] [[-SiteDesignId] ] [] -``` - -## DESCRIPTION - -Retrieves a list of site designs applied to a specified site collection. The WebUrl is required to know which site collection to query. The returned output includes the ID of the scheduled job, the web and site IDs, and the site design ID, version, and title. - -## EXAMPLES - -### ------------ 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. - -```powershell -PS C:\> Get-SPOSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook" - -Id: | sean530z-55a3-4804-8b0a-80578626d6ef -SiteDesignId: | sean530b-4133-444e-9e31-fb0c07f69d3a -WebId: | 4f8509cd-7972-44d0-a14a-3c8ad69ee50f -SiteId: | d5d19d7c-sean-4625-9461-281bfc8a9ece -SiteDesignVersion: | 3 -SiteDesignTitle: | Contoso Project Playbook -``` - -## PARAMETERS - -### -SiteDesignId - -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 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WebUrl - -The Url of the site collection. - -```yaml -Type: 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 - -### Microsoft.Online.SharePoint.PowerShell.SPOSiteDesignPipeBind - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md deleted file mode 100644 index 7fa2e661d6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRunStatus.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -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/get-spositedesignrunstatus -applicable: SharePoint Online -title: Get-SPOSiteDesignRunStatus -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteDesignRunStatus - -## SYNOPSIS - -Retrieves and displays a list of all site script actions executed for a specified site design applied to a site. - -## SYNTAX - -```powershell -Get-SPOSiteDesignRunStatus [-Run] [] -``` - -## DESCRIPTION - -Retrieves and displays a list of all site script actions executed for a specified site design applied to a site. - -## EXAMPLES - -### Example 1 - -This example gets the run for a specific site design applied to a site and sets it to a variable. This variable is then passed into the command -run parameter. The result is a display of all the site script actions applied for that site design run, including the script action title and outcome. - -```powershell -$myrun = Get-SPOSiteDesignRun -WebUrl "https://contoso.sharepoint.com/sites/project-playbook" -SiteDesignId cefd782e-sean-4814-a68a-b33b116c302f - -Get-SPOSiteDesignRunStatus -Run $myrun - -OrdinalIndex: | 0 -SiteScriptId: | sean530b-4133-444e-9e31-fb0c07f69d3a -SiteScriptTitle: | project tracker script for contoso legal -SiteScriptIndex: | 0 -ActionIndex: | 0 -ActionTitle: | Add principal contoso legal team to SPGroup Owners. -ActionKey: | 4f8509cd-0000-0000-0000-00000000 -OutcomeCode: | Success -OutcomeText: | - -OrdinalIndex: | 1 -SiteScriptId: | sean530b-4133-444e-9e31-abc123abc123 -SiteScriptTitle: | project tracker script for contoso legal -SiteScriptIndex: | 0 -ActionIndex: | 1 -ActionTitle: | Apply theme Contoso Legal. -ActionKey: | 4f8509cd-0000-0000-0000-00000000 -OutcomeCode: | Success -OutcomeText: | -``` - -## PARAMETERS - -### -Run - -The site design run for the desired set of script action details. - -```yaml -Type: SPOSiteDesignRun -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.SPOSiteDesignRun - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md deleted file mode 100644 index 119d47d12b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignTask.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositedesigntask -applicable: SharePoint Online -title: Get-SPOSiteDesignTask -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteDesignTask - -## SYNOPSIS - -Cmdlet to get a scheduled site design script. - -## SYNTAX - -```powershell -Get-SPOSiteDesignTask -Identity -WebUrl [] -``` - -## DESCRIPTION - -Used to retrieve a scheduled site design script. It takes the ID of the scheduled site design and the URL fo the SPWeb where the site design is scheduled to be applied. - -> [!NOTE] -> This command only retrieves a previously scheduled request. - -## EXAMPLES - -### -----------------------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 . - -## PARAMETERS - -### -Identity - -The ID of the scheduled site design to apply. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebUrl - -The URL of the site collection where the site design will be applied. - -```yaml -Type: String -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/p/?LinkID=113216). - -## RELATED LINKS - -[Add-SPOSiteDesignTask](Get-SPOSiteDesignTask.md) - -[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md) - -[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.md deleted file mode 100644 index 9134c69cb5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteGroup.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositegroup -applicable: SharePoint Online -title: Get-SPOSiteGroup -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteGroup - -## SYNOPSIS - -Gets all the groups on the specified site collection. - -## SYNTAX - -```powershell -Get-SPOSiteGroup [-Group ] [-Limit ] -Site [] -``` - -## DESCRIPTION - -Use the `Get-SPOSiteGroup` cmdlet to get all the groups on the specified site collection by using the Site parameter. - -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://docs.microsoft.com/powershell/module/sharepoint-online/index). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA -``` - -This example returns all the groups on the specified site collection - -## PARAMETERS - -### -Group - -Specifies the group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit - -Specifies the maximum number of groups to return. The default value is 200. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the site collection scope. - -```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). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Set-SPOSiteGroup](Set-SPOSiteGroup.md) - -[Remove-SPOSiteGroup](Remove-SPOSiteGroup.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteRenameState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteRenameState.md deleted file mode 100644 index 1bc12dedf7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteRenameState.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositerenamestate -applicable: SharePoint Online -title: Get-SPOSiteRenameState -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOSiteRenameState - -## SYNOPSIS - -Returns the current rename job state of a SharePoint Online Site. - -## SYNTAX - -### SourceSiteUrl - -```powershell -Get-SPOSiteRenameState -Identity [-WhatIf] [-Confirm] [] -``` - -### ParentId - -```powershell -Get-SPOSiteRenameState -ParentOperationId [-State ] [-WhatIf] [-Confirm] [] -``` - -### RenameReport - -```powershell -Get-SPOSiteRenameState [-State ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Use this cmdlet to return the current rename job state of a SharePoint Online Site. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOSiteRenameState -Identity https://contoso.sharepoint.com/sites/ContosoWeb1 -``` - -This example returns the rename job state of ContosoWeb1 Site. - -### Example 2 - -```powershell -Get-SPOSiteRenameState -State InProgress -``` - -This example returns rename jobs that are in InProgress state. - -### Example 3 - -```powershell -$tenantRenameJobId = (Get-SPOTenantRenameStatus).RenameJobId -Get-SPOSiteRenameState -ParentOperationId $tenantRenameJobId -``` - -This example returns rename jobs that were initiated by a tenant rename. - -## PARAMETERS - -### -Identity - -The urls of the site to be renamed. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: SourceSiteUrl -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentOperationId - -The parent operation id that initiated the site to be renamed. For example, the tenant rename job id. - -```yaml -Type: guid -Parameter Sets: ParentId -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State - -The state of the rename job, possible values are - -- Queued - -- InProgress - -- Success - -- Failed - -- Suspended - -```yaml -Type: RenameState -Parameter Sets: RenameReport, ParentId -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 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 -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). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md deleted file mode 100644 index 2abd060ecf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositescript -applicable: SharePoint Online -title: Get-SPOSiteScript -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteScript - -## SYNOPSIS - -Displays information about existing site scripts. - -## SYNTAX - -```powershell -Get-SPOSiteScript [[-Identity] ] [] -``` - -## DESCRIPTION - -Displays information about existing site scripts. When no parameter is provided, this cmdlet returns the **Id**, **Title**, **Description**, and **Version** of each site script. When a site script ID is provided, this cmdlet also returns the **Content**, which is the JSON of the site script. - -## EXAMPLES - -### Example 1 - -This example shows how to get script information for a specific script ID. - -```powershell -Get-SPOSiteScript 07702c07-0485-426f-b710-4704241caad9 - -Id : 07702c07-0485-426f-b710-4704241caad9 -Title : Contoso theme -Description : -Content : { - "$schema": "schema.json", - "actions": [ - { - "verb": "applyTheme", - "themeName": "Custom Cyan" - } - ], - "bindata": { }, - "version": 1 - } -Version : 1 -``` - -## PARAMETERS - -### -Identity - -The ID of the site script to get information about. - -```yaml -Type: SPOSiteScriptPipeBind -Parameter Sets: (All) -Aliases: -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/p/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md deleted file mode 100644 index d0047b4aaa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromList.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositescriptfromlist -applicable: SharePoint Online -title: Get-SPOSiteScriptFromList -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOSiteScriptFromList - -## SYNOPSIS - -Creates site script syntax from an existing SharePoint list. - -## SYNTAX - -```powershell -Get-SPOSiteScriptFromList -ListUrl [] -``` - -## DESCRIPTION - -Uses an existing SharePoint list to output a JSON blob that can be used to create a site script for use in a site design. - -## EXAMPLES - -### Example 1 - -This example creates the site script output from an existing list - and writes it to a variable. This variable is then referenced to create a site script. - -```powershell -$extracted = Get-SPOSiteScriptFromList -ListUrl "https://contoso.sharepoint.com/sites/strategy/customer-contacts" -Add-SPOSiteScript ` - -Title "Contoso Customer Tracker" - -Description "This creates a customer contact list" - -Content $extracted -``` - -## PARAMETERS - -### -ListUrl - -The url of the list to be referenced for the JSON output. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 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). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromWeb.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromWeb.md deleted file mode 100644 index e2c6a49b40..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromWeb.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositescriptfromweb -applicable: SharePoint Online -title: Get-SPOSiteScriptFromWeb -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOSiteScriptFromWeb - -## SYNOPSIS - -Creates site script syntax from an existing SharePoint site. - -## SYNTAX - -```powershell -Get-SPOSiteScriptFromWeb [-WebUrl] [-IncludedLists ] [-IncludeBranding] [-IncludeTheme] [-IncludeRegionalSettings] [-IncludeSiteExternalSharingCapability] [-IncludeLinksToExportedItems] [] -``` - -## DESCRIPTION - -Uses an existing SharePoint site to output a JSON blob that can be used to create a site script for use in a site design. - -## EXAMPLES - -### Example 1 - -This example creates the site script output from an existing site - and writes it to a variable. This variable is then referenced to create a site script. - -```powershell -C:\> $extracted = Get-SPOSiteScriptFromWeb ` - -WebUrl https://contoso.sharepoint.com/sites/template ` - -IncludeBranding ` - -IncludeTheme ` - -IncludeRegionalSettings ` - -IncludeSiteExternalSharingCapability ` - -IncludeLinksToExportedItems ` - -IncludedLists ("Shared Documents", "Lists/Project Activities") -C:\> Add-SPOSiteScript ` - -Title "Contoso template site" ` - -Description "This is a copy of a site collection." ` - -Content $extracted -``` - -## PARAMETERS - -### -WebUrl - -The url that starts with HTTPS of the site to retrieve the site script. - -```yaml -Type: string -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludedLists - -An array of one or more lists. Each is identified by the list url. - -```yaml -Type: string[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeBranding - -A switch that if provided, extracts the configuration of the site's branding. - -```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 -``` - -### -IncludeTheme - -A switch that if provided, extracts the site's custom theme by using the themeJson property. - -```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 -``` - -### -IncludeRegionalSettings - -A switch that if provided, extracts the site's regional settings. - -```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 -``` - -### -IncludeSiteExternalSharingCapability - -A switch that if provided, extracts the site's external sharing capability. - -```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 -``` - -### -IncludeLinksToExportedItems - -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 -Parameter Sets: (All) -Aliases: -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/p/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteUserInvitations.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteUserInvitations.md deleted file mode 100644 index 03117e0c4c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteUserInvitations.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spositeuserinvitations -applicable: SharePoint Online -title: Get-SPOSiteUserInvitations -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOSiteUserInvitations - -## SYNOPSIS - -Searches against all stored sharing links and retrieves the email invites. - -## SYNTAX - -```powershell -Get-SPOSiteUserInvitations [-Site] [-EmailAddress] [] -``` - -## DESCRIPTION - -Searches against all stored sharing links on a Site and retrieves the email invites. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOSiteUserInvitations -Site https://contoso.sharepoint.com/sites/ContosoWeb1/ -EmailAddress someone@example.com -``` - -This example retrieves email invites stored in the ContosoWeb1 site to the user with email address someone@example.com. - -## PARAMETERS - -### -Site - -Specifies the URL of the site collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress - -Email Address of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -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](https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStorageEntity.md deleted file mode 100644 index cf893b6563..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStorageEntity.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spostorageentity -applicable: SharePoint Online -title: Get-SPOStorageEntity -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOStorageEntity - -## SYNOPSIS - -Tenant properties allow tenant administrators to add properties in the app catalog that can be read by various SharePoint Framework components. Because tenant properties are stored in the tenant app catalog, you must provide the tenant app catalog site collection URL or the site collection app catalog URL in the following cmdlets. -This cmdlet is used to get a value in the property bag. - -## SYNTAX - -```powershell -Get-SPOStorageEntity [-Site] [-Key] [] -``` - -## DESCRIPTION - -Use this cmdlet to get a value in the property bag. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOStorageEntity -Site "https://tenant-name.sharepoint.com/sites/app-catalog" -Key "MyCustomValues" -``` - -This example returns the whole entry in the property bag. - -## PARAMETERS - -### -Site - -URL to the tenant or site collection app catalog. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Key - -The key in the property bag that should be returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -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](https://go.microsoft.com/fwlink/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheSiteState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheSiteState.md deleted file mode 100644 index 144fdfb9f9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheSiteState.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: -schema: 2.0.0 -applicable: SharePoint Online -title: Get-SPOStructuralNavigationCacheSiteState -author: paramveersisodia -ms.author: paramsis -manager: suyog -ms.reviewer: ---- - -# Get-SPOStructuralNavigationCacheSiteState - -## SYNOPSIS -Get the structural navigation caching state for a site collection. - -## SYNTAX - -``` -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). - -## EXAMPLES - -### Example 1 -```powershell -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. - -## PARAMETERS - -### -SiteUrl -Specifies the absolute URL for the site collection's root web being checked for its caching state. - -```yaml -Type: String -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - 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 online help, type: "get-help Get-SPOStructuralNavigationCacheSiteState -online" - - -## RELATED LINKS -[Get-SPOStructuralNavigationCacheWebState](Get-SPOStructuralNavigationCacheWebState.md) - -[Set-SPOStructuralNavigationCacheWebState](Set-SPOStructuralNavigationCacheWebState.md) - -[Set-SPOStructuralNavigationCacheSiteState](Set-SPOStructuralNavigationCacheSiteState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheWebState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheWebState.md deleted file mode 100644 index 300cd6cae3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOStructuralNavigationCacheWebState.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: -schema: 2.0.0 -applicable: SharePoint Online -title: Get-SPOStructuralNavigationCacheWebState -author: paramveersisodia -ms.author: paramsis -manager: suyog -ms.reviewer: ---- - -# Get-SPOStructuralNavigationCacheWebState - -## SYNOPSIS -Get the structural navigation caching state for a web. - -## SYNTAX - -``` -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). - -## EXAMPLES - -### Example 1 -```powershell -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. - -## PARAMETERS - -### -WebUrl -Specifies the absolute URL for the web being checked for its caching state. - -```yaml -Type: String -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - 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 online help, type: "get-help Get-SPOStructuralNavigationCacheWebState -online" -## RELATED LINKS -[Set-SPOStructuralNavigationCacheWebState](Set-SPOStructuralNavigationCacheWebState.md) - -[Get-SPOStructuralNavigationCacheSiteState](Get-SPOStructuralNavigationCacheSiteState.md) - -[Set-SPOStructuralNavigationCacheSiteState](Set-SPOStructuralNavigationCacheSiteState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md deleted file mode 100644 index 1f4115ad55..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenant.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenant -applicable: SharePoint Online -title: Get-SPOTenant -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenant - -## SYNOPSIS - -Returns SharePoint Online organization properties. - -## SYNTAX - -```powershell -Get-SPOTenant [] -``` - -## DESCRIPTION - -The `Get-SPOTenant` cmdlet returns organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, ResourceQuotaAllocated and SiteCreationMode. - -Currently, there are no parameters for this cmdlet. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -Get-SPOTenant -``` - -This example returns the organization-level site collection properties such as StorageQuota, StorageQuotaAllocated, ResourceQuota, ResourceQuotaAllocated, SiteCreationMode and OneDriveStorageQuota. - -## 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md deleted file mode 100644 index a00ef29c9f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnEnabled.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantcdnenabled -applicable: SharePoint Online -title: Get-SPOTenantCdnEnabled -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantCdnEnabled - -## SYNOPSIS - -Returns whether Public content delivery network (CDN) or Private CDN is enabled on the tenant level. Requires Tenant administrator permissions. - -## SYNTAX - -```powershell -Get-SPOTenantCdnEnabled -CdnType [] -``` - -## DESCRIPTION - -Returns whether Public content delivery network (CDN) or Private CDN is enabled on the tenant level. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOTenantCdnEnabled -CdnType Public -``` - -The example returns a CDN with a type of public. - -## PARAMETERS - -### -CdnType - -Specifies the CDN type. The valid values are Public or Private. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md deleted file mode 100644 index b9d8d0a7fb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnOrigins.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantcdnorigins -applicable: SharePoint Online -title: Get-SPOTenantCdnOrigins -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantCdnOrigins - -## SYNOPSIS - -Lists all the configured origins under the tenancy or under a given site. You must be a SharePoint Online administrator or Global Administrator to run this cmdlet. - -## SYNTAX - -```powershell -Get-SPOTenantCdnOrigins -CdnType [] -``` - -## DESCRIPTION - -Lists all the configured origins under the tenancy or under a given site. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOTenantCdnOrigins -CdnType Public -``` - -The example returns a list of origins from the Tenant. - -## PARAMETERS - -### -CdnType - -Specifies the CDN type. The valid values are: Public or Private. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md deleted file mode 100644 index 7dd1079c2a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantCdnPolicies.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantcdnpolicies -applicable: SharePoint Online -title: Get-SPOTenantCdnPolicies -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantCdnPolicies - -## SYNOPSIS - -Get the public or private Policies applied on your SharePoint Online Tenant. Requires Tenant administrator permissions. - -## SYNTAX - -```powershell -Get-SPOTenantCdnPolicies -CdnType [] -``` - -## DESCRIPTION - -This cmdlet gets the public or private policies applied to a SharePoint Online organization tenant. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOTenantCdnPolicies -CdnType Public -``` - -This example returns public CDN policies of your tenant. - -### Example 2 - -```powershell -Get-SPOTenantCdnPolicies -CdnType Private -``` - -This example returns private CDN policies of your tenant. - -## PARAMETERS - -### -CdnType - -Type of CDN on the current SPO Tenant (Public,Private) - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Set-SPOTenantCdnEnabled](Set-SPOTenantCdnEnabled.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md deleted file mode 100644 index 68f07c48bb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantContentTypeReplicationParameters.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantcontenttypereplicationparameters -applicable: SharePoint Online -title: Get-SPOTenantContentTypeReplicationParameters -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantContentTypeReplicationParameters - -## SYNOPSIS - -Gets content types for replication parameters - -## SYNTAX - -```powershell -Get-SPOTenantContentTypeReplicationParameters [] -``` - -## DESCRIPTION - -Before you run the cmdlets, please use `Connect-SPOService` to connect to SharePoint Online first. -This Cmdlets gets the content types that are being replicated from primary location to satellite - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOTenantContentTypeReplicationParameters -``` - -Gets content types for replication parameters - -## 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). - -## 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) - -[Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) - -[Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) - -[Set-SPOTenantContentTypeReplicationParameters](Set-SPOTenantContentTypeReplicationParameters.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md deleted file mode 100644 index 351873475b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogEntry.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantlogentry -applicable: SharePoint Online -title: Get-SPOTenantLogEntry -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantLogEntry - -## SYNOPSIS - -Retrieves SharePoint Online company logs. This cmdlet is reserved for internal Microsoft use. - -## SYNTAX - -### CorrelationId - -```powershell -Get-SPOTenantLogEntry [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] [[-MaxRows] ] - -CorrelationId [] -``` - -### Source - -```powershell -Get-SPOTenantLogEntry [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] [[-MaxRows] ] - -Source [] -``` - -### User - -```powershell -Get-SPOTenantLogEntry [[-StartTimeInUtc] ] [[-EndTimeInUtc] ] [[-MaxRows] ] - -User [] -``` - -## 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. - -The `Get-SPOTenantLogEntry` cmdlet cannot retrieve all SharePoint Online errors. This cmdlet retrieves a subset of errors that happen due to external systems. - -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. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOTenantLogEntry -``` - -This example retrieves all logs that are available. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Get-SPOTenantLogEntry -MaxRows 500 -``` - -This example retrieves the first 500 log entries. - -### -----------------------EXAMPLE 3----------------------------- - -```powershell -$endTimeinUTC = Get-SPOTenantLogLastAvailableTimeInUtc -$startTimeinUTC = $endTimeinUTC.AddDays(-14) -$tenantlogs = Get-SPOTenantLogEntry -StartTimeinUtc $startTimeinUTC -EndTimeinUTC $endTimeinUTC -``` - -This example retrieves log entries recorded over that previous 14 days. - -### -----------------------EXAMPLE 4----------------------------- - -```powershell -$endTimeinUTC = Get-SPOTenantLogLastAvailableTimeInUtc -$startTimeinUTC = $endTimeinUTC.AddDays(-14) -$tenantlogs = Get-SPOTenantLogEntry -StartTimeinUtc $startTimeinUTC -EndTimeinUTC $endTimeinUTC -CorrelationId e2c2be70-6382-4ce7-8a44-ae7dadff5597 -``` - -This example retrieves log entries recorded over that previous 14 days that have the CorrelationId of "e2c2be70-6382-4ce7-8a44-ae7dadff5597". - -## PARAMETERS - -### -CorrelationId - -Specifies the Correlation ID as a filter. - -```yaml -Type: Guid -Parameter Sets: CorrelationId -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTimeInUtc - -Specifies the end time in UTC to search for logs. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRows - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source - -Specifies the component that logs the errors. - -```yaml -Type: Int32 -Parameter Sets: Source -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTimeInUtc - -Specifies the start time in Coordinated Universal Time (UTC) to search for the logs (for example, 01032011:12:00). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User - -Specifies the log-on identity as a filter. - -```yaml -Type: String -Parameter Sets: User -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md deleted file mode 100644 index 0c4fd6b9f7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantLogLastAvailableTimeInUtc.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantloglastavailabletimeinutc -applicable: SharePoint Online -title: Get-SPOTenantLogLastAvailableTimeInUtc -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantLogLastAvailableTimeInUtc - -## SYNOPSIS - -Returns the most recent time when the SharePoint Online organization logs were collected. - -## SYNTAX - -```powershell -Get-SPOTenantLogLastAvailableTimeInUtc [] -``` - -## DESCRIPTION - -This cmdlet retrieves the time in Coordinated Universal Time (UTC) when the logs were last collected. -After you know the time, you can use the `Get-SPOTenantLogEntry` cmdlet to retrieve the logs. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOTenantLogLastAvailableTimeInUtc -``` - -This example returns the time in UTC when the SharePoint Online organization logs were most recently collected. - -## 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOTenantLogEntry](Get-SPOTenantLogEntry.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelation.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelation.md deleted file mode 100644 index 1eeac7f8ed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelation.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOTenantOrgRelation -applicable: SharePoint Online -title: Get-SPOTenantOrgRelation -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantOrgRelation - -## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. - -## SYNTAX - -```powershell -Get-SPOTenantOrgRelation [] -``` - -## DESCRIPTION - -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 - -```powershell - Get-SPOTenantOrgRelation -``` - -{{ 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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByPartner.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByPartner.md deleted file mode 100644 index 132722470e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByPartner.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOTenantOrgRelationByPartner -applicable: SharePoint Online -title: Get-SPOTenantOrgRelationByPartner -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - - -# Get-SPOTenantOrgRelationByPartner - -## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. - -## SYNTAX - -```powershell -Get-SPOTenantOrgRelationByPartner [-PartnerCompanyId] [[-PartnerInstanceId] ] [] -``` - -## DESCRIPTION - -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 - -```powershell - -``` - -{{ Add example description here }} - -## PARAMETERS - -### -PartnerCompanyId - -{{ Fill PartnerCompanyId Description }} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerInstanceId - -{{ Fill PartnerInstanceId Description }} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -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](http://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/sharepoint-online/Get-SPOTenantOrgRelationByScenario.md deleted file mode 100644 index 5738f77aca..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantOrgRelationByScenario.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOTenantOrgRelationByScenario -applicable: SharePoint Online -title: Get-SPOTenantOrgRelationByScenario -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantOrgRelationByScenario - -## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. - -## SYNTAX - -```powershell -Get-SPOTenantOrgRelationByScenario [-Scenario] [-PartnerRole] - [] -``` - -## DESCRIPTION - -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -PartnerRole - -{{ Fill PartnerRole Description }} - -```yaml -Type: OrgRelationRole -Parameter Sets: (All) -Aliases: -Accepted values: None, Source, Target - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scenario - -{{ Fill Scenario Description }} - -```yaml -Type: OrgRelationScenario -Parameter Sets: (All) -Aliases: -Accepted values: None, MnA - -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](http://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/sharepoint-online/Get-SPOTenantServicePrincipalPermissionGrants.md deleted file mode 100644 index 46d5c6ff7a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionGrants.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantserviceprincipalpermissiongrants -applicable: SharePoint Online -title: Get-SPOTenantServicePrincipalPermissionGrants -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantServicePrincipalPermissionGrants - -## SYNOPSIS - -Gets the collection of permission grants for the "SharePoint Online Client" service principal - -## SYNTAX - -### Default - -```powershell -Get-SPOTenantServicePrincipalPermissionGrants -``` - -## DESCRIPTION - -Gets the collection of permission grants for the "SharePoint Online Client" service principal. - -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. - -- 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------------------ - -```powershell -Get-SPOTenantServicePrincipalPermissionGrants -``` - -Gets the collection of permission grants for the "SharePoint Online Client" service principal. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md deleted file mode 100644 index 01d6e24b26..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantServicePrincipalPermissionRequests.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantserviceprincipalpermissionrequests -applicable: SharePoint Online -title: Get-SPOTenantServicePrincipalPermissionRequests -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantServicePrincipalPermissionRequests - -## SYNOPSIS - -Gets the collection of permission requests for the "SharePoint Online Client" service principal - -## SYNTAX - -### Default - -```powershell -Get-SPOTenantServicePrincipalPermissionRequests -``` - -## DESCRIPTION - -Gets the collection of permission requests for the "SharePoint Online Client" service principal. - -Permission request object - -A permission request contains the following properties: - -- Id: The identifier of the request. - -- Resource: The resource that the application requires access to. - -- Scope: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell -Get-SPOTenantServicePrincipalPermissionRequests -``` - -Gets the collection of permission requests for the "SharePoint Online Client" service principal. diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md deleted file mode 100644 index a79e4168b4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantSyncClientRestriction.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenantsyncclientrestriction -applicable: SharePoint Online -title: Get-SPOTenantSyncClientRestriction -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantSyncClientRestriction - -## SYNOPSIS - -Returns the current configuration status. - -## SYNTAX - -```powershell -Get-SPOTenantSyncClientRestriction -``` - -## DESCRIPTION - -The `Get-SPOTenantSyncClientRestriction` cmdlet returns whether the TenantRestrictionEnabled property is true or false and DomainGUIDs that are currently in the safe recipient list which is represented by the AllowedDomainList property. - -This cmdlet, that does not take any input, also returns the current state of the BlockMacSync and GrooveBlockOption properties. - -You must be a SharePoint Online administrator or Global Administrator to run the cmdlet. - -Requires a valid `Connect-SPOService` context to identify the tenant. For information on how to connect to the tenant, see `Connect-SPOService`. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOTenantSyncClientRestriction -``` - -This example returns a current boolean value of the TenantRestrictionEnabled and BlockMacSync properties and a current set list of domains GUIDs in the AllowedDomainList property. - -## 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-SPOTenantTaxonomyReplicationParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantTaxonomyReplicationParameters.md deleted file mode 100644 index 9ff2fffd36..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTenantTaxonomyReplicationParameters.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotenanttaxonomyreplicationparameters -applicable: SharePoint Online -title: Get-SPOTenantTaxonomyReplicationParameters -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTenantTaxonomyReplicationParameters - -## SYNOPSIS - -Get the replication parameters to manage Multi-Geo taxonomy replication. - -## SYNTAX - -```powershell -Get-SPOTenantTaxonomyReplicationParameters [] -``` - -## 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. - -This Cmdlet gets the replication parameters and it works to get the replication taxonomy in a Multi-Geo tenant. -It works with the [Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) to set the parameters. - -Get the sites to be replicated in a Multi-Geo taxonomy replication. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOTenantTaxonomyReplicationParameters -``` - -Gets the replication groups that are being replicated on the current tenant. - -## 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). - -## 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) - -[Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) - -[Get-SPOTenantContentTypeReplicationParameters](Get-SPOTenantContentTypeReplicationParameters.md) - -[Set-SPOTenantContentTypeReplicationParameters](Set-SPOTenantContentTypeReplicationParameters.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md deleted file mode 100644 index ef5f450244..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOTheme.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spotheme -applicable: SharePoint Online -title: Get-SPOTheme -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOTheme - -## SYNOPSIS - -Retrieves settings for an existing theme. - -## DESCRIPTION - -The **Get-SPOTheme** cmdlet returns the settings for a named existing theme, or for all uploaded themes if no name is provided. - -## EXAMPLES - -### Example 1 - -This example shows how to use the **Get-SPOTheme** cmdlet to return the settings for the `"Custom Cyan"` theme created in the example for the **Add-SPOTheme** cmdlet. Note that this example uses the PowerShell `ConvertTo-Json` filter to display the theme in JSON format. - -```powershell -Get-SPOTheme -Name "Custom Cyan" | ConvertTo-Json -``` - -```powershell -{ - "Name": "Custom Cyan", - "Palette": { - "themeLight": "#affefe", - "themeTertiary": "#76ffff", - "black": "#000000", - "neutralSecondary": "#666666", - "neutralTertiaryAlt": "#c8c8c8", - "themeSecondary": "#39ffff", - "themeDarker": "#005252", - "primaryBackground": "#fff", - "neutralQuaternary": "#d0d0d0", - "neutralPrimaryAlt": "#3c3c3c", - "neutralPrimary": "#333", - "themeDark": "#009090", - "themeLighter": "#daffff", - "neutralTertiary": "#a6a6a6", - "neutralQuaternaryAlt": "#dadada", - "themeLighterAlt": "#f3fcfc", - "white": "#fff", - "neutralSecondaryAlt": "#767676", - "neutralLighter": "#f4f4f4", - "neutralLight": "#eaeaea", - "neutralDark": "#212121", - "themeDarkAlt": "#00c4c4", - "neutralLighterAlt": "#f8f8f8", - "primaryText": "#333", - "themePrimary": "#00ffff" - }, - "IsInverted": false -} -``` - -### Example 2 - -To return all uploaded themes, use the **Get-SPOTheme** command with no arguments. - -```powershell -Get-SPOTheme -``` - - - -## INPUTS - -## OUTPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroup.md deleted file mode 100644 index 4237f48f2a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroup.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spounifiedgroup -applicable: SharePoint Online -title: Get-SPOUnifiedGroup -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOUnifiedGroup - -## SYNOPSIS - -Retrieves the Preferred Data Location for the specified Office 365 Group. - -## SYNTAX - -```powershell -Get-SPOUnifiedGroup [-GroupAlias] [] -``` - -## DESCRIPTION - -Retrieves the Preferred Data Location (PDL) for the specified Office 365 Group. The customer tenant must be multi-geo enabled. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOUnifiedGroup -GroupAlias EUTeam -``` -Returns the PDL for the Office 365 Group named 'EUTeam'. - -## PARAMETERS - -### -GroupAlias - -The alias of the Office 365 Group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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/p/?LinkID=113216). - -## NOTES - -## RELATED LINKS - -[Move a SharePoint site to a different geo location](https://docs.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroupMoveState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroupMoveState.md deleted file mode 100644 index 8aa7dbb186..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroupMoveState.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spounifiedgroupmovestate -applicable: SharePoint Online -title: Get-SPOUnifiedGroupMoveState -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Get-SPOUnifiedGroupMoveState - -## SYNOPSIS - -Returns the state of an Office 365 Group move between Preferred Data Locations. - -## SYNTAX - -```powershell -Get-SPOUnifiedGroupMoveState [-GroupAlias] [] -``` - -## DESCRIPTION - -Retrieves the state of the Office 365 Group move to the Preferred Data Location (PDL) for the specified. The customer tenant must be multi-geo enabled. - -## EXAMPLES - -### Example 1 - -```powershell -Get-SPOUnifiedGroupMoveState -GroupAlias EUTeam -``` - -Returns the status of the move between geos for the Office 365 Group named 'EUTeam'. - -## PARAMETERS - -### -GroupAlias - -The alias of the Office 365 Group. - -```yaml -Type: 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 -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). - -## OUTPUTS - -### System.Object - -The move status for the Office 365 Group. Possible values are: - -* Ready to Trigger: The move has not started. -* Scheduled: The move is in queue but has not yet started. -* InProgress (n/4): The move is in progress in one of the following states: Validation (1/4), Backup (2/4), Restore (3/4), Cleanup (4/4). -* Success: The move has completed successfully. -* Failed: The move failed. - -## NOTES - -You can also apply the `-Verbose` option to see additional information about the move. - -## RELATED LINKS - -[Move a SharePoint site to a different geo location](https://docs.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md deleted file mode 100644 index 21fb7d263b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUser.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spouser -applicable: SharePoint Online -title: Get-SPOUser -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOUser - -## SYNOPSIS - -Returns the SharePoint Online user or security group accounts that match a given search criteria. - -## SYNTAX - -### ByGroup - -```powershell -Get-SPOUser [-Group ] [-Limit ] -Site [] -``` - -### All - -```powershell -Get-SPOUser [-Limit ] -Site [] -``` - -### ByLogin - -```powershell -Get-SPOUser [-LoginName ] -Site [] -``` - -## 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://docs.microsoft.com/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets). - -The `Get-SPOUser` cmdlet matches one and only one user or security group. - -Be sure to run the `Get-SPOUser` cmdlet using a SharePoint Online administrator or Global Administrator and be a site collection administrator of the queried site. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at . - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -``` - -Example 1 returns all user or security group accounts from the site collection . - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -LoginName melissa.kerr@contoso.com -``` - -Example 2 returns one user or security group account whose user name is "melissa.kerr@contoso.com" from the site collection . - -### -----------------------EXAMPLE 3----------------------------- - -```powershell -Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -Group "Team Site Members" -``` - -Example 3 returns one user or security group account inside group Team Site Members from the site collection . - -## PARAMETERS - -### -Group - -Specifies the group to get the users from. - -```yaml -Type: String -Parameter Sets: ByGroup -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limit - -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 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginName - -Specifies the user name. - -```yaml -Type: String -Parameter Sets: ByLogin -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the URL of the site collection to get the user from. - -```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). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Remove-SPOUser](Remove-SPOUser.md) - -[Set-SPOUser](Set-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md deleted file mode 100644 index 6b593c10df..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spouserandcontentmovestate -applicable: SharePoint Online -title: Get-SPOUserAndContentMoveState -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOUserAndContentMoveState - -## SYNOPSIS - -This cmdlet allows SharePoint administrators to check the status of a user or site move across geo locations. - -## SYNTAX - -### MoveReport - -```powershell -Get-SPOUserAndContentMoveState [-Limit ] [-MoveDirection ] [-MoveEndTime ] - [-MoveStartTime ] [-MoveState ] [] -``` - -### OdbMoveId - -```powershell -Get-SPOUserAndContentMoveState -OdbMoveId [] -``` - -### UserPrincipalName - -```powershell -Get-SPOUserAndContentMoveState -UserPrincipalName [] -``` - -## 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. - -The following are the available move states: - -|Status|Description| -| --- | --- | -|ReadyToTrigger| The move is ready to be initiated by an administrator. | -|NotStarted| The move has not started. | -|InProgress| The move is in progress in one of the following states: Validation, Backup, Restore, Cleanup.| -|Success| The move has completed successfully.| -|Failed|The move failed.| - -## EXAMPLES - -### Example 1 - -```Powershell -Get-SPOUserAndContentMoveState -OdbMoveId b298219e-3440-10b8-8931-46e805e2b85b -``` - -Obtain the move state by OneDrive Move Job ID - -### Example 2 - -```Powershell -Get-SPOUserAndContentMoveState -MoveState NotStarted -``` - -Getting which moves are being done in a particular state -### Example 3 - -```Powershell -Get-SPOUserAndContentMoveState -MoveDirection All -``` - -Gives you the output for users moving in and out from the geo location you are logged into - -### Example 4 - -```Powershell -Get-SPOUserAndContentMoveState -MoveDirection In -``` - -Gives you the output for users moving into the geo location that you are logged into - -### Example 5 - -```Powershell -Get-SPOUserAndContentMoveState -MoveDirection Out -``` - -Gives you the output for users moving out from the geo location that you are logged into - -### Example 6 - -```Powershell -Get-SPOUserAndContentMoveState -UserPrincipalName jezz@contoso.com -``` - -Obtains the status of the move for jezz@contoso.com - -## PARAMETERS - -### -Limit - -Get the limit of user on a single call of the parameter - -```yaml -Type: UInt32 -Parameter Sets: MoveReport -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveDirection - -Allows you to define the direction of the user move in relation to your current SharePoint location - -```yaml -Type: Direction -Parameter Sets: MoveReport -Aliases: -Accepted values: All, MoveIn, MoveOut -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveEndTime - -Allows you to obtain the moves that are scheduled to end by a particular time, as defined in UTC - -```yaml -Type: DateTime -Parameter Sets: MoveReport -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveStartTime - -Allows you to obtain the moves that are scheduled to begin at a particular time, as defined in UTC - -```yaml -Type: DateTime -Parameter Sets: MoveReport -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveState - -Move State current status. - -```yaml -Type: State -Parameter Sets: MoveReport -Aliases: -Accepted values: All, NotStarted, Scheduled, InProgress, Stopped, Success, Failed -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OdbMoveId - -OneDrive GUID MoveID that you get when you start a job. - -```yaml -Type: Guid -Parameter Sets: OdbMoveId -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName - -User Principal name is the unique property on Azure AD for each user. - -```yaml -Type: String -Parameter Sets: UserPrincipalName -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md deleted file mode 100644 index 8d122a1f78..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserOneDriveLocation.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spouseronedrivelocation -applicable: SharePoint Online -title: Get-SPOUserOneDriveLocation -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOUserOneDriveLocation - -## SYNOPSIS - -This cmdlet will return the user principal name, current location, and corresponding OneDrive for Business url, and the site ID. This cmdlet only supports Multi-Geo OneDrive sites. - -## SYNTAX - -```powershell -Get-SPOUserOneDriveLocation -UserPrincipalName [] -``` - -## DESCRIPTION - -This command will return information about the OneDrive location for the specified user. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOUserOneDriveLocation -UserPrincipalName admin@contoso.com -``` - -Get the current location the user's OneDrive location, url, and site ID. - -## PARAMETERS - -### -UserPrincipalName - -PARAMVALUE: String - -```yaml -Type: String -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md deleted file mode 100644 index eadd89fdbe..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOWebTemplate.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/get-spowebtemplate -applicable: SharePoint Online -title: Get-SPOWebTemplate -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Get-SPOWebTemplate - -## SYNOPSIS - -Displays all site templates that match the given identity. - -## SYNTAX - -```powershell -Get-SPOWebTemplate [[-LocaleId] ] [-CompatibilityLevel ] [-Name ] [-Title ] - [] -``` - -## DESCRIPTION - -The `Get-SPOWebTemplate` cmdlet displays all site templates that match the given identity and are available in SharePoint Online. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Get-SPOWebTemplate -``` - -Example 1 returns all the site templates in the language of the administrator site. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Get-SPOWebTemplate -LocaleID 1036 -``` - -Example 2 returns a list of all the French site templates. - -## PARAMETERS - -### -CompatibilityLevel - -Specifies the compatibility level of the site template. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocaleId - -Specifies the Locale ID of the site template. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the name of the site template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title - -Specifies the Locale ID of the site template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md deleted file mode 100644 index 81568ad7be..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOHubSiteRights.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/grant-spohubsiterights -applicable: SharePoint Online -title: Grant-SPOHubSiteRights -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Grant-SPOHubSiteRights - -## SYNOPSIS - -Grants rights to users or mail-enabled security groups to associate their site with a hub site. - -## SYNTAX - -```powershell -Grant-SPOHubSiteRights [-Identity] -Principals - -Rights {Join} [] -``` - -## DESCRIPTION - -Applies permissions to a set of users or mail-enabled security groups. Use this cmdlet to scope visibility of who can associate their site with the hub site when using the SharePoint user interface. Hub sites are public by default. Once you set permissions, only those groups or users you specified can associate their site with the hub site. - -To view which users or groups have permissions to a site, use the [Get-SPOHubSite](Get-SPOHubSite.md) cmdlet. - -## EXAMPLES - -### Example 1 - -```powershell -Grant-SPOHubSiteRights https://contoso.sharepoint.com/sites/Marketing --Principals nestorw@contoso.onmicrosoft.com --Rights Join -``` - -This example shows how to grant rights to Nestor (a user at the fictional Contoso site) to associate his sites with the marketing hub site. - -## PARAMETERS - -### -Identity - -URL of the hub site. - -```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 -``` - -### -Principals - -One or more principles to add permissions for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rights - -Always set to the value **Join**. Any user or group with **Join** permissions can view and join the hub site. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md deleted file mode 100644 index 0a9105019f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/grant-spositedesignrights -applicable: SharePoint Online -title: Grant-SPOSiteDesignRights -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Grant-SPOSiteDesignRights - -## SYNOPSIS - -Used to apply permissions to a set of users or a security group, effectively scoping the visibility of the site design in the UX. They start off public, but after you set permissions, only those groups or users with permissions can access the site design. - -## SYNTAX - -```powershell -Grant-SPOSiteDesignRights - [-Identity] - -Principals - -Rights {View} - [] -``` - -## DESCRIPTION - -Used to apply permissions to a set of users or a security group, effectively scoping the visibility of the site design in the UX. They start off public, but after you set permissions, only those groups or users with permissions can access the site design. - -## EXAMPLES - -### Example 1 - -This example shows how to grant view rights on a site design to Nestor (a user at the fictional Contoso site). - -```powershell -Grant-SPOSiteDesignRights ` - -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` - -Principals "nestorw@contoso.onmicrosoft.com" ` - -Rights View -``` - -## PARAMETERS - -### -Identity - -The ID of the site design to get scoping information. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principals - -One or more principles to add permissions for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rights - -Always set to the value **View**. Any user or group with view permissions can view and use the site design. - -```yaml -Type: SPOSiteDesignPrincipalRights -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md b/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md deleted file mode 100644 index 50256ef7f9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOMigrationEncryptUploadSubmit.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/invoke-spomigrationencryptuploadsubmit -applicable: SharePoint Online -title: Invoke-SPOMigrationEncryptUploadSubmit -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Invoke-SPOMigrationEncryptUploadSubmit - -## SYNOPSIS - -Creates a new migration job in the target site collection - -## SYNTAX - -### ImplicitSourceParameterSet - -```powershell -Invoke-SPOMigrationEncryptUploadSubmit -Credentials - -MigrationSourceLocations [-NoLogFile] -TargetWebUrl [] -``` - -### ExplicitSourceParameterSet - -```powershell -Invoke-SPOMigrationEncryptUploadSubmit -Credentials [-NoLogFile] - -SourceFilesPath -SourcePackagePath -TargetWebUrl [] -``` - -## DESCRIPTION - -Creates a new migration job in the target site collection, and then returns a GUID representing the JobID. This command will upload encrypted source files and manifests into temporary Azure blob storage per job. - -## EXAMPLES - -### Example 1 - -```powershell -$job = Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesPath $sourceFiles -SourcePackagePath $spoPackagePath -Credentials $cred -TargetWebUrl $targetWebUrl -``` - -This example shows how to submit package data to create a new migration job - -### Example 2 - -```Powershell -$sourceFiles = "sourceFiles" -$spoPackagePath = "packagePath" -$credentials = Get-Credential -$targetweburl = "https://contoso.sharepoint.com/" -Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesPath $sourceFiles -SourcePackagePath $spoPackagePath -Credentials $credentials -TargetWebUrl $targetweburl -``` - -This example shows how to submit package data to create a new migration job. - -This article contains the steps on how to create this package: - -### Example 3 - -This example shows how to submit package data to create new migration jobs for parallel import. - -```Powershell -$jobs = $finalPackages | % {Invoke-SPOMigrationEncryptUploadSubmit -SourceFilesPath $_.FilesDirectory.FullName -SourcePackagePath $_.PackageDirectory.FullName -Credentials $cred -TargetWebUrl $targetWeb} -``` - -## PARAMETERS - -### -Credentials - -Parameter to fill out credentials of the SPO tenant. - -```yaml -Type: CredentialCmdletPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationSourceLocations - -Migration Location where the package lies. - -```yaml -Type: MigrationPackageLocation -Parameter Sets: ImplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile - -Controls if a log will be created or not - -```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 -``` - -### -SourceFilesPath - -Source files Path, string - -```yaml -Type: String -Parameter Sets: ExplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePackagePath - -Source Package Path. - -```yaml -Type: String -Parameter Sets: ExplicitSourceParameterSet -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl - -Target web URL - -```yaml -Type: String -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[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) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md deleted file mode 100644 index 1a8d0a1a55..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/invoke-spositedesign -applicable: SharePoint Online -title: Invoke-SPOSiteDesign -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Invoke-SPOSiteDesign - -## SYNOPSIS - -Applies a published site design to a specified site collection target. This allows a site design to be applied to an existing site collection. The supported site templates you can apply a site design to include: "modern" team site (with O365 group), "modern" team site (without an O365 group); communication site; classic team site; and classic publishing site. - -## SYNTAX - -```powershell -Invoke-SPOSiteDesign - [-Identity] - -WebUrl - [] -``` - -## DESCRIPTION - -Applies a published site design to a specified site collection target. This allows a site design to be applied to an existing site collection. - -## EXAMPLES - -### Example 1 - -This example applies a site design whose script creates two lists, formats several of the columns, adds the lists to the site navigation, and then joins the site to an existing hub site. - -```powershell -Invoke-SPOSiteDesign -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectgo" - -Title Outcome ----------------------------------------------- ------- -Create or update list Project Activities Success -Update list description Success -Create column Project Status Success -Create column Effort (days) Success -Set custom formatter for field Project Status Success -Set custom formatter for field Effort (days) Success -Create or update list Project Collateral Success -Create column Due Date Success -Set custom formatter for field Due Date Success -Add Project Activities to left nav Success -Add Project Collateral to left nav Success -Add to Hub Site Success -``` - -## PARAMETERS - -### -Identity - -The ID of the site design to apply. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebUrl - -The URL of the site collection where the site design will be applied. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteSwap.md b/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteSwap.md deleted file mode 100644 index 805216e2e2..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteSwap.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/invoke-spositeswap -applicable: SharePoint Online -title: Invoke-SPOSiteSwap -schema: 2.0.0 -author: WayneEwington -ms.author: waynewin -ms.reviewer: ---- - -# Invoke-SPOSiteSwap - -## SYNOPSIS - -Invokes a job to swap the location of a site with another site while archiving the original site. - -## SYNTAX - -```Powershell -Invoke-SPOSiteSwap - -SourceUrl - -TargetUrl - -ArchiveUrl - [-DisableRedirection] - [-Force] - [-NoWait] - [] -``` - -## DESCRIPTION - -Swaps the location of a source site with a target site while archiving the original target site. - -Please note, the target site must be either: - -- The root site, for example ; or -- The search center site, for example . - -When the swap is initiated, the target site is moved to the archive location and the source site is moved to the target location. By default, a site redirect is created at the source location that will redirect traffic to the target location. - -If the target is the root site at , then the following preparation activities should be performed prior to performing the swap: - -1. Any Featured links defined in SharePoint Start Page at 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 may also need to run the [Page Diagnostic Tool](https://docs.microsoft.com/office365/enterprise/page-diagnostics-for-spo) against 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. - -If the Publishing feature has previously been activated or is currently activated on the source site, Invoke-SPOSiteSwap cannot be used. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Invoke-SPOSiteSwap -SourceUrl https://contoso.sharepoint.com/sites/CommunicationSite -TargetUrl https://contoso.sharepoint.com -ArchiveUrl https://contoso.sharepoint.com/sites/Archive -``` - -Archives the existing site at  to and moves to A site redirect will be created at that will redirect any requests to - -### EXAMPLE 2 - -```powershell -Invoke-SPOSiteSwap -SourceUrl https://contoso.sharepoint.com/sites/SearchSite -TargetUrl https://contoso.sharepoint.com/search -ArchiveUrl https://contoso.sharepoint.com/sites/Archive -``` - -Archives the existing Search Center site at  to and moves the to A site redirect be created at that will redirect any requests to - -### EXAMPLE 3 - -```powershell -Invoke-SPOSiteSwap -SourceUrl https://contoso.sharepoint.com/sites/CommunicationSite -TargetUrl https://contoso.sharepoint.com -ArchiveUrl https://contoso.sharepoint.com/sites/Archive -DisableRedirection -``` - -Archives the existing site at  to and moves to A site redirect will not be created at - -### EXAMPLE 4 - -```powershell -Invoke-SPOSiteSwap -SourceUrl https://contoso.sharepoint.com/sites/SearchSite -TargetUrl https://contoso.sharepoint.com/search -ArchiveUrl https://contoso.sharepoint.com/sites/Archive -Force -``` - -Archives the existing Search Center site at  to and moves the to A site redirect be created at that will redirect any requests to Any warnings identified by the Page Diagnostic Tool will be ignored and the swap will be initiated. However, any errors identified by the Page Diagnostic Tool will still prevent the swap from being initiated. - -## PARAMETERS - -### -SourceUrl - -URL of the source site. The site at this location must exist before performing the swap. - -If the target is the root site at then the source site must be either a Modern Team Site (STS#3) or a Communication Site (SITEPAGEPUBLISHING#0) and **the publishing feature can never have been activated on the source site**. - -If the target is the search center site at then the source site must be either a Search Center Site (SRCHCEN#0) or a Basic Search Center Site (SRCHCENTERLITE#0). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUrl - -URL of the target site that the source site will be swapped to. The site at this location must exist before performing the swap. - -The target site must be either: - -- The root site at or -- The search center site at - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArchiveUrl - -URL that the target site will be archived to. There should be no existing site, including a deleted site in the Recycle Bin, at this location before performing the swap. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableRedirection - -Disables the site redirect from being created at the Source URL location. - -```yaml -Type: Switch Parameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -Overrides and ignores any warnings that have been identified by the Page Diagnostic Tool that are preventing a swap from being initiated. - -For example, if you receive the warning "Invoke-SPOSiteSwap : Errors: 0; Warnings: 1; Details: 2 items are not in CDN, please enable CDN." Warnings can be overriden using this parameter but the items should be reviewed and resolved for long-term stability and performance. - -Any errors identified by the Page Diagnostic Tool will still always prevent a swap from being initiated regardless of this parameter. - -```yaml -Type: Switch Parameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Switch Parameter -Parameter Sets: (All) -Aliases: -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). - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) -[Modernize your root site](https://docs.microsoft.com/sharepoint/modern-root-site) -[Manage site redirects](https://docs.microsoft.com/sharepoint/manage-site-redirects) -[Page Diagnostic Tool](https://docs.microsoft.com/office365/enterprise/page-diagnostics-for-spo) 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 6a31098e62..0000000000 --- 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://docs.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-SPOMigrationEncryptionParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationEncryptionParameters.md deleted file mode 100644 index acec63f17e..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationEncryptionParameters.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters -applicable: SharePoint Online -title: New-SPOMigrationEncryptionParameters -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPOMigrationEncryptionParameters - -## SYNOPSIS - -Creates a new random encryption key for a migration job or package. - -## SYNTAX - -```powershell -New-SPOMigrationEncryptionParameters [] -``` - -## DESCRIPTION - -Creates a random encryption key for submission of a migration job or creation of a migration package. For use with [`Submit-SPOMigrationJob`](), [`ConvertTo-SPOMigrationEncryptedPackage`](ConvertTo-SPOMigrationEncryptedPackage.md), and [`Set-SPOMigrationPackageAzureSource`](Set-SPOMigrationPackageAzureSource.md) in the `-EncryptedParameter` parameter for each cmdlet. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -$o = New-SPOMigrationEncryptionParameters -``` - -Outputs a random encryption key and saves it in the `$o` variable. - -## 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). - -## OUTPUTS - -### System.Byte - -EncryptionKey: The randomly generated encryption key using [System.Security.Cryptography.AesCryptoServiceProvider](https://docs.microsoft.com/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. - -## RELATED LINKS - -[Submit-SPOMigrationjob](Submit-SPOMigrationJob.md) - -[ConvertTo-SPOMigrationEncryptedPackage](ConvertTo-SPOMigrationEncryptedPackage.md) - -[Set-SPOMigrationPackageAzureSource](Set-SPOMigrationPackageAzureSource.md) - -[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) - diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md deleted file mode 100644 index 194d6dff72..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOMigrationPackage.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/new-spomigrationpackage -applicable: SharePoint Online -title: New-SPOMigrationPackage -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPOMigrationPackage - -## SYNOPSIS - -Cmdlet to create a new migration package based on source files in a local or network shared folder. - -## SYNTAX - -```powershell -New-SPOMigrationPackage [-SourceFilesPath] [-OutputPackagePath] [[-TargetWebUrl] ] - [[-TargetDocumentLibraryPath] ] [[-TargetDocumentLibrarySubFolderPath] ] [-IgnoreHidden] - [-IncludeFileSharePermissions] [-NoAzureADLookup] [-NoLogFile] [-ReplaceInvalidCharacters] - [] -``` - -## DESCRIPTION - -Cmdlet to create a new migration package based on source files in a local or network shared folder. - -> [!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----------------------------- - -```powershell -New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_SrcPkg - -New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_SrcPkg -TargetWebUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -TargetDocumentLibraryPath "Shared Documents" -TargetDocumentLibrarySubFolderPath "Sub Folder/Target Folder" -``` - -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----------------------------- - -```powershell -New-SPOMigrationPackage -SourceFilesPath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_SrcPkg -TargetWebUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -TargetDocumentLibraryPath "Shared Documents" -``` - -This example creates a new set of migration source package metadata files in the d:\MigrationPackages\Folder1_SrcPkg directory based on content files found in the \\fileserver\share\folder1 source location. The package is prepared using the document library path "https://contoso.sharepoint.com/sites/TargetSite/TargetWeb/Shared%20Documents". - -## PARAMETERS - -### -IgnoreHidden - -Switch to ignore hidden files and folders. - -```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 -``` - -### -IncludeFileSharePermissions - -Used to include permissions and sharing information into the generated manifest files in the package metadata. - -```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 -``` - -### -NoAzureADLookup - -Switch to not lookup local user accounts in Azure Active Directory. - -```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 -``` - -### -NoLogFile - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputPackagePath - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplaceInvalidCharacters - -Switch to replace characters in file and folder names that would be invalid in SharePoint Online. - -```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 -``` - -### -SourceFilesPath - -The directory location where the source content files exist. This directory will be enumerated to create the package metadata files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDocumentLibraryPath - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDocumentLibrarySubFolderPath - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -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, " will be used instead within the package metadata. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -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](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/sharepoint-online/New-SPOPublicCdnOrigin.md deleted file mode 100644 index 06547b83b7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOPublicCdnOrigin.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/new-spopubliccdnorigin -applicable: SharePoint Online -title: New-SPOPublicCdnOrigin -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPOPublicCdnOrigin - -## SYNOPSIS - -Creates a new public CDN on a document library in your SharePoint Online Tenant - -## SYNTAX - -```powershell -New-SPOPublicCdnOrigin [-Url] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION - -This Cmdlet creates a new Public CDN Origin in your SPO Tenant - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -New-SPOPublicCdnOrigin -URL https://contoso.sharepoint.com/sites/CDN/CDNFilesLibrary/ -``` - -This example shows how to you can setup a new Public CDN on a document library in your SharePoint online tenant. - -## 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 -``` - -### -Url - -Specify the URL that will be enabled for Public CDN in your tenant - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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). - -## 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) - -[SharePoint Online Management Shell Download](https://www.microsoft.com/en-US/download/details.aspx?id=35588) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOPublicCdnOrigins](Get-SPOPublicCdnOrigins.md) - -[Remove-SPOPublicCdnOrigin](Remove-SPOPublicCdnOrigin.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md deleted file mode 100644 index f07734d547..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSdnProvider.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/new-sposdnprovider -applicable: SharePoint Online -title: New-SPOSdnProvider -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPOSdnProvider - -## SYNOPSIS - -Adds a new Software-Defined Networking (SDN) provider - -## SYNTAX - -```powershell -New-SPOSdnProvider [-Identity] [-License] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION - -This Cmdlet creates a new Software-Defined Networking, and it receives two parameters, the Identity (ID) of the Hive and the License key of the Hive. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -New-SPOSdnProvider -ID "Hive" -License "" -``` - -This example creates the Hive for a SDN Provider. - -## 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 - -Identity of the provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -License - -License key provided by the provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -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). - -## 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) - -[Remove-SPOSdnProvider](Remove-SPOSdnProvider.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md deleted file mode 100644 index 150d6dc760..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSite.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/new-sposite -applicable: SharePoint Online -title: New-SPOSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPOSite - -## SYNOPSIS - -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 [] -``` - -## DESCRIPTION - -The `New-SPOSite` cmdlet creates a new site collection for the current company. -However, creating a new SharePoint Online site collection fails if a deleted site with the same URL exists in the Recycle Bin. - -You must be a SharePoint Online administrator or Global Administrator to run the cmdlet. - -For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at . - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -New-SPOSite -Url https://contoso.sharepoint.com/sites/mynewsite -Owner joe.healy@contoso.com -StorageQuota 1000 -Title "My new site collection" -``` - -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----------------------------- - -```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" -``` - -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----------------------------- - -```powershell -New-SPOSite -Url https://contoso.sharepoint.com/sites/accounting -Owner admin@contoso.com -StorageQuota 100 -NoWait -ResourceQuota 50 -Template STS#0 -``` - -Example 3 creates a new site collection for the current company with specified site URL, owner and template. The storage quota is set to 100 megabytes and the resource quota is set to 50 megabytes. This cmdlet is executed immediately without delay. - -## PARAMETERS - -### -CompatibilityLevel - -This parameter no longer has any effect and only accepts a value of '15'. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait - -Specifies to continue executing script 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 -``` - -### -Owner - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -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://docs.microsoft.com/previous-versions/office/developer/sharepoint-2010/gg615462(v=office.14)). Note that this parameter is now obsolete and has been deprecated. - -```yaml -Type: Double -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuota - -Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Template - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZoneId - -Specifies the time zone of the site collection. For more information, see [SPRegionalSettings.TimeZones Property](https://docs.microsoft.com/dotnet/api/microsoft.sharepoint.spregionalsettings.timezones). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title - -Specifies the title of the site collection. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url - -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 -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOSite](Get-SPOSite.md) - -[Set-SPOSite](Set-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md deleted file mode 100644 index dd0dfef919..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteGroup.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/new-spositegroup -applicable: SharePoint Online -title: New-SPOSiteGroup -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPOSiteGroup - -## SYNOPSIS - -Creates a new group in a SharePoint Online site collection. - -## SYNTAX - -```powershell -New-SPOSiteGroup -Group -PermissionLevels -Site [] -``` - -## DESCRIPTION - -A SharePoint group is a set of individual users. -SharePoint groups enable you to manage sets of users instead of individual users. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -New-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA -Group "Project Leads" -PermissionLevels "Full Control" -``` - -This example creates a group named Project Leads with the Full Control permission level on the site collection - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -New-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/marketing -Group "NewGroupName" -PermissionLevels "Design" -``` - -This example creates a group named NewGroupName with the Design permission level on the site collection - -## PARAMETERS - -### -Group - -Specifies the name of the group to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionLevels - -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://docs.microsoft.com/sharepoint/how-to-create-and-edit-permission-levels) for more information. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the site collection to add the group 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 -``` - -### 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[New-SPOSite](New-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOTenantOrgRelation.md b/sharepoint/sharepoint-ps/sharepoint-online/New-SPOTenantOrgRelation.md deleted file mode 100644 index 2133c53043..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/New-SPOTenantOrgRelation.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/New-SPOTenantOrgRelation -applicable: SharePoint Online -title: New-SPOTenantOrgRelation -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# New-SPOTenantOrgRelation - -## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. - -## SYNTAX - -```poowershell -New-SPOTenantOrgRelation [-Scenario] [-PartnerRole] [-PartnerCompanyId] [-PartnerInstanceId ] [-PartnerSiteSubscriptionId ] [] -``` - -## DESCRIPTION - -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -PartnerCompanyId - -{{ Fill PartnerCompanyId Description }} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -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 -Parameter Sets: (All) -Aliases: -Accepted values: None, Source, Target - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerSiteSubscriptionId - -{{ Fill PartnerSiteSubscriptionId Description }} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scenario - -{{ Fill Scenario Description }} - -```yaml -Type: OrgRelationScenario -Parameter Sets: (All) -Aliases: -Accepted values: None, MnA - -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS 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 c907834fc7..0000000000 --- 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://docs.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/Register-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md deleted file mode 100644 index a12ef2c78f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/register-spodataencryptionpolicy -applicable: SharePoint Online -title: Register-SPODataEncryptionPolicy -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Register-SPODataEncryptionPolicy - -## 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://docs.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) - -## SYNTAX - -```powershell -Register-SPODataEncryptionPolicy -PrimaryKeyVaultName -PrimaryKeyName -PrimaryKeyVersion -SecondaryKeyVaultName -SecondaryKeyName -SecondaryKeyVersion [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Use the Update-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://docs.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) - -## EXAMPLES - -### Example 1 - -```powershell -Register-SPODataEncryptionPolicy -PrimaryKeyVaultName 'PKVaultName1' -PrimaryKeyName 'PrimaryKey1' -PrimaryKeyVersion 'f635a23bd4a44b9996ff6aadd88d42ba' -SecondaryKeyVaultName 'SKVaultName1' -SecondaryKeyName 'SecondaryKey2' -SecondaryKeyVersion '2b3e8f1d754f438dacdec1f0945f251a’ -``` -This example registers the DEP used with SharePoint Online and OneDrive for Business to start using the given primary key. - -## PARAMETERS - -### -PrimaryKeyVaultName - -The name of the primary key vault - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryKeyName - -The name of the primary key - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryKeyVaultName - -The name of the secondary key vault - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryKeyName - -The name of the secondary key - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -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. - -```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 -``` - -### -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. - -- 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. - -```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 -``` - -### 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). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md deleted file mode 100644 index a0b1aaf42b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Register-SPOHubSite.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/register-spohubsite -applicable: SharePoint Online -title: Register-SPOHubSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Register-SPOHubSite - -## SYNOPSIS - -Enables the hub site feature on a site to make it a hub site. For more information visit [SharePoint hub sites overview](https://docs.microsoft.com/sharepoint/dev/features/hub-site/hub-site-overview). - -## SYNTAX - -```powershell -Register-SPOHubSite -Site -Principals [] -``` - -## DESCRIPTION - -Use this cmdlet to register an existing site collection as a hub site. - -> [!IMPORTANT] -> A maximum of 2000 hub sites may be created per tenant, with 'unlimited' number of site collections associated to a hub site. -> [!NOTE] -> It can take up to 2-4 hours for the changes to appear. - -## EXAMPLES - -### Example 1 - -```powershell -Register-SPOHubSite https://contoso.sharepoint.com/sites/Marketing -Principals $null -``` - -This example registers the marketing site on Contoso as hub site without setting any principals for it. - -## PARAMETERS - -### -Site - -Specifies the URL of the site collection to which to enable the hub site features. - -```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 -``` - -### -Principals - -Specifies One or more principles (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: string[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## NOTES - -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. 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 be010bad6d..0000000000 --- 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://docs.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://docs.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/Remove-SPODeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md deleted file mode 100644 index c0653dffb0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPODeletedSite.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spodeletedsite -applicable: SharePoint Online -title: Remove-SPODeletedSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPODeletedSite - -## SYNOPSIS - -Removes a SharePoint Online deleted site collection from the Recycle Bin. - -## SYNTAX - -```powershell -Remove-SPODeletedSite [-Confirm] -Identity [-NoWait] [-WhatIf] [] -``` - -## DESCRIPTION - -The `Remove-SPODeletedSite` cmdlet permanently removes a SharePoint Online deleted site collection from the Recycle Bin. - -You must be a SharePoint Administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -**Note**: As of today, the modern admin center UI does not allow permanent deletion of group connected site, but the use of this cmdlet does allow the deletion, but when this occurs it does not delete the associated group, just the site. - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- - -```powershell -Remove-SPODeletedSite -Identity https://contoso.sharepoint.com/sites/sitetoremove -``` - -This example removes a SharePoint Online deleted site collection named from the Recycle Bin and deletes it permanently. - -## 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 URL of the site collection to remove. - -```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 -``` - -### -NoWait - -Continues without the status being polled. Polling the action can slow its progress. - -```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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Remove-SPOSite](Remove-SPOSite.md) - -[Get-SPODeletedSite](Get-SPODeletedSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOExternalUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOExternalUser.md deleted file mode 100644 index 03832ab098..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOExternalUser.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spoexternaluser -applicable: SharePoint Online -title: Remove-SPOExternalUser -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOExternalUser - -## SYNOPSIS - -Removes a collection of external users from the tenancy's folder. - -## SYNTAX - -```powershell -Remove-SPOExternalUser [-Confirm] -UniqueIDs [-WhatIf] [] -``` - -## DESCRIPTION - -The `Remove-SPOExternalUser` cmdlet permanently removes a collection of external users from the tenancy's folder. - -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- - -```powershell -$user = Get-SPOExternalUser -Filter someone@example.com -Remove-SPOExternalUser -UniqueIDs @($user.UniqueId) -``` - -This example removes a specific external user who has the address "someone@example.com". Organization members may still see the external user name displayed in the Shared With dialog, but the external user will not be able to sign in and will not be able to access any tenant resources. - -## 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 -``` - -### -UniqueIDs - -Specifies an ID that can be used to identify an external user based on their Windows Live ID. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOExternalUser](Get-SPOExternalUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md deleted file mode 100644 index 083e1d1c19..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOGeoAdministrator.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spogeoadministrator -applicable: SharePoint Online -title: Remove-SPOGeoAdministrator -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOGeoAdministrator - -## SYNOPSIS - -Removes a new SharePoint user or security Group in the current Multi-Geo Tenant. - -## SYNTAX - -```powershell -Remove-SPOGeoAdministrator [-LoginName] [] -``` - -## 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://docs.microsoft.com/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 a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOGeoAdministrator contosoadmin -``` - -Remove the GeoAdministrator privileges to the user contosoadmin of the SharePoint Online multi-geo tenant. - -### Example 2 - -```powershell -Remove-SPOGeoAdministrator -LoginName contosoadmin -``` - -Same as example 1, but using the LoginName parameter explicitly. - -## PARAMETERS - -### -LoginName - -It's the user Principal Name or UPN of a user. Typically the username that he uses to log in. - -```yaml -Type: String -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) - -[Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHomeSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHomeSite.md deleted file mode 100644 index 09cc2cedfb..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHomeSite.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spohomesite -applicable: SharePoint Online -title: Remove-SPOHomeSite -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Remove-SPOHomeSite - -## SYNOPSIS - -Removes the current SharePoint Online Home site setting. - -## SYNTAX - -```powershell -Remove-SPOHomeSite [] -``` - -## DESCRIPTION - -Use this cmdlet to remove the current SharePoint Online Home Site setting. - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOHomeSite -``` - -This example removes the current SharePoint Online Home Site setting. - -## 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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md deleted file mode 100644 index 446a8beebf..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubSiteAssociation.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spohubsiteassociation -applicable: SharePoint Online -title: Remove-SPOHubSiteAssociation -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOHubSiteAssociation - -## SYNOPSIS - -Removes a site from its associated hub site. - -## SYNTAX - -```powershell -Remove-SPOHubSiteAssociation [-Site] -[] -``` - -## DESCRIPTION - -Use this cmdlet to remove an association between a site and a hub site. - -> [!IMPORTANT] -> This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments. - -If the site or hub site doesn't exist, this cmdlet returns a "File not found" error. - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOHubSiteAssociation https://contoso.sharepoint.com/sites/Research -``` - -This example removes the research site from the marketing hub site. - -## PARAMETERS - -### -Site - -URL of the site to remove from the hub site. - -```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 -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubToHubAssociation.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubToHubAssociation.md deleted file mode 100644 index 1469494200..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOHubToHubAssociation.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spohubtohubassociation -applicable: SharePoint Online -title: Remove-SPOHubToHubAssociation -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Remove-SPOHubToHubAssociation - -## SYNOPSIS - -Removes the selected hub site from its parent hub. - -## SYNTAX - -```powershell -Remove-SPOHubToHubAssociation [-HubSiteId] [] -``` - -## DESCRIPTION - -Use this cmdlet to remove the selected hub site from its parent hub. - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOHubToHubAssociation -HubSiteId 6638bd4c-d88d-447c-9eb2-c84f28ba8b15 -``` - -This example removes the site with the given id from its parent Hub. - -## PARAMETERS - -### -HubsiteId - -Id of the Hub site to be removed from its parent Hub. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md deleted file mode 100644 index 0db6d0cb22..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMigrationJob.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spomigrationjob -applicable: SharePoint Online -title: Remove-SPOMigrationJob -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOMigrationJob - -## SYNOPSIS - -Cmdlet to remove a previously created migration job from the specified site collection. - -## SYNTAX - -```powershell -Remove-SPOMigrationJob [-TargetWebUrl] [-JobId] -Credentials - [-NoLogFile] [] -``` - -## DESCRIPTION - -Cmdlet to remove a previously created migration job from the specified site collection. - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- - -```powershell -Remove-SPOMigrationJob -JobId 4da9e777-3e38-4804-96d9-ddeebe7dfa79 -TargetUrl https://contoso.sharepoint.com/sites/TargetSite -``` - -This example removes the specified migration job from the site collection " - -## PARAMETERS - -### -Credentials - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JobId - -Id of a previously created migration job that exists on the target site collection. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile - -Indicates to not create a log file. The default is to create a new DeleteMigrationJob log file within the current directory. - -```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 -``` - -### -TargetWebUrl - -The fully qualified URL of the site collection where the job will be deleted if found. - -```yaml -Type: String -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 - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMultiGeoCompanyAllowedDataLocation.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMultiGeoCompanyAllowedDataLocation.md deleted file mode 100644 index 772a84d463..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOMultiGeoCompanyAllowedDataLocation.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spomultigeocompanyalloweddatalocation -applicable: SharePoint Online -title: Remove-SPOMultiGeoCompanyAllowedDataLocation -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Remove-SPOMultiGeoCompanyAllowedDataLocation - -## SYNOPSIS - -Use this cmdlet to remove a multi geo allowed location. - -## SYNTAX - -```powershell -Remove-SPOMultiGeoCompanyAllowedDataLocation [-Location] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Removes a specified multi-geo location that was previously allowed by [Set-SPOMultiGeoCompanyAllowedDataLocation](Set-SPOMultiGeoCompanyAllowedDataLocation.md). - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOMultiGeoCompanyAllowedDataLocation -Location AUS -``` -Removes AUS (Australia) as an allowed mutli-geo location. - -## PARAMETERS - -### -Location - -The Preferred Data Location (PDL) to remove. - -```yaml -Type: 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 -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). - -## NOTES - -## RELATED LINKS - -[Set-SPOMultiGeoCompanyAllowedDataLocation](Set-SPOMultiGeoCompanyAllowedDataLocation.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgAssetsLibrary.md deleted file mode 100644 index 883be53c14..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgAssetsLibrary.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spoorgassetslibrary -applicable: SharePoint Online -title: Remove-SPOOrgAssetsLibrary -author: Maralesfahanpoor -ms.author: maesfaha -ms.reviewer: -manager: paulac -schema: 2.0.0 ---- - -# Remove-SPOOrgAssetsLibrary - -## SYNOPSIS - -Removes a library that was designated as a central location for organization assets across the tenant. - -## SYNTAX - -```powershell -Remove-SPOOrgAssetsLibrary [-LibraryUrl ] [-ListId ] [] -``` - -## DESCRIPTION - -The Remove-SPOOrgAssetsLibrary cmdlet removes a library that was designated as a central location for organization assets across the tenant. Once this cmdlet is run, this library will no longer be accessible from the "Your organization" tab in the file picker. When running the cmdlet, either the library URL or library ID (not both) needs to be indicated. - -Once the library is removed, CDN will still be enabled for this library. To disable CDN for this library, use Remove-SPOTenantCdnOrigin with the server relative URL (example: /sites/branding/assets). - -## EXAMPLES - -### Example 1 - -This example removes https://contoso.sharepoint.com/sites/branding/Assets as a designated library using the library ID. Assets within this library will no longer be accessible from the "Your organization" tab in the file picker. - -```powershell -Remove-SPOOrgAssetsLibrary -ListId 58454454-6546-6466-9769-646464623988 -``` - -## PARAMETERS - -### -LibraryUrl - -Indicates the server relative URL of the library to be removed as a central location for organization assets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ListId - -Indicates the library ID for the library to be removed as a central location for organization assets. - -```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 -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/add-spoorgassetslibrary?view=sharepoint-ps) - -[Set-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/set-spoorgassetslibrary?view=sharepoint-ps) - -[Get-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/get-spoorgassetslibrary?view=sharepoint-ps) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgNewsSite.md deleted file mode 100644 index 53bddbc7c6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOOrgNewsSite.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spoorgnewssite -applicable: SharePoint Online -title: Remove-SPOOrgNewsSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen ---- - -# Remove-SPOOrgNewsSite - -## SYNOPSIS - -Removes a given site from the list of organizational news sites based on its URL in your SharePoint Online Tenant - -## SYNTAX - -```powershell -Remove-SPOOrgNewsSite -OrgNewsSiteUrl [] -``` - -## DESCRIPTION - -This cmdlet will remove a site from list of organizational news sites based on its URL. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Remove-SPOOrgNewsSite -OrgNewsSiteUrl https://contoso.sharepoint.com/sites/Marketing -``` - -This example removes from the list of organizational news sites. - -## PARAMETERS - -### -OrgNewsSiteUrl - -The URL of a site to be marked as an organizational news site. - -```yaml -Type: String -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 - -[Get-SPOOrgNewsSite](Get-SPOOrgNewsSite.md) - -[Set-SPOOrgNewsSite](Set-SPOOrgNewsSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md deleted file mode 100644 index 426827f3c7..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOPublicCdnOrigin.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spopubliccdnorigin -applicable: SharePoint Online -title: Remove-SPOPublicCdnOrigin -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOPublicCdnOrigin - -## SYNOPSIS - -Removes a given public CDN origin based on its identity (id) in your SharePoint Online Tenant - -## SYNTAX - -```powershell -Remove-SPOPublicCdnOrigin [-Identity] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION - -This cmdlet will remove a Public CDN Origin based on its identity. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -#Get a list of CDN origins - -Get-SPOPublicCdnOrigins -Id Url --- --- -11270051ee79e73829f6e7a3ee5d900d49c4fc5901645c642b799ecb62787a5069ca80fb HTTPS://CONTOSO.SHAREPOINT.COM/SITES/CDN... -#then remove the CDN by Identity id GUID. -Remove-SPOPublicCdnOrigin -Identity 11270051ee79e73829f6e7a3ee5d900d49c4fc5901645c642b799ecb62787a5069ca80fb -``` - -This example returns a list of CDN origins and then removes an origin based on the identity. - -## 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 - -It's the unique identifier of the Public CDN path, it can be queried using the Cmdlet Get-SpoPublicCdnOrigins - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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). - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) - -[New-SPOPublicCdnOrigin](New-SPOPublicCdnOrigin.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md deleted file mode 100644 index 8cc9c06dbd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSdnProvider.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-sposdnprovider -applicable: SharePoint Online -title: Remove-SPOSdnProvider -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOSdnProvider - -## SYNOPSIS - -Removes Software-Defined Networking (SDN) Support in your SharePoint Online tenant - -## SYNTAX - -```powershell -Remove-SPOSdnProvider [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION - -Removes SDN Support in your SharePoint Online tenant - -## EXAMPLES - -### EXAMPLE 1 - -```yaml -Remove-SPOSdnProvider -Confirm:false -``` - -This command removes the SDN support for your Online Tenant without confirmation. - -### -----------------------EXAMPLE 2----------------------------- - -```yaml -Remove-SPOSdnProvider -Confirm:true -WhatIf -``` - -This command will prompt for a confirmation before "simulating" that it will remove the support for SDN in the current SPO tenant (-WhatIf) - -## 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 -``` - -### -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). - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[New-SPOSdnProvider](New-SPOSdnProvider.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md deleted file mode 100644 index 90cfb9b321..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSite.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-sposite -applicable: SharePoint Online -title: Remove-SPOSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOSite - -## SYNOPSIS - -Sends a SharePoint Online site collection to the SharePoint Online Recycle Bin. - -## SYNTAX - -```powershell -Remove-SPOSite [-Confirm] -Identity [-NoWait] [-WhatIf] [] -``` - -## DESCRIPTION - -The `Remove-SPOSite` cmdlet does not delete a site collection from the site collections list permanently. -Instead, the removed site collection is moved to the Recycle Bin. -You can use the `Restore-SPODeletedSite`cmdlet to restore a site collection from the Recycle Bin. -To delete a site collection permanently, first move the site collection to the Recycle Bin by using the `Remove-SPOSite` cmdlet and then delete it from the Recycle Bin by using the `Remove-SPODeletedSite` cmdlet. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Remove-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -NoWait -``` - -This example immediately removes the site collection named from the site collections list and moves it to the Recycle Bin. - -## 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 URL of the site collection to remove. - -```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 -``` - -### -NoWait - -Specifies to continue executing script 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 -``` - -### -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Remove-SPODeletedSite](Remove-SPODeletedSite.md) - -[Restore-SPODeletedSite](Restore-SPODeletedSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteCollectionAppCatalog.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteCollectionAppCatalog.md deleted file mode 100644 index 1f86579e46..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteCollectionAppCatalog.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spositecollectionappcatalog -applicable: SharePoint Online -title: Remove-SPOSiteCollectionAppCatalog -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Remove-SPOSiteCollectionAppCatalog - -## SYNOPSIS - -Removes the site collection app catalog. - -## SYNTAX - -```powershell -Remove-SPOSiteCollectionAppCatalog [-Site] [] -``` - -## DESCRIPTION - -Use this cmdlet to remove the site collection app catalog. - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOSiteCollectionAppCatalog -Site https://contoso.sharepoint.com/sites/Research -``` - -This example removes the site collection app catalog from the site - -## PARAMETERS - -### -Site - -Url of the site collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteCollectionAppCatalogById.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteCollectionAppCatalogById.md deleted file mode 100644 index 09cb5a5eb0..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteCollectionAppCatalogById.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spositecollectionappcatalogbyid -applicable: SharePoint Online -title: Remove-SPOSiteCollectionAppCatalogById -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Remove-SPOSiteCollectionAppCatalogById - -## SYNOPSIS - -Removes the site collection app catalog by the id of the site collection. - -## SYNTAX - -```powershell -Remove-SPOSiteCollectionAppCatalogById -SiteId [] -``` - -## DESCRIPTION - -Use this cmdlet to remove the site collection app catalog by the id of the site collection. - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOSiteCollectionAppCatalogById -SiteId bdbd7458-8199-4e99-87ca-15fe9dc17a86 -``` - -This example removes the site collection app catalog from the site with the id 'bdbd7458-8199-4e99-87ca-15fe9dc17a86'. - -## PARAMETERS - -### -SiteId - -Guid of the site collection. - -```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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md deleted file mode 100644 index a8307d1fae..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spositedesign -applicable: SharePoint Online -title: Remove-SPOSiteDesign -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOSiteDesign - -## SYNOPSIS - -Removes a site design. It no longer appears in the UI for creating a new site. - -## SYNTAX - -```powershell - Remove-SPOSiteDesign - [-Identity] - [] -``` - -## DESCRIPTION - -Removes a site design. It no longer appears in the UI for creating a new site. - -## EXAMPLES - -### Example 1 - -This example shows how to remove a site design. - -```powershell -Remove-SPOSiteDesign 21209d88-38de-4844-9823-f1f600a1179a -``` - -## PARAMETERS - -### -Identity - -The ID of the site design to remove. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md deleted file mode 100644 index 4f0e41a146..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesignTask.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -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/remove-spositedesigntask -applicable: SharePoint Online -title: Remove-SPOSiteDesignTask -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOSiteDesignTask - -## SYNOPSIS - -Command to remove a scheduled site design script. - -## SYNTAX - -```powershell -Remove-SPOSiteDesignTask - -Identity - [] -``` - -## DESCRIPTION - -Removes a scheduled site design by providing the site design ID. If the execution of the associated site script has already started the execution will not be terminated. - -> [!NOTE] -> This command only removes a scheduled request. To check on the job status or to view details of the scheduled run, use the commands in the related section below. - -## EXAMPLES - -### Example 1 - -This example removes a previously scheduled site design. - -```powershell -Remove-SPOSiteDesignTask -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -``` - -## PARAMETERS - -### -Identity - -The ID of the site design to apply. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## RELATED LINKS - -[Get-SPOSiteDesignTask](Get-SPOSiteDesignTask.md) - -[Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md) - -[Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md deleted file mode 100644 index 61b93fdcd3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteGroup.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spositegroup -applicable: SharePoint Online -title: Remove-SPOSiteGroup -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOSiteGroup - -## SYNOPSIS - -Removes a SharePoint Online group from a site collection. - -## SYNTAX - -```powershell -Remove-SPOSiteGroup -Identity -Site [] -``` - -## DESCRIPTION - -Use the `Remove-SPOSiteGroup` cmdlet to remove a group from a site collection by specifying the name of the group in the Identity parameter. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- - -```powershell -Remove-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/marketing -Identity GroupToRemove -``` - -This example removes a group named GroupToRemove from the site collection - -## PARAMETERS - -### -Identity - -Specifies the name of the group to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the site collection to remove the group from. - -```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). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOSiteGroup](Get-SPOSiteGroup.md) - -[New-SPOSiteGroup](New-SPOSiteGroup.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md deleted file mode 100644 index 6a8bd2c963..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spositescript -applicable: SharePoint Online -title: Remove-SPOSiteScript -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOSiteScript - -## SYNOPSIS - -Removes a site script. - -## SYNTAX - -```powershell -Remove-SPOSiteScript [-Identity] [] -``` - -## EXAMPLES - -### Example 1 - -This example shows how to remove a site design. - -```powershell -Remove-SPOSiteScript 5ea28194-6fe7-4e2c-ba84-c409368278e2 -``` - -## DESCRIPTION - -Removes a site script. - -## PARAMETERS - -### -Identity - -The ID of the site script to remove. - -```yaml -Type: SPOSiteScriptPipeBind -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/p/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteUserInvitations.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteUserInvitations.md deleted file mode 100644 index 40bf0829e5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteUserInvitations.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spositeuserinvitations -applicable: SharePoint Online -title: Remove-SPOSiteUserInvitations -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Remove-SPOSiteUserInvitations - -## SYNOPSIS - -. - -## SYNTAX - -```powershell -Remove-SPOSiteUserInvitations [-Site] [-EmailAddress] [-CountOnly] [] -``` - -## DESCRIPTION - -. - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOSiteUserInvitations -Site https://contoso.sharepoint.com/sites/Research -EmailAddress "someone@contoso.com" -``` - -This example removes the user with the mail address "someone@contoso.com" from the site with the url - -## PARAMETERS - -### -Site - -Specifies the URL of the site collection. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress - -Email Address of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CountOnly - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOStorageEntity.md deleted file mode 100644 index 32e6c08fee..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOStorageEntity.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spostorageentity -applicable: SharePoint Online -title: Remove-SPOStorageEntity -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Remove-SPOStorageEntity - -## SYNOPSIS - -Tenant properties allow tenant administrators to add properties in the app catalog that can be read by various SharePoint Framework components. Because tenant properties are stored in the tenant app catalog, you must provide the tenant app catalog site collection URL or the site collection app catalog URL in the following cmdlets. -This cmdLet is used to remove a value in the property bag. - -## SYNTAX - -```powershell -Remove-SPOStorageEntity [-Site] [-Key] [] -``` - -## DESCRIPTION - -Use this cmdlet to remove a value within the property bag. - -## EXAMPLES - -### Example 1 - -```powershell -Remove-SPOStorageEntity "https://tenant-name.sharepoint.com/sites/app-catalog" -Key "MyCustomValue" -``` - -This example removes the value of my custom value. - -## PARAMETERS - -### -Site - -URL to the tenant or site collection app catalog. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Key - -The key in the property bag that should be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True -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). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md deleted file mode 100644 index 7c24d72ff3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantCdnOrigin.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spotenantcdnorigin -applicable: SharePoint Online -title: Remove-SPOTenantCdnOrigin -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOTenantCdnOrigin - -## SYNOPSIS - -Removes a new origin from the Public or Private content delivery network (CDN). Requires Tenant administrator permissions. - -## SYNTAX - -```powershell -Remove-SPOTenantCdnOrigin -CdnType [-Confirm] -OriginUrl [-WhatIf] [] -``` - -## DESCRIPTION - -Removes a new origin from the Public or Private content delivery network (CDN). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Remove-SPOTenantCdnOrigin -CdnType Public -OriginUrl sites/pubsite/siteassets/subfolder -``` - -The example removes a CDN from a tenant level. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Remove-SPOTenantCdnOrigin -CdnType Public -OriginScope Site -Site https://contoso.sharepoint.com/sites/pubsite -OriginUrl siteassets/subfolder -``` - -The example removes a CDN from a site level. - -## PARAMETERS - -### -CdnType - -Specifies the CDN type. The valid values are: Public or Private. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online - -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: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online - -Required: False -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 - -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: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -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 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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantOrgRelation.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantOrgRelation.md deleted file mode 100644 index 2dad5797f6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantOrgRelation.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/Remove-SPOTenantOrgRelation -applicable: SharePoint Online -title: Remove-SPOTenantOrgRelation -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- -# Remove-SPOTenantOrgRelation - -## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. - -## SYNTAX - -```powershell -Remove-SPOTenantOrgRelation [-Scenario] [-PartnerRole] [-PartnerCompanyId] [-PartnerInstanceId ] [] -``` - -## DESCRIPTION - -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -PartnerCompanyId - -{{ Fill PartnerCompanyId Description }} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -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 -Parameter Sets: (All) -Aliases: -Accepted values: None, Source, Target - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scenario - -{{ Fill Scenario Description }} - -```yaml -Type: OrgRelationScenario -Parameter Sets: (All) -Aliases: -Accepted values: None, MnA - -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](http://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/sharepoint-online/Remove-SPOTenantSyncClientRestriction.md deleted file mode 100644 index 525179e185..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTenantSyncClientRestriction.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spotenantsyncclientrestriction -applicable: SharePoint Online -title: Remove-SPOTenantSyncClientRestriction -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOTenantSyncClientRestriction - -## SYNOPSIS - -Disables the feature for the tenancy. - -## SYNTAX - -```powershell -Remove-SPOTenantSyncClientRestriction [] -``` - -## DESCRIPTION - -You must be a SharePoint Online administrator or Global Administrator to run the cmdlet. - -Requires a valid `Connect-SPOService` context to identify the tenant. For information on how to connect to the tenant, see `Connect-SPOService`. - -The `Remove-SPOTenantSyncClientRestriction` cmdlet disables the feature for tenancy, but does not remove any present domain GUID entries from the safe sender recipient list. After the `Remove-SPOTenantSyncClientRestriction` cmdlet is run it can take up to 24 hours for change to take effect. This parameter will also remove any values set from the GrooveBlockOption parameter for syncing. - -The `Remove-SPOTenantSyncClientRestriction` cmdlet does not have any parameters. - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- - -```powershell -Remove-SPOTenantSyncClientRestriction -``` - -This example returns the value of False for the TenantRestrictionEnabled property. - -## 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-SPOTheme.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md deleted file mode 100644 index ceff9ecdff..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spotheme -applicable: SharePoint Online -title: Remove-SPOTheme -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOTheme - -## SYNOPSIS - -Removes a theme from the theme gallery. - -## SYNTAX - -```powershell -Remove-SPOTheme [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The **Remove-SPOTheme** cmdlet removes a theme from your tenant store. - -## EXAMPLES - -### Example 1 - -This example removes the `"Custom Cyan"` theme that was used in the previous examples for the **Add-SPOTheme** and **Get-SPOTheme** cmdlets. - -```powershell -Remove-SPOTheme -Identity "Custom Cyan" -``` - -## 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 -``` - -### -Identity - -Name of the theme to remove. - -```yaml -Type: SpoThemePipeBind -Parameter Sets: (All) -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -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 - -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](http://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/Remove-SPOUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUser.md deleted file mode 100644 index 24b2d94b89..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUser.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spouser -applicable: SharePoint Online -title: Remove-SPOUser -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOUser - -## SYNOPSIS - -Removes a user or a security group from a site collection or a group. - -## SYNTAX - -```powershell -Remove-SPOUser [-Group ] -LoginName -Site [] -``` - -## DESCRIPTION - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE----------------------------- - -```powershell -Remove-SPOUser -Site https://contoso.sharepoint.com/sites/sc1 -LoginName joe.healy@contoso.com -Group "SC1 Owners" -``` - -This example removes a user who has the email address joe.healy@contoso.com from the group SC1 Owners in the site collection - -## PARAMETERS - -### -Group - -Specifies the group to remove the user from. If not specified, the cmdlet removes the user from all groups. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginName - -Specifies the user name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the site collection to remove the user from. - -```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). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOUser](Get-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md deleted file mode 100644 index 4350a83a73..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserInfo.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spouserinfo -applicable: SharePoint Online -title: Remove-SPOUserInfo -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOUserInfo - -## SYNOPSIS - -Do not use. - -## DESCRIPTION - -Do not use. - -## EXAMPLES - -## PARAMETERS - -### -LoginName - -Do not use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Do not use. - -```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). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPOUserProfile](Remove-SPOUserProfile.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md deleted file mode 100644 index 12002c296b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOUserProfile.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spouserprofile -applicable: SharePoint Online -title: Remove-SPOUserProfile -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Remove-SPOUserProfile - -## SYNOPSIS - -Remove user profile from the tenant. - -## SYNTAX - -```powershell -Remove-SPOUserProfile -LoginName [] -``` - -## DESCRIPTION - -Can be used to remove the SharePoint user profile from the tenant. - -> [!NOTE] -> The User must be first be deleted from AAD before the user profile can be deleted. You can use the Azure AD cmdlet Remove-AzureADUser for this action - -## EXAMPLES - -### ------------ Example 1 -------------------- - -```powershell -Remove-SPOUserProfile -LoginName joe.healy@contoso.com -``` - -Example 1 removes a user who has the e-mail address joe.healy@contoso.com from the SharePoint Online User Profiles of the particular tenant. - -## PARAMETERS - -### -LoginName - -Specifies the login name of the user which user profile is deleted. - -```yaml -Type: String -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-SPOUserInfo](Remove-SPOUserInfo.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md deleted file mode 100644 index f6f9566f41..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Repair-SPOSite.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/repair-sposite -applicable: SharePoint Online -title: Repair-SPOSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Repair-SPOSite - -## SYNOPSIS - -Checks and repairs the site collection and its contents. - -## SYNTAX - -```powershell -Repair-SPOSite [-Confirm] -Identity [-RuleId ] [-RunAlways] [-WhatIf] - [] -``` - -## DESCRIPTION - -The `Repair-SPOSite` cmdlet runs one or all site collection health checks on the site collection and its contents. -This cmdlet will make changes if issues are found and automatically repairable. - -The cmdlet reports the health check rules with a summary of the results. -The rules might not support automatic repair. -Tests without repair mode can be initiated by running the `Test-SPOSite` cmdlet. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -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----------------------------- - -```powershell -Repair-SPOSite https://contoso.sharepoint.com/sites/marketing -RuleID "ee967197-ccbe-4c00-88e4-e6fab81145e1" -``` - -This example runs the Missing Galleries Check rule in repair mode on the site collection. - -## 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 on which to run the repairs. - -```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 -``` - -### -RuleId - -Specifies a health check rule to run. - -For example: - -- "ee967197-ccbe-4c00-88e4-e6fab81145e1" for Missing Galeries. -- "befe203b-a8c0-48c2-b5f0-27c10f9e1622" for Conflicting Content Types. -- "a9a6769f-7289-4b9f-ae7f-5db4b997d284" for Missing Parent Content Types. -- "5258ccf5-e7d6-4df7-b8ae-12fcc0513ebd" for Missing Site Templates. -- "99c946f7-5751-417c-89d3-b9c8bb2d1f66" for Unsupported Language Pack References. -- "6da06aab-c539-4e0d-b111-b1da4408859a" for Unsupported MUI References. - -```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 -``` - -### -RunAlways - -Displays a message that explains the effect of the command instead of executing the command. - -```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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Test-SPOSite](Test-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md deleted file mode 100644 index b93bb744f9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOPersonalSite.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/request-spopersonalsite -applicable: SharePoint Online -title: Request-SPOPersonalSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Request-SPOPersonalSite - -## SYNOPSIS - -Requests that one or more users be enqueued for a Personal Site to be created. - -## SYNTAX - -```powershell -Request-SPOPersonalSite [-NoWait] -UserEmails [] -``` - -## 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. -- 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"}`. - -## EXAMPLES - -### ----------------------EXAMPLE 1----------------------- - -```powershell -$emails = "user1@contoso.com", "user2@contoso.com" -Request-SPOPersonalSite -UserEmails $emails -``` - -This example requests that two users to be enqueued for the creation of a Personal Site. - -### ----------------------EXAMPLE 2----------------------- - -```powershell -Request-SPOPersonalSite -UserEmails $emails -``` - -This example requests that many users to be queued for the creation of a Personal Site. The users are previously defined using the variable $emails. - -## PARAMETERS - -### -NoWait - -Continues without the status being polled. Polling the action can slow it's progress if lots of user emails are specified. - -```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 -``` - -### -UserEmails - -Specifies one or more user logins to be enqueued for the creation of a Personal Site. The Personal site is created by a Timer Job later. You can specify between 1 and 200 users. -> [!NOTE] -> If you're pre-provisioning OneDrive for a large number of users, it might take multiple days for the OneDrive locations to be created. - -```yaml -Type: String[] -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 - -### System.String[] - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md deleted file mode 100644 index 2eb6a5fc7a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Request-SPOUpgradeEvaluationSite.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/request-spoupgradeevaluationsite -applicable: SharePoint Online -title: Request-SPOUpgradeEvaluationSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Request-SPOUpgradeEvaluationSite - -## SYNOPSIS - -Requests to create a copy of an existing site collection for the purposes of validating the effects of upgrade without affecting the original site. - -## SYNTAX - -```powershell -Request-SPOUpgradeEvaluationSite [-Confirm] -Identity [-NoEmail] [-NoUpgrade] [-WhatIf] - [] -``` - -## DESCRIPTION - -The `Request-SPOUpgradeEvaluationSite` cmdlet lets the SharePoint Online administrator request a copy of an existing site collection for the purposes of validating the effects of upgrade without affecting the original site. - -A request for an upgrade evaluation site is not automatically processed. -Instead, it is scheduled to occur on the background when it causes the least effect on the service. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -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----------------------------- - -```powershell -Request-SPOUpgradeEvaluationSite https://contoso.sharepoint.com/sites/marketing -NoEmail $true -NoUpgrade $true -``` - -This example requests a site upgrade evaluation for the marketing site It specifies to not send email messages and not automatically try upgrade of the evaluation site. By using the cmdlet in this way, a SharePoint Online administrator or Global Administrator can make changes to the upgrade evaluation site before starting the actual upgrade. - -## 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 for which you want to request a copy for the new Upgrade or Evaluation site collection. - -```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 an email message at the end of the upgrade evaluation site creation 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 -``` - -### -NoUpgrade - -Specifies that the system not perform an upgrade as part of the evaluation site creation 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 -``` - -### -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Upgrade-SPOSite](Upgrade-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODataEncryptionPolicy.md deleted file mode 100644 index 897c6bba2d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODataEncryptionPolicy.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/restore-spodataencryptionpolicy -applicable: SharePoint Online -title: Restore-SPODataEncryptionPolicy -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Restore-SPODataEncryptionPolicy - -## SYNOPSIS - -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://docs.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) - -## SYNTAX - -```powershell -Restore-SPODataEncryptionPolicy -PrimaryKeyVaultName -PrimaryKeyName -PrimaryKeyVersion -SecondaryKeyVaultName -SecondaryKeyName -SecondaryKeyVersion [] -``` - -## 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://docs.microsoft.com/microsoft-365/compliance/controlling-your-data-using-customer-key) - -## EXAMPLES - -### Example 1 - -```powershell -Restore-SPODataEncryptionPolicy -PrimaryKeyVaultName 'PKVaultName1' -PrimaryKeyName 'PrimaryKey1' -PrimaryKeyVersion 'f635a23bd4a44b9996ff6aadd88d42ba' -SecondaryKeyVaultName 'SKVaultName1' -SecondaryKeyName 'SecondaryKey2' -SecondaryKeyVersion '2b3e8f1d754f438dacdec1f0945f251a’ -``` -This example restores the DEP used with SharePoint Online and OneDrive for Business to the given keys. - -## PARAMETERS - -### -PrimaryKeyVaultName - -The name of the primary key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryKeyName - -The name of the primary key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryKeyVaultName - -The name of the secondary key vault. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryKeyName - -The name of the secondary key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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) -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/p/?LinkID=113216). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md deleted file mode 100644 index 5cce9fae27..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Restore-SPODeletedSite.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/restore-spodeletedsite -applicable: SharePoint Online -title: Restore-SPODeletedSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Restore-SPODeletedSite - -## SYNOPSIS - -Restores a SharePoint Online deleted site collection from the Recycle Bin. - -## SYNTAX - -```powershell -Restore-SPODeletedSite -Identity [-NoWait] [] -``` - -## DESCRIPTION - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- - -```powershell -Restore-SPODeletedSite -Identity https://contoso.sharepoint.com/sites/arecycledsite -``` - -This example restores a SharePoint Online deleted site collection named " from the Recycle Bin. - -## PARAMETERS - -### -Identity - -Specifies the URL of the site collection to restore. - -```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 -``` - -### -NoWait - -Specifies to continue executing script 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 -``` - -### 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPODeletedSite](Get-SPODeletedSite.md) - -[Remove-SPODeletedSite](Remove-SPODeletedSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md deleted file mode 100644 index 33240403ee..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOHubSiteRights.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/revoke-spohubsiterights -applicable: SharePoint Online -title: Revoke-SPOHubSiteRights -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Revoke-SPOHubSiteRights - -## SYNOPSIS - -Revokes rights for specified principals to a hub. - -## SYNTAX - -```powershell -Revoke-SPOHubSiteRights [-Identity] -Principals [] -``` - -## DESCRIPTION - -Revokes rights for specified principals to the given hub site. The specified principals will no longer be able to associate sites with the hub. To find which principals have access to a hub site, use the [Get-SPOHubSite](Get-SPOHubSite.md) cmdlet. - -> [!NOTE] -> If the hub site doesn't exist, this cmdlet returns a "File not found" error. - -## EXAMPLES - -### Example 1 - -```powershell -Revoke-SPOHubSiteRights https://contoso.sharepoint.com/sites/Marketing ` --Principals "nestorw@contoso.onmicrosoft.com" -``` - -This example shows how to revoke rights so that Nestor can no longer join sites to the Marketing hub site. - -## PARAMETERS - -### -Identity - -URL of the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: HubSite -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principals - -One or more principals to revoke the permissions for. - -```yaml -Type: String[] -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/p/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md deleted file mode 100644 index fcf4b25b4b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/revoke-spositedesignrights -applicable: SharePoint Online -title: Revoke-SPOSiteDesignRights -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Revoke-SPOSiteDesignRights - -## SYNOPSIS - -Revokes rights for specified principals from a site design. - -## SYNTAX - -```powershell -Revoke-SPOSiteDesignRights [-Identity] -Principals [] -``` - -## DESCRIPTION - -Revokes rights for specified principals from a site design. - -## EXAMPLES - -### Example 1 - -This example shows how to revoke rights to a site design for Nestor. - -```powershell -Revoke-SPOSiteDesignRights 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` - -Principals "nestorw@contoso.onmicrosoft.com" -``` - -## PARAMETERS - -### -Identity - -The ID of the site design from which to revoke rights. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Principals - -One or more principals to revoke rights on the specified site design. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md deleted file mode 100644 index 53599e5d41..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOTenantServicePrincipalPermission.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/revoke-spotenantserviceprincipalpermission -applicable: SharePoint Online -title: Revoke-SPOTenantServicePrincipalPermission -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- -# Revoke-SPOTenantServicePrincipalPermission - -## SYNOPSIS - -Revokes a permission that was previously granted to the "SharePoint Online Client" service principal - -## SYNTAX - -### Default - -```powershell -Revoke-SPOTenantServicePrincipalPermission -ObjectId -``` - -## DESCRIPTION - -Revokes a permission that was previously granted to the "SharePoint Online Client" service principal. - -## EXAMPLES - -### ------------------EXAMPLE 1------------------ - -```powershell -$grants = Get-SPOTenantServicePrincipalPermissionGrants -$grantToRemove = $grants | ? { $_.Resource -eq 'Office 365 SharePoint Online' -and $_.Scope -eq 'MyFiles.Read' } | Select-Object -First 1 - -if ($grantToRemove -ne $null) -{ - Revoke-SPOTenantServicePrincipalPermission -ObjectId $grantToRemove.ObjectId -} -``` - -Revokes the permission associated with the 'Office 365 SharePoint Online' resource and with scope claim 'MyFiles.Read'. -If there is no permission with those properties, then no revoke action will be taken. - -## PARAMETERS - -### -ObjectId - -The Object ID of the permission grant to revoke - -```yaml -Type: string - -Required: True -Position: Named -Accept pipeline input: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md deleted file mode 100644 index f8ba9751cc..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/revoke-spousersession -applicable: SharePoint Online -title: Revoke-SPOUserSession -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Revoke-SPOUserSession - -## SYNOPSIS - -Provides IT administrators the ability to invalidate a particular users' O365 sessions across all their devices. - -## SYNTAX - -```powershell -Revoke-SPOUserSession [-User] [-Confirm] [-WhatIf] [] -``` - -## DESCRIPTION - -You must be a SharePoint Online administrator or Global Administrator to run the cmdlet. - -Requires a valid `Connect-SPOService` context to identify the tenant. For information about how to connect to the tenant, see `Connect-SPOService`. - -When the cmdlet is ran the following will occur: - -User will be signed out of browser, desktop and mobile applications accessing Office 365 resources across all devices. - -Will not be applicable for guest users. - -Possible results for this cmdlet are: - -Result | Reason ---- | --- -Warning : We couldn't find the user@contoso.com. Check for typos and try again. | Invalid input for -User parameter. -We successfully signed out from all devices. | Successful instantaneous revocation. -It can take up to an hour to sign out from all devices. | Successful non-instantaneous revocation. -Sorry, something went wrong and we couldn't sign out from any device. | The cmdlet did not successfully execute. -The cmdlet will be available in the future, but it isn't ready for use in your organization yet. | The cmdlet has been disabled for the tenant. - -## EXAMPLES - -### ----------------------EXAMPLE----------------------- - -```powershell -Revoke-SPOUserSession -User user1@contoso.com -``` - -This example signs out user1 in the contoso tenancy from all devices. - -## 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 -``` - -### -User - -Specifies a user name. For example, user1@contoso.com - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 0 -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBrowserIdleSignOut.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBrowserIdleSignOut.md deleted file mode 100644 index e77b54e596..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBrowserIdleSignOut.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spobrowseridlesignout -applicable: SharePoint Online -title: Set-SPOBrowserIdleSignOut -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOBrowserIdleSignOut - -## SYNOPSIS - -Sets the current configuration values for Idle session sign-out. - -## SYNTAX - -```powershell -Set-SPOBrowserIdleSignOut [-Enabled] [[-WarnAfter] ] [[-SignOutAfter] ] [] -``` - -## DESCRIPTION - -Use this cmdlet to set the current configuration values for Idle session sign-out, the time at which users are warned and subsequently signed out of Office 365 after a period of browser inactivity in SharePoint and OneDrive - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOBrowserIdleSignOut -Enabled:$true -WarnAfter "0.00:45:00" -SignOutAfter "0.01:00:00" -``` - -This example enables the browser idle sign-out policy, sets a warning at 45 minutes and signs out users after a period of 60 minutes of browser inactivity. - -### Example 2 - -```powershell -Set-SPOBrowserIdleSignOut -Enabled:$true -WarnAfter (New-TimeSpan -Minutes 45) -SignOutAfter (New-TimeSpan -Hours 1) -``` - -This example enables the browser idle sign-out policy, sets a warning at 45 minutes and signs out users after a period of 60 minutes of browser inactivity. This example leverages the use of New-TimeSpan cmdlet to create the required timespan values. - -## PARAMETERS - -### -Enabled - -Enables the browser idle sign-out policy - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignOutAfter - -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: - -\[-\]D.H:M:S.F - -where: - -- 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 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarnAfter - -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: - -\[-\]D.H:M:S.F - -where: - -- 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 -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInDesignPackageVisibility.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInDesignPackageVisibility.md deleted file mode 100644 index f245a57fac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBuiltInDesignPackageVisibility.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spobuiltindesignpackagevisibility -applicable: SharePoint Online -title: Set-SPOBuiltInDesignPackageVisibility -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOBuiltInDesignPackageVisibility - -## SYNOPSIS - -Sets the visibility of the available built-in Design Packages at moment of site creation. - -## SYNTAX - -```powershell -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://docs.microsoft.com/sharepoint/publishing-sites-classic-to-modern-experience) - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOBuiltInDesignPackageVisibility -DesignPackage Showcase -IsVisible:$false -``` - -This example sets the visibility of Showcase design package to false. - -## PARAMETERS - -### -DesignPackage - -Name of the design package, available names are -- Topic -- Showcase -- Blank -- TeamSite - -```yaml -Type: DesignPackageType -Parameter Sets: (All) -Aliases: -Accepted values: None, Topic, Showcase, Blank, TeamSite - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsVisible - -Determines if the design package is visible - -```yaml -Type: Boolean -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS 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 0580d681cd..0000000000 --- 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://docs.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://docs.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 ccb5d9f525..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODataConnectionSettingMetadata.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.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://docs.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://docs.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/Set-SPODisableSpacesActivation.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODisableSpacesActivation.md deleted file mode 100644 index 7575147485..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPODisableSpacesActivation.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spodisablespacesactivation -applicable: SharePoint Online -title: Set-SPODisableSpacesActivation -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPODisableSpacesActivation - -## SYNOPSIS -Disables the SharePoint Spaces activation. - -## SYNTAX - -``` -Set-SPODisableSpacesActivation [-Disable] [-Scope] [[-Identity] ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -Disables the SharePoint Spaces activation either at Tenant level or Site level. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-SPODisableSpacesActivation -Scope Tenant -Disable:$true -``` - -This example disables the SharePoint Spaces activation at Tenant level. - -### Example 2 -```powershell -PS C:\> Set-SPODisableSpacesActivation -Disable:$true -Identity https://contoso.sharepoint.com/sites/Marketing -Scope Site -``` - -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 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the URL of the site collection to update. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope. - -Possible values: -- Tenant -- Site - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -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 - -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](http://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-SPOGeoStorageQuota.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md deleted file mode 100644 index 2e882c0469..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOGeoStorageQuota.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spogeostoragequota -applicable: SharePoint Online -title: Set-SPOGeoStorageQuota -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOGeoStorageQuota - -## SYNOPSIS - -This Cmdlet sets the Storage quota on a multi-geo tenant. - -## SYNTAX - -```powershell -Set-SPOGeoStorageQuota -GeoLocation -StorageQuotaMB [] -``` - -## DESCRIPTION - -This Cmdlet sets the storage quota, in megabytes, on a particular geo-location. Additionally, it requires a connection to a multi-geo tenant to run correctly. You must be a SharePoint Online global Administrator. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Set-SPOGeoStorageQuota -GeoLocation EASTUS -StorageQuotaMB 512 -``` - -Sets the SharePoint Online Storage Quota on the EAST US location to 512 MB. - -### EXAMPLE 2 - -```powershell -Set-SPOGeoStorageQuota -GeoLocation NORTHCENTRALUS -StorageQuotaMB 1024 -``` - -Sets the SharePoint Online Storage Quota on the **NORTH CENTRAL US** location to 1024 MB (1GB). - -## PARAMETERS - -### -GeoLocation - -The desired Geo Location to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuotaMB - -SharePoint Online Storage Quota in MegaBytes. - -```yaml -Type: Int64 -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOGeoStorageQuota](Get-SPOGeoStorageQuota.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md deleted file mode 100644 index ad87776432..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHideDefaultThemes.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spohidedefaultthemes -applicable: SharePoint Online -title: Set-SPOHideDefaultThemes -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOHideDefaultThemes - -## SYNOPSIS - -Specifies whether the default themes should be available. - -## SYNTAX - -```powershell -Set-SPOHideDefaultThemes [-HideDefaultThemes] [] -``` - -## DESCRIPTION - -The **Set-SPOHideDefaultThemes** cmdlet is used to specify whether the default themes that come with SharePoint should be included in the theme picker list. For example, you might want to create custom themes for your sites and then remove the default themes to ensure that all pages use your custom themes. - -After creating the `"Custom Cyan"` theme, hiding the default themes leaves only the one custom theme in the themes list under **Change the look**. - -Specify the setting as either `$true` to hide the default themes, or `$false` (the default setting) to allow use of the default themes. - -> [!NOTE] -> This cmdlet was named **Set-HideDefaultThemes** until the December 2017 release of the SPO Management Shell. We recommend that you use the latest version of the PowerShell cmdlets. -> [!TIP] -> Allows you to hide or show **ALL** default themes, no any particular ones. -> [!NOTE] -> This cmdlet hides the default themes on **Modern Sites**. You cannot hide the default themes on Classic Sites. - -## EXAMPLES - -### Example 1 - -In this example, the cmdlet hides the default themes. - -```powershell -Set-SPOHideDefaultThemes $true -``` - -### Example 2 - -In this example, the cmdlet restores the default themes to the theme picker list. - -```powershell -Set-SPOHideDefaultThemes $false -``` - -## PARAMETERS - -### -HideDefaultThemes - -Determines whether to hide the default themes. - -```yaml -Type: Boolean -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOHideDefaultThemes](Get-SPOHideDefaultThemes.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHomeSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHomeSite.md deleted file mode 100644 index 9fc648fb3b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHomeSite.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spohomesite -applicable: SharePoint Online -title: Set-SPOHomeSite -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Set-SPOHomeSite - -## SYNOPSIS - -Sets a SharePoint Site as a Home Site. - -## SYNTAX - -```powershell -Set-SPOHomeSite [-HomeSiteUrl] [] -``` - -## 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://docs.microsoft.com/SharePoint/home-site) - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOHomeSite -HomeSiteUrl "https://contoso.sharepoint.com/sites/homesite" -``` - -This example set the site collection at ** as SharePoint Online Home Site. - -## PARAMETERS - -### -HomeSiteUrl - -The Url of the site collection to be the home site. - -```yaml -Type: 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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md deleted file mode 100644 index a7e267ec8f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spohubsite -applicable: SharePoint Online -title: Set-SPOHubSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOHubSite - -## SYNOPSIS - -Sets the hub site information such as name, logo, and description. - -## SYNTAX - -```powershell -Set-SPOHubSite [-Identity] [-Title ] [-LogoUrl ] [-Description ] [-SiteDesignId ] [-RequiresJoinApproval ] [] -``` - -## DESCRIPTION - -Use this cmdlet to set properties such as name, logo, and description. These properties appear for the hub in the SharePoint user interface. - -If the hub site doesn't exist, this cmdlet returns a "File not found" error. - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOHubSite https://contoso.sharepoint.com/sites/Marketing ` --Title "Marketing Hub" ` --LogoUrl https://contoso.sharepoint.com/sites/Marketing/SiteAssets/hublogo.png ` --Description "Hub for the Marketing division" -``` - -This example updates the name of the hub displayed in the SharePoint user interface. It also updates the logo used in the hub navigation, and specifies an optional description for the hub. - -## PARAMETERS - -### -Identity - -URL of the hub site. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: HubSite -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title - -The display name of the hub. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogoUrl - -The URL of a logo to use in the hub navigation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -A description of the hub site. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteDesignId - -Site Design ID, for example db752673-18fd-44db-865a-aa3e0b28698e - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiresJoinApproval - -Determines if joining a Hub site requires approval. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -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/p/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md deleted file mode 100644 index b75b91a8fa..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spomigrationpackageazuresource -applicable: SharePoint Online -title: Set-SPOMigrationPackageAzureSource -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOMigrationPackageAzureSource - -## SYNOPSIS - -Cmdlet to create Azure containers, upload migration package files into the appropriate containers and snapshot the uploaded content. - -## 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 [] -``` - -### ImplicitSourceImplicitAzure - -```powershell -Set-SPOMigrationPackageAzureSource [-EncryptionMetaInfo ] - [-EncryptionParameters ] - -MigrationPackageAzureLocations - -MigrationSourceLocations [-NoLogFile] [-NoSnapshotCreation] [-NoUpload] - [-Overwrite] [] -``` - -### ExplicitSourceImplicitAzure - -```powershell -Set-SPOMigrationPackageAzureSource [-EncryptionMetaInfo ] - [-EncryptionParameters ] - -MigrationPackageAzureLocations [-NoLogFile] [-NoSnapshotCreation] - [-NoUpload] [-Overwrite] -SourceFilesPath -SourcePackagePath [] -``` - -## 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. - -This cmdlet returns a Microsoft.Online.SharePoint.Migration. MigrationPackageAzureLocations object, which can be used as a source for this cmdlet or, more commonly, as a source for the `Submit-SPOMigrationJob` cmdlet. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -$azurelocations = Set-SPOMigrationPackageAzureSource -SourcePath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_TgtPkg -FileContainerUri migration-files -PackageContainerUri migration-package -AccountName migrationstore -AccountKey "nmcXQ+1NctB7BlRVm+8+qWUn6GUFIH7E5ZQPThcjg8SfFWTJ34HthyOEoROwxHYIajpOYxYDt7qUwSEBQlLWoA==" -``` - -This example creates migration package containers in Azure storage using the supplied account credentials, uploads the package files into them, snapshots the files and lastly returns the connection strings to a PowerShell variable. - -### EXAMPLE 2 - -```powershell -Set-SPOMigrationPackageAzureSource -SourcePath \\fileserver\share\folder1 -OutputPackagePath d:\MigrationPackages\Folder1_TgtPkg -MigrationPackageAzureLocations $azurelocations -AccountName migrationstore -AccountKey "nmcXQ+1NctB7BlRVm+8+qWUn6GUFIH7E5ZQPThcjg8SfFWTJ34HthyOEoROwxHYIajpOYxYDt7qUwSEBQlLWoA==" -NoUpload -``` - -This example uses existing migration package containers in Azure storage to snapshot previously uploaded files and then returns the connection strings to a PowerShell variable. - -## PARAMETERS - -### -AccountKey - -The account key for the Azure Storage account. - -```yaml -Type: String -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountName - -The account name for the Azure Storage account. - -```yaml -Type: String -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AzureQueueName - -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 -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionMetaInfo - -PARAMVALUE: MigrationFileEncryptionInfo[] - -```yaml -Type: MigrationFileEncryptionInfo[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionParameters - -An EncryptionParameters object. See [New-SPOMigrationEncryptionParameters](https://docs.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters) for more information. - -```yaml -Type: EncryptionParameters -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileContainerName - -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 -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationPackageAzureLocations - -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 -Parameter Sets: ImplicitSourceImplicitAzure, ExplicitSourceImplicitAzure -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationSourceLocations - -Possible Source locations to migrate. - -```yaml -Type: MigrationPackageLocation -Parameter Sets: ImplicitSourceExplicitAzure, ImplicitSourceImplicitAzure -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoLogFile - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoSnapshotCreation - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoUpload - -Indicates to not upload the package files. The default is to upload all the package files. - -```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 -``` - -### -Overwrite - -```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 -``` - -### -PackageContainerName - -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 -Parameter Sets: ImplicitSourceExplicitAzure, ExplicitSourceExplicitAzure -Aliases: -Applicable: SharePoint Online -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 -Parameter Sets: ExplicitSourceExplicitAzure, ExplicitSourceImplicitAzure -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourcePackagePath - -The directory location where the package's metadata files exist. - -```yaml -Type: String -Parameter Sets: ExplicitSourceExplicitAzure, ExplicitSourceImplicitAzure -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoCompanyAllowedDataLocation.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoCompanyAllowedDataLocation.md deleted file mode 100644 index 3d7ca21518..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoCompanyAllowedDataLocation.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spomultigeocompanyalloweddatalocation -applicable: SharePoint Online -title: Set-SPOMultiGeoCompanyAllowedDataLocation -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Set-SPOMultiGeoCompanyAllowedDataLocation - -## SYNOPSIS - -Adds a multi-geo allowed location. - -## SYNTAX - -```powershell -Set-SPOMultiGeoCompanyAllowedDataLocation [-Location] [-InitialDomain] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Use this cmdlet to set the multi-geo allowed locations. - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOMultiGeoCompanyAllowedDataLocation -Location AUS -Domain contoso.com -``` - -Sets AUS (Australia) as an allowed multi-geo location for the domain contoso.com. - -## PARAMETERS - -### -Location - -The Preferred Data Location (PDL) to allow. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitialDomain - -Sets the initial domain to assocate with the specified data location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -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 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 -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). - -## NOTES - -## RELATED LINKS - -[Remove-SPOMultiGeoCompanyAllowedDataLocation](https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spomultigeocompanyalloweddatalocation) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoExperience.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoExperience.md deleted file mode 100644 index 5f5c988dc3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMultiGeoExperience.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spomultigeoexperience -applicable: SharePoint Online -title: Set-SPOMultiGeoExperience -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Set-SPOMultiGeoExperience - -## SYNOPSIS - -Used to set a geo location into SPO mode. - -## SYNTAX - -```powershell - 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://docs.microsoft.com/office365/enterprise/enabling-sp-multigeo-satellite-geolocation) - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOMultiGeoExperience -``` - -This example will upgrade your instance's multi-geo experience to include SharePoint Online Multi-Geo. This operation usually takes about an hour while we perform various publish backs in the service and re-stamp your tenant. - -## PARAMETERS - -### -AllInstances - -. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -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 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 -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). - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgAssetsLibrary.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgAssetsLibrary.md deleted file mode 100644 index 4199b14a30..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgAssetsLibrary.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spoorgassetslibrary -applicable: SharePoint Online -title: Set-SPOOrgAssetsLibrary -author: Maralesfahanpoor -ms.author: maesfaha -ms.reviewer: -manager: paulac -schema: 2.0.0 ---- - -# Set-SPOOrgAssetsLibrary - -## SYNOPSIS - -Updates information for a library that is designated as a location for organization assets. - -## SYNTAX - -```powershell -Set-SPOOrgAssetsLibrary -LibraryUrl [-ThumbnailUrl ] [-OrgAssetType ] [] -``` - -## DESCRIPTION - -The Set-SPOOrgAssetsLibrary cmdlet updates information for a library that is designated as a location for organization assets. Updating the thumbnail URL and OrgAssetType are currently supported. - -## EXAMPLES - -### Example 1 - -This example updates the thumbnail URL publicly displayed for the library to contosologo2.jpg. - -```powershell -Set-SPOOrgAssetsLibrary -LibraryURL sites/branding/Assets -ThumbnailURL https://contoso.sharepoint.com/sites/branding/Assets/contosologo2.jpg -``` - -### Example 2 - -This example removes the thumbnail URL that was previously set for the library. - -```powershell -Set-SPOOrgAssetsLibrary -LibraryURL sites/branding/Assets -ThumbnailURL "" -``` - -### Example 3 - -This example changes the OrgAssetType to OfficeTemplateLibrary. - -```powershell -Set-SPOOrgAssetsLibrary -LibraryURL sites/branding/Templates -OrgAssetType OfficeTemplateLibrary -``` - -### Example 4 - -This example changes the OrgAssetType to "ImageDocumentLibrary,OfficeTemplateLibrary". - -```powershell -Set-SPOOrgAssetsLibrary -LibraryURL sites/branding/Templates -OrgAssetType ImageDocumentLibrary,OfficeTemplateLibrary -``` - -## PARAMETERS - -### -LibraryUrl - -Indicates the server relative URL of the library to be modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -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". - -ImageDocumentLibrary is the default OrgAssetType and is best used for images. You can access the contents of this library from any site or page in the SharePoint filepicker. -OfficeTemplateLibrary is the suggested type for Office files and will show up in the UI of all Office desktop apps and Office online in the templates section. - -In order to benefit from both UIs you can choose "ImageDocumentLibrary,OfficeTemplateLibrary" as OrgAssetType. - -```yaml -Type: OrgAssetType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Accepted values: ImageDocumentLibrary, OfficeTemplateLibrary -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThumbnailUrl - -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 -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/p/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/add-spoorgassetslibrary?view=sharepoint-ps) - -[Get-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/get-spoorgassetslibrary?view=sharepoint-ps) - -[Remove-SPOOrgAssetsLibrary](https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spoorgassetslibrary?view=sharepoint-ps) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgNewsSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgNewsSite.md deleted file mode 100644 index c3a533583a..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOOrgNewsSite.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spoorgnewssite -applicable: SharePoint Online -title: Set-SPOOrgNewsSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen ---- - -# Set-SPOOrgNewsSite - -## SYNOPSIS - -Marks a site as one of multiple possible tenant's organizational news sites. Requires Global administrator or SharePoint administrator permissions. - -## SYNTAX - -```powershell -Set-SPOOrgNewsSite -OrgNewsSiteUrl [] -``` - -## DESCRIPTION - -Use this cmdlet to mark a site as an organizational authoritative news site. Such sites get primary treatment in the SharePoint user interface. - -If a site with specified URL doesn't exist, this cmdlet returns a "File not found" error. - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOOrgNewsSite -OrgNewsSiteUrl https://contoso.sharepoint.com/sites/Marketing -``` - -This example marks as an organizational news site. - -## PARAMETERS - -### -OrgNewsSiteUrl - -The URL of a site to be marked as an organizational news site. - -```yaml -Type: String -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/p/?LinkID=113216). - -## RELATED LINKS - -[Remove-SPOOrgNewsSite](Remove-SPOOrgNewsSite.md) - -[Get-SPOOrgNewsSite](Get-SPOOrgNewsSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md deleted file mode 100644 index 20581fc32d..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSite.md +++ /dev/null @@ -1,1008 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-sposite -applicable: SharePoint Online -title: Set-SPOSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOSite - -## SYNOPSIS - -Sets or updates one or more properties' values for a site collection. - -## SYNTAX - -### ParamSet1 - -```powershell -Set-SPOSite [-Identity] [-AllowSelfServiceUpgrade ] [-Confirm] - [-DenyAddAndCustomizePages ] [-LocaleId ] [-LockState ] [-NoWait] [-Owner ] - [-ResourceQuota ] [-ResourceQuotaWarningLevel ] - [-SandboxedCodeActivationCapability ] - [-BlockDownloadLinksFileType ] - [-SharingCapability ] [-StorageQuota ] [-StorageQuotaWarningLevel ] - [-Title ] [-WhatIf] [-AllowDownloadingNonWebViewableFiles ] - [-CommentsOnSitePagesDisabled ] [-SocialBarOnSitePagesDisabled ] - [-DisableAppViews ] - [-DisableCompanyWideSharingLinks ] [-DisableFlows ] - [-RestrictedToGeo ] [-SharingAllowedDomainList ] - [-SharingBlockedDomainList ] [-SharingDomainRestrictionMode ] - [-ShowPeoplePickerSuggestionsForGuestUsers ] [-StorageQuotaReset] - [-DefaultSharingLinkType] [-DefaultLinkPermission] [-DefaultLinkToExistingAccess] - [-ConditionalAccessPolicy ] [-AuthenticationContextName ] [-LimitedAccessFileType ] [-AllowEditing ] [-AnonymousLinkExpirationInDays ] [-OverrideTenantAnonymousLinkExpirationPolicy ] [-OverrideTenantExternalUserExpirationPolicy ] [-ExternalUserExpirationInDays ] [-SensitivityLabel ] - [-RemoveLabel] [] -``` - -### ParamSet2 - -```powershell -Set-SPOSite [-Identity] -EnablePWA [-Confirm] [-WhatIf] [] -``` - -### ParamSet3 - -```powershell -Set-SPOSite [-Identity] [-Confirm] [-DisableSharingForNonOwners] [-WhatIf] - [] -``` - -### ParamSet4 (valid for Group Site Collection) - -```powershell -Set-SPOSite [-Identity] [-AllowSelfServiceUpgrade ] [-Confirm] - [-DenyAddAndCustomizePages ] [-LocaleId ] [-LockState ] [-NoWait] [-Owner ] - [-ResourceQuota ] [-ResourceQuotaWarningLevel ] - [-SandboxedCodeActivationCapability ] - [-SharingCapability ] [-StorageQuota ] [-StorageQuotaWarningLevel ] - [] -``` - -## DESCRIPTION - -For any parameters that are passed in, the `Set-SPOSite` cmdlet sets or updates the setting for the site collection identified by parameter Identity. - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -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. - -For Groups site collection, the only valid parameters are Identity, AllowSelfServiceUpgrade, DefaultLinkPermission, DefaultSharingLinkType, DenyAddAndCustomizePages, DisableCompanyWideSharingLinks, DisableSharingForNonOwners, LockState, Owner, ResourceQuota, ResourceQuotaWarningLevel, SandboxedCodeActivationCapability, SharingCapability, ShowPeoplePickerSuggestionsForGuestUsers, SocialBarOnSitePagesDisabled, StorageQuota, StorageQuotaReset, and StorageQuotaWarningLevel. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -Owner joe.healy@contoso.com -NoWait -``` - -Example 1 updates the owner of site collection to the person whose email address is joe.healy@contoso.com. This cmdlet is executed immediately without delay. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -ResourceQuota 0 -StorageQuota 1024 -``` - -Example 2 updates the settings of site collection The storage quota is updated to 1024 megabytes (1 GB) and the resource quota is updated to 0 megabytes. - -### -----------------------EXAMPLE 3----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com -StorageQuota 1500 -StorageQuotaWarningLevel 1400 -``` - -This example updates the settings of site collection The storage quota is updated to 1500 megabytes and the storage quota warning level is updated to 1400 megabytes. - -### -----------------------EXAMPLE 4----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com -DisableSharingForNonOwners -``` - -Example 4 prevents non-owners of a site from inviting new users to the site. - -### -----------------------EXAMPLE 5----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/groupname -StorageQuota 3000 -StorageQuotaWarningLevel 2000 -``` - -This example sets the quota for the site. - -> [!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. - -### -----------------------EXAMPLE 6----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnablePWA $true -``` - -Example 6 enables the site "site1" to create Project Web Applications (PWA). - -### -----------------------EXAMPLE 7----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -SharingCapability ExternalUserSharingOnly -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -SharingDomainRestrictionMode AllowList -SharingAllowedDomainList "contoso.com" -``` - -Example 7 sets the Sharing Capability to allow external users who accept sharing invitations and sign in as authenticated users, and then specifies an email domain that is allowed for sharing with the external collaborators. - -### -----------------------EXAMPLE 8----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/research -AddInformationSegment a17efb47-e3c9-4d85-a188-1cd59c83de32 -``` - -This example adds InformationSegment 'a17efb47-e3c9-4d85-a188-1cd59c83de32' to the site. - -### -----------------------EXAMPLE 9----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/research -RemoveInformationSegment a17efb47-e3c9-4d85-a188-1cd59c83de32 -``` - -In example, InformationSegment 'a17efb47-e3c9-4d85-a188-1cd59c83de32' is removed from the site. - -### -----------------------EXAMPLE 10----------------------------- - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/research -ConditionalAccessPolicy AuthenticationContext -AuthenticationContextName "MFA" -``` - -In this example, an authentication context called MFA is attached to the site. - -## PARAMETERS - -### -EnablePWA - -Determines whether site can include Project Web App. -For more information about Project Web App, see Plan SharePoint groups in Project Server. - -```yaml -Type: Boolean -Parameter Sets: ParamSet2 -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity - -Specifies the URL of the site collection to update. - -```yaml -Type: SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowSelfServiceUpgrade - -Determines whether site collection administrators can upgrade their site collections. - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -PARAMVALUE: SwitchParameter - -```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 -``` - -### -DenyAddAndCustomizePages - -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. - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSharingForNonOwners - -This parameter prevents non-owners from invited new users to the site. - -This parameter is available only in SharePoint Online Management Shell Version 16.0.4613.1211 or later. - -```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 -``` - -### -LocaleId - -Specifies the language of this site collection. -For more information, see [MS-OE376, LCID](https://docs.microsoft.com/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a). - -```yaml -Type: UInt32 -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockState - -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 -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoWait - -Specifies to continue executing script immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner - -Specifies the owner of the site collection. - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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](https://msdn.microsoft.com/library/gg615462.aspx). - -```yaml -Type: Double -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -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: Double -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SensitivityLabel - -Used to specify the unique identifier (GUID) of the SensitivityLabel. - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SandboxedCodeActivationCapability - -PARAMVALUE: Unknown | Check | Disabled | Enabled - -```yaml -Type: SandboxedCodeActivationCapabilities -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockDownloadLinksFileType - -The valid values are: - -- WebPreviewableFiles -- ServerRenderedFilesOnly - -**Note**: ServerRendered (Office Only) and WebPreviewable (All supported files). - -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) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: WebPreviewableFiles -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingCapability - -Determines what level of sharing is available for the site. -The possible values are: Disabled - don't allow sharing outside your organization, ExistingExternalUserSharingOnly - Allow sharing only with the external users that already exist in your organization's directory, ExternalUserSharingOnly - allow external users who accept sharing invitations and sign in as authenticated users, or ExternalUserAndGuestSharing - allow sharing with all external users, and by using anonymous access links. - -For more information about sharing, see Turn external sharing on or off for SharePoint Online (). - -```yaml -Type: SharingCapabilities -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuota - -Specifies the storage quota in megabytes of the site collection. - -```yaml -Type: Int64 -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuotaWarningLevel - -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: Int64 -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title - -Specifies the title of the site collection. - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -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: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDownloadingNonWebViewableFiles - -Specifies if non web viewable files can be downloaded. - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommentsOnSitePagesDisabled - -Use this parameter to disable Comments section on Site Pages. -The parameter can't be used for Groups Site Collections. - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SocialBarOnSitePagesDisabled - -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: $true | $false - -```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 -``` - -### -DisableAppViews - -Disables the Power Apps button. -Possible values: - -- Disabled -- NotDisabled -- Unknown (not settable) - -```yaml -Type: AppViewsPolicy -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableCompanyWideSharingLinks -Disables People in your organization links. For more information, see [People in your organization sharing links](https://docs.microsoft.com/microsoft-365/solutions/microsoft-365-limit-sharing#people-in-your-organization-sharing-links). -Possible values - -- Disabled -- NotDisabled -- Unknown (not settable) - -```yaml -Type: CompanyWideSharingLinksPolicy -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableFlows -Disables the Power Automate button. -Possible values - -- Disabled -- NotDisabled - -```yaml -Type: FlowsPolicy -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictedToGeo - -PARAMVALUE: NoRestriction | BlockMoveOnly | BlockFull | Unknown - -```yaml -Type: RestrictedToRegion -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingAllowedDomainList - -Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com". - -For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](https://docs.microsoft.com/sharepoint/restricted-domains-sharing). - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingBlockedDomainList - -Specifies a list of email domains that is 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](https://docs.microsoft.com/sharepoint/restricted-domains-sharing). - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingDomainRestrictionMode - -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 within -SharingAllowedDomainList -- BlockList - Sharing is allowed with external users in all domains except in domains specified within -SharingBlockedDomainList - -For additional information about how to restrict a domain sharing, see [Restrict sharing of SharePoint and OneDrive content by domain](https://docs.microsoft.com/sharepoint/restricted-domains-sharing). - -```yaml -Type: SharingDomainRestrictionModes -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowPeoplePickerSuggestionsForGuestUsers - -To enable the option to search for existing guest users at Site Collection Level, set this parameter to $true. - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StorageQuotaReset - -Resets the OneDrive for Business storage quota to the tenant's new default storage space. - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultSharingLinkType - -The default link type for the site collection - -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: SharingLinkType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultLinkToExistingAccess - -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 default sharing link type is controlled by the DefaultSharingLinkType parameter - -PARAMVALUE: $true | $false - - -```yaml -Type: SharingLinkType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultLinkPermission - -The default link permission for the site collection - -PARAMVALUE: None | View | Edit - -- 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: SharingPermissionType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverrideTenantAnonymousLinkExpirationPolicy - -Choose whether to override the anonymous or anyone link expiration policy on this site - -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: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AnonymousLinkExpirationInDays - -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. - -To remove the expiration requirement, set the value to zero (0). - -```yaml -Type: Int32 -Parameter Sets: (All) -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: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalUserExpirationInDays - -Specifies all external user expiration which will expire after the set number of days. Only applies if OverrideTenantExternalUserExpirationPolicy is set to true. - -To remove the expiration requirement, set the value to zero (0). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalAccessPolicy - -Please read [Control access from unmanaged devices](/sharepoint/control-access-from-unmanaged-devices) documentation here to understand Conditional Access Policy usage in SharePoint Online. - -Possible values: -- AllowFullAccess: Allows full access from desktop apps, mobile apps, and the web. -- AllowLimitedAccess: Allows limited, web-only access. -- BlockAccess: Blocks Access. -- AuthenticationContext: Assign an Azure AD 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: SPOConditionalAccessPolicyType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: AllowFullAccess -Accept pipeline input: False -Accept wildcard characters: False -``` - - -### -AuthenticationContextName - -The conditional access authentication context name. - -```yaml -Type: String -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -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 - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -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. - -- 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: SPOLimitedAccessFileType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: WebPreviewableFiles -Accept pipeline input: False -Accept wildcard characters: False -``` -### -AddInformationSegment - -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://docs.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: GUID -Required: False -Position: Named -Default value: None -``` - -### -RemoveInformationSegment -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://docs.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: GUID -Required: False -Position: Named -Default value: None -``` - -### -RemoveLabel -This parameter allows you to remove the assigned sensitivity label on a site. - -```yaml -Type: SwitchParameter -Parameter Sets: ParamSet5 -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Set-SPOTenant](Set-SPOTenant.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md deleted file mode 100644 index c7b42ee7c3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spositedesign -applicable: SharePoint Online -title: Set-SPOSiteDesign -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOSiteDesign - -## SYNOPSIS - -Updates a previously uploaded site design. - -## SYNTAX - -```powershell -Set-SPOSiteDesign - [-Identity ] - [-Title ] - [-WebTemplate ] - [-SiteScripts ] - [-Description ] - [-ThumbnailUrl ] - [-PreviewImageUrl ] - [-PreviewImageAltText ] - [-IsDefault] - [] -``` - -## EXAMPLES - -### Example 1 - -This example updates a previously created site design. - -```powershell -Set-SPOSiteDesign ` - -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` - -Title "Contoso customer tracking - version 2" ` - -WebTemplate "68" ` - -Description "Updated site design for list schema that 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 - version 2" -``` - -## DESCRIPTION - -Updates a previously uploaded site design. - -## PARAMETERS - -### -Identity - -The site design Id. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title - -The display name of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebTemplate - -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: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteScripts - -An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed. - -```yaml -Type: SPOSiteScriptPipeBind[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -The display description of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThumbnailUrl - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewImageUrl - -The URL of a preview image. If none is specified, SharePoint uses a generic image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreviewImageAltText - -The alt text description of the image for accessibility. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -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](https://docs.microsoft.com/sharepoint/dev/declarative-customization/customize-default-site-design). - -```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 -``` - -### 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/Set-SPOSiteGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteGroup.md deleted file mode 100644 index 98e12f9a66..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteGroup.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spositegroup -applicable: SharePoint Online -title: Set-SPOSiteGroup -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOSiteGroup - -## SYNOPSIS - -Updates the SharePoint Online owner and permission levels on a group inside a site collection. - -## SYNTAX - -```powershell -Set-SPOSiteGroup -Identity [-Name ] [-Owner ] [-PermissionLevelsToAdd ] - [-PermissionLevelsToRemove ] -Site [] -``` - -## DESCRIPTION - -You must be a SharePoint Online administrator or Global 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Set-SPOSiteGroup -Site https://contoso.sharepoint.com/sites/siteA -Identity "ProjectViewers" -PermissionLevelsToRemove "Full Control" -PermissionLevelsToAdd "View Only" -``` - -Example 1 changes permission level of the ProjectViewers group inside site collection from Full Control to View Only. - -### -----------------------EXAMPLE 2----------------------------- - -```powershell -Set-SPOSiteGroup -Site https://contoso.sharepoint.com -Identity "ProjectViewers" -Owner Melissa.kerr@contoso.com -``` - -Example 2 sets Melissa.kerr@contoso.com as the owner of the ProjectViewers group. - -## PARAMETERS - -### -Identity - -Specifies the name of the group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - -Specifies the new name of the group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Owner - -Specifies the owner (individual or a security group) of the group to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionLevelsToAdd - -Specifies the permission levels to grant to the group. - -> [!NOTE] -> Permission levels are defined by SharePoint Online administrators from SharePoint Online Administration Center. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PermissionLevelsToRemove - -Specifies the permission levels to remove from the group. - -> [!NOTE] -> Permission levels are defined by SharePoint Online administrators from SharePoint Online Administration Center. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the site collection the group belongs 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 -``` - -### 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOSiteGroup](Get-SPOSiteGroup.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md deleted file mode 100644 index b3b0b6aa2f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spositeoffice365group -applicable: SharePoint Online -title: Set-SPOSiteOffice365Group -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOSiteOffice365Group - -## SYNOPSIS - -Connects a top-level SPO site collection to a new Microsoft 365 Group. - -## SYNTAX - -```powershell -Set-SPOSiteOffice365Group - -Site - -DisplayName - -Alias - [-IsPublic] - [-Description ] - [-Classification ] - [-KeepOldHomepage] - [] -``` - -## DESCRIPTION - -Connects a top-level SPO site collection to a new Microsoft 365 Group. You must be a SharePoint Online administrator or Global Administrator to run the cmdlet. - -> [!IMPORTANT] -> This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments. - -If the site doesn't exist, this cmdlet returns a "File not found" error. - -## EXAMPLES - -### Example 1 - -This example creates a new Microsoft 365 Group named "site1group" and connects site collection to it. The group will privacy set to "Private" and Classification set to "Highly Confidential". - -```powershell -Set-SPOSiteOffice365Group -Site https://contoso.sharepoint.com/sites/site1 -DisplayName "site1group" -Alias "site1group" -Classification "Highly Confidential" -``` - -### Example 2 - -This example creates a new Office 365 Group named "classicsite" and connects site collection to it. It will keep the old home page from the classic site. - -```powershell -Set-SPOSiteOffice365Group -Site https://contoso.sharepoint.com/sites/classicsite -DisplayName "Classic Site" -Alias "classicsite" -KeepOldHomepage -``` - -## PARAMETERS - -### -Site - -The site collection being connected to new Office 365 Group. - -```yaml -Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName - -Specifies the name of the new Microsoft 365 Group that will be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Alias - -Specifies the email alias for the new Microsoft 365 Group that will be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Specifies the group's description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPublic - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -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 [Azure Active Directory 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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeepOldHomepage - -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: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md deleted file mode 100644 index 761da6b6a8..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spositescript -applicable: SharePoint Online -title: Set-SPOSiteScript -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOSiteScript - -## SYNOPSIS - -Updates a previously uploaded site script. - -## SYNTAX - -```powershell -Set-SPOSiteScript - -Identity - -Title - -Content - [-Description ] - [-Version ] - [] -``` - -## DESCRIPTION - -Updates a previously uploaded site script. - -## EXAMPLES - -### Example 1 - -This example updates a previously created site script. Any site designs referencing it execute the updated script. - -```powershell -$newnavscript = @' -{ - "$schema": "schema.json", - "actions": [ - { - "verb": "addNavLink", - "url": "/Custom Library", - "displayName": "Custom Library Updated", - "isWebRelative": true - }, - { - "verb": "addNavLink", - "url": "/Lists/Custom List", - "displayName": "Custom List Updated", - "isWebRelative": true - }, - { - "verb": "applyTheme", - "themeName": "Contoso Explorers" - } - ], - "bindata": { }, - "version": 2 -}; -'@ - -Set-SPOSiteScript -Identity edaec4ec-71e2-4026-ac1e-6686bb30190d -Content $newnavscript -Version 2 - -``` - -## PARAMETERS - -### -Identity - -The id of the site design. - -```yaml -Type: SPOSiteDesignPipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title - -The display name of the site design. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Content - -The JSON value that describes the script. For more information, see the [JSON reference](https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -A description of the script. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version - -A version number of the script. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStorageEntity.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStorageEntity.md deleted file mode 100644 index f26a46dcac..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStorageEntity.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spostorageentity -applicable: SharePoint Online -title: Set-SPOStorageEntity -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOStorageEntity - -## SYNOPSIS - -Tenant properties allow tenant administrators to add properties in the app catalog that can be read by various SharePoint Framework components. Because tenant properties are stored in the tenant app catalog, you must provide the tenant app catalog site collection URL or the site collection app catalog URL in the following cmdlets. - -## SYNTAX - -```powershell -Set-SPOStorageEntity -Site -Key -Value -Comments -Description [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -This cmdLet is used to set a value in the property bag. - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOStorageEntity -Site "https://tenant-name.sharepoint.com/sites/app-catalog" -Key "MyCustomKey" -Value "{'MyKey':1234}" -Comments "This is an example" -Description "This is an example" -``` - -This example adds an entry to the property bag. - -## PARAMETERS - -### -Site - -URL to the tenant or site collection app catalog. - -```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 -``` - -### -Key - -The key in the property bag that should be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value - -Value to be set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comments - -Comment for this property bag entry. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Description of the property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -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 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 -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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheSiteState.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheSiteState.md deleted file mode 100644 index 907355508b..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheSiteState.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: -schema: 2.0.0 -applicable: SharePoint Online -title: Set-SPOStructuralNavigationCacheSiteState -author: paramveersisodia -ms.author: paramsis -manager: suyog -ms.reviewer: ---- - -# Set-SPOStructuralNavigationCacheSiteState - -## SYNOPSIS -Enable or disable caching for all webs in a site collection. - -## SYNTAX - -``` -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). - -## EXAMPLES - -### Example 1 -```powershell -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/. - -### Example 2 -```powershell -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/. - -## PARAMETERS - -### -IsEnabled -$true to enable caching, $false to disable caching. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteUrl -Specifies the absolute URL for the site collection's root web that needs its caching state to be set. - -```yaml -Type: String -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - 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 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/sharepoint-online/Set-SPOStructuralNavigationCacheWebState.md deleted file mode 100644 index 4a99b659b4..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOStructuralNavigationCacheWebState.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: -schema: 2.0.0 -applicable: SharePoint Online -title: Set-SPOStructuralNavigationCacheWebState -author: paramveersisodia -ms.author: paramsis -manager: suyog -ms.reviewer: ---- - -# Set-SPOStructuralNavigationCacheWebState - -## SYNOPSIS -Enable or disable caching for a web in a site collection. - -## SYNTAX - -``` -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). - -## EXAMPLES - -### Example 1 -```powershell -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. - -### Example 2 -```powershell -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. -## PARAMETERS - -### -IsEnabled -$true to enable caching, $false to disable caching. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WebUrl -Specifies the absolute URL for the web that needs its caching state to be set. - -```yaml -Type: String -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object -## NOTES - 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 online help, type: "get-help Set-SPOStructuralNavigationCacheWebState -online" - -## RELATED LINKS -[Get-SPOStructuralNavigationCacheWebState](Get-SPOStructuralNavigationCacheWebState.md) - -[Get-SPOStructuralNavigationCacheSiteState](Get-SPOStructuralNavigationCacheSiteState.md) - -[Set-SPOStructuralNavigationCacheSiteState](Set-SPOStructuralNavigationCacheSiteState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md deleted file mode 100644 index 00d76250ee..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenant.md +++ /dev/null @@ -1,1919 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spotenant -applicable: SharePoint Online -title: Set-SPOTenant -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOTenant - -## SYNOPSIS - -Sets properties on the SharePoint Online organization. - -## SYNTAX - -```powershell -Set-SPOTenant [-ApplyAppEnforcedRestrictionsToAdHocRecipients ] - [-BccExternalSharingInvitations ] - [-BccExternalSharingInvitationsList ] - [-BlockDownloadLinksFileType ] - [-DisplayStartASiteOption ] - [-EnableAIPIntegration ] - [-EnableAutoNewsDigest ] - [-EnableMinimumVersionRequirement ] - [-EnablePromotedFileHandlers ] - [-ExternalServicesEnabled ] - [-MarkNewFilesSensitiveByDefault ] - [-MaxCompatibilityLevel ] - [-MinCompatibilityLevel ] - [-NoAccessRedirectUrl ] - [-OfficeClientADALDisabled ] - [-ProvisionSharedWithEveryoneFolder ] - [-RequireAcceptingAccountMatchInvitedAccount ] - [-SearchResolveExactEmailOrUPN ] - [-SharingCapability ] - [-ShowAllUsersClaim ] - [-ShowEveryoneClaim ] - [-ShowEveryoneExceptExternalUsersClaim ] - [-SignInAccelerationDomain ] - [-StartASiteFormUrl ] - [-UsePersistentCookiesForExplorerView ] - [-CommentsOnSitePagesDisabled ] - [-CommentsOnFilesDisabled ] - [-CommentsOnListItemsDisabled ] - [-SocialBarOnSitePagesDisabled ] - [-DefaultLinkPermission ] - [-DefaultSharingLinkType ] - [-DisabledWebPartIds ] - [-DisallowInfectedFileDownload ] - [-DisableAddShortcutsToOneDrive ] - [-EnableGuestSignInAcceleration ] - [-FileAnonymousLinkType ] - [-FilePickerExternalImageSearchEnabled ] - [-FolderAnonymousLinkType ] - [-IPAddressAllowList ] - [-IPAddressEnforcement ] - [-IPAddressWACTokenLifetime ] - [-LegacyAuthProtocolsEnabled ] - [-NotificationsInOneDriveForBusinessEnabled ] - [-NotificationsInSharePointEnabled ] - [-NotifyOwnersWhenInvitationsAccepted ] - [-NotifyOwnersWhenItemsReshared ] - [-ODBAccessRequests ] - [-ODBMembersCanShare ] - [-OneDriveForGuestsEnabled ] - [-OneDriveStorageQuota ] - [-IsWBFluidEnabled ] - [-OrphanedPersonalSitesRetentionPeriod ] - [-OwnerAnonymousNotification ] - [-PermissiveBrowserFileHandlingOverride ] - [-PreventExternalUsersFromResharing ] - [-PublicCdnAllowedFileTypes ] - [-PublicCdnEnabled ] - [-RequireAnonymousLinksExpireInDays ] - [-SharingAllowedDomainList ] - [-SharingBlockedDomainList ] - [-SharingDomainRestrictionMode ] - [-ShowPeoplePickerSuggestionsForGuestUsers ] - [-SpecialCharactersStateInFileFolderNames ] - [-SyncPrivacyProfileProperties ] - [-UseFindPeopleInPeoplePicker ] - [-UserVoiceForFeedbackEnabled ] - [-ContentTypeSyncSiteTemplatesList [String[]]] - [-ExcludeSiteTemplate] - [-CustomizedExternalSharingServiceUrl ] - [-ConditionalAccessPolicy ] - [-ConditionalAccessPolicyErrorHelpLink ] - [-LimitedAccessFileType ] - [-AllowDownloadingNonWebViewableFiles ] - [-AllowCommentsTextOnEmailEnabled ] - [-AllowEditing ] - [-EnableAzureADB2BIntegration ] - [-ExternalUserExpirationRequired ] - [-ExternalUserExpireInDays ] - [-EmailAttestationRequired ] - [-EmailAttestationReAuthDays ] - [-BlockUserInfoVisibility] - [-IncludeAtAGlanceInShareEmails] - [-SyncAadB2BManagementPolicy ] - [-StopNew2010Workflows ] - [-StopNew2013Workflows ] - [-BlockSendLabelMismatchEmail ] - [-DisableOutlookPSTVersionTrimming ] - [] -``` - -## DESCRIPTION - -You can use the `Set-SPOTenant` cmdlet to enable external services and to specify the versions in which site collections can be created. -You can also use the `Set-SPOSite` cmdlet together with the `Set-SPOTenant` cmdlet to block access to a site in your organization and redirect traffic to another site. - -You must be a SharePoint Online administrator or Global Administrator to run the cmdlet. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Set-SPOSite -Identity https://contoso.sharepoint.com/sites/team1 -LockState NoAccess -Set-SPOTenant -NoAccessRedirectUrl 'https://www.contoso.com/' -``` - -This example blocks access to and redirects traffic to - -### EXAMPLE 2 - -```powershell -Set-SPOTenant -ShowEveryoneExceptExternalUsersClaim $false -``` - -This example hides the "Everyone Except External Users" claim in People Picker. - -### EXAMPLE 3 - -```powershell -Set-SPOTenant -ShowAllUsersClaim $false -``` - -This example hides the "All Users" claim group in People Picker. - -### EXAMPLE 4 - -```powershell -Set-SPOTenant -UsePersistentCookiesForExplorerView $true -``` - -This example enables the use of special persisted cookie for Open with Explorer. - -### EXAMPLE 5 - -```powershell -Set-SPOTenant -LegacyAuthProtocolsEnabled $True -``` - -This example enables legacy authentication protocols on the tenant. This can help to enable login in situations where the admin users get an error like "Cannot contact web site ' or the web site does not support SharePoint Online credentials. The response status code is 'Unauthorized'.", and the underlying error is "Access denied. Before opening files in this location, you must first browse to the web site and select the option to login automatically." - -### EXAMPLE 6 - -```powershell -Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites -``` - -This example enables Content Type Hub to push content types to all OneDrive for Business sites. There is no change in Content Type Publishing behavior for other sites. - -### EXAMPLE 7 - -```powershell -Set-SPOTenant -ContentTypeSyncSiteTemplatesList MySites -ExcludeSiteTemplate -``` - -This example stops publishing content types to OneDrive for Business sites. - -### EXAMPLE 8 - -```powershell -Set-SPOTenant -SearchResolveExactEmailOrUPN $true -``` - -This example disables starts with for all users/partial name search functionality for all SharePoint users, except SharePoint Admins. - -### EXAMPLE 9 - -```powershell -Set-SPOTenant -UseFindPeopleInPeoplePicker $true -``` - -This example enables tenant admins to enable ODB and SPO to respect Exchange supports Address Book Policy (ABP) policies in the people picker. - -### EXAMPLE 10 - -```powershell -Set-SPOTenant -ShowPeoplePickerSuggestionsForGuestUsers $true -``` - -This example enable the option to search for existing guest users at Tenant Level. - -## PARAMETERS - -### -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. - -```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 -``` - -### -BccExternalSharingInvitations - -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: - -- 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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: False -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. - -The valid values are: - -- "" (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: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockDownloadLinksFileType - -The valid values are: - -- WebPreviewableFiles -- ServerRenderedFilesOnly - -**Note**: ServerRendered (Office Only) and WebPreviewable (All supported files). - -```yaml -Type: BlockDownloadLinksFileTypes -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: WebPreviewableFiles -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayStartASiteOption - -Determines whether tenant users see the Start a Site menu option. - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -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. (Currently in public preview). For more information, see [Enable sensitivity labels for Office files in SharePoint and OneDrive (public preview)](https://docs.microsoft.com/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files). - -```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 -``` - -### -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnablePromotedFileHandlers - -This parameter is reserved for Microsoft internal use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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://docs.microsoft.com/sharepoint/sensitive-by-default). - -```yaml -Type: SensitiveByDefaultState -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: AllowExternalSharing -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxCompatibilityLevel - -The only valid value is "15". - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinCompatibilityLevel - -The only valid value is "15". - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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: - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -```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 -``` - -### -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. -For additional information about the change, see Provision the Shared with Everyone folder in OneDrive for Business ( - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAcceptingAccountMatchInvitedAccount - -Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. - -Administrators who desire increased control over external collaborators should consider enabling this feature. - -Note, this only applies to new external users accepting new sharing invitations. Also, the resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource. - -The valid values are: - -- False (default) - 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. -- True - User must accept this invitation with bob@contoso.com. - -> [!NOTE] -> If this functionality is turned off (value is False), it is possible for the external/guest users you invite to your Azure AD, to log in using their personal, non-work accounts either on purpose, or by accident (they might have a pre-existing, signed in session already active in the browser window they use to accept your invitation). -> [!NOTE] -> Even though setting the value is instant (if you first run **Set-SPOTenant -RequireAcceptingAccountMatchInvitedAccount $True**, and then **Get-SPOTenant -RequireAcceptingAccountMatchInvitedAccount**, True should be returned), the functionality isn't turned on immediately. It may take up to 24 hours to take effect. - -```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 -``` - -### -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. - -```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 -``` - -### -SharingCapability - -Determines what level of sharing is available for the site. - -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. - -For more information about sharing, see Manage external sharing for your SharePoint online environment ( - -```yaml -Type: SharingCapabilities -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: ExternalUserAndGuestSharing -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 Azure Active Directory 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: - -- 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: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -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 Azure Active Directory, including any active external users who have previously accepted invitations. - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowEveryoneExceptExternalUsersClaim - -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 Azure Active Directory, but not to any users who have previously accepted invitations. - -The valid values are: - -- 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: Boolean - -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignInAccelerationDomain - -Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. - -When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory 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 Azure Active Directory Premium to customize the Azure Active Directory login page. - -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: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartASiteFormUrl - -Specifies URL of the form to load in the Start a Site dialog. - -The valid values are: - -- "" (default) - Blank by default, this will also remove or clear any value that has been set. -- Full URL - Example: " - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsePersistentCookiesForExplorerView - -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. - -The valid values are: - -- 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: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommentsOnSitePagesDisabled - -Disables or enables commenting functionality on the site pages. -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommentsOnFilesDisabled - -Disables or enables commenting functionality on the files. -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommentsOnListItemsDisabled - -Disables or enables commenting functionality on list items. -PARAMVALUE: $true | $false - -```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 -``` - -### -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. - -PARAMVALUE: $true | $false - -```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 -``` - -### -DefaultLinkPermission - -Lets administrators choose the default permission of the link in the sharing dialog box in OneDrive for Business and SharePoint Online. This applies to anonymous access, internal and direct links. - -The valid values are None (non settable), View and Edit. - -```yaml -Type: SharingPermissionType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultSharingLinkType - -Lets administrators choose what type of link appears is selected in the "Get a link" 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: - -- 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: SharingLinkType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisabledWebPartIds - -Allows administrators prevent certain, specific web parts from being added to pages or rendering on pages on which they were previously added. Currently, only Amazon Kindle, YouTube and Twitter web parts can be disabled in such a manner. - -To disable a specific web part you need to enter its GUID as the parameter: Amazon Kindle (46698648-fcd5-41fc-9526-c7f7b2ace919), YouTube (544dd15b-cf3c-441b-96da-004d5a8cea1d), Twitter (f6fdf4f8-4a24-437b-a127-32e66a5dd9b4). If you are looking for a GUID for any other web part, easiest way to achieve is to place the web part on a SharePoint page and move to maintenance mode. See more details around the [web part maintenance mode from Microsoft Support](https://support.office.com/en-us/article/Open-and-use-the-Web-Part-Maintenance-Page-EFF9CE22-D04A-44DD-AE83-AC29A5E396C2). - -You can enter in 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. - -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: Guid[] -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisallowInfectedFileDownload - -Prevents the Download button from being displayed on the Virus Found warning page. - -Accepts a value of true (enabled) to hide the Download button or false (disabled) to display the Download button. By default this feature is set to false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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 separately for files. - -PARAMVALUE: None | View | Edit - -```yaml -Type: AnonymousLinkType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderAnonymousLinkType - -Anonymous access links can allow recipients to only view or view and edit. - -PARAMVALUE: None | View | Edit - -```yaml -Type: AnonymousLinkType -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressAllowList - -Configures multiple IP addresses or IP address ranges (IPv4 or IPv6), that are recognized as trusted. - -Use commas to separate multiple IP addresses or IP address ranges. Verify there are no overlapping IP addresses and ensure IP ranges use Classless Inter-Domain Routing (CIDR) notation. For example, 172.16.0.0, 192.168.1.0/27. - -> [!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: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressEnforcement - -Allows access from network locations that are defined by an administrator. - -The values are $true and $false. The default value is $false which means the setting is disabled. - -Before the IPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the IPAddressAllowList parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddressWACTokenLifetime - -Allows to set the session timeout. If you are a tenant administrator and you begin IP address enforcement for OneDrive for Business in Office 365, this enforcement automatically activates a tenant parameter IPAddressWACTokenLifetime. The default value is 15 minutes, when IP Address Enforcement is True. - -PARAMVALUE: Int32 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -- 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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationsInOneDriveForBusinessEnabled - -Enables or disables notifications in OneDrive for Business. - -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotificationsInSharePointEnabled - -Enables or disables notifications in SharePoint. - -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyOwnersWhenInvitationsAccepted - -When this parameter is set to $true and when an external user accepts an invitation to a resource in a user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail. - -For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. - -The valid values are $true and $false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotifyOwnersWhenItemsReshared - -When this parameter is set to $true and another user re-shares a document from a user's OneDrive for Business, the OneDrive for Business owner is notified by e-mail. - -For additional information about how to configure notifications for external sharing, see Configure notifications for external sharing for OneDrive for Business. - -The valid values are $true and $false. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: SharingState -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ODBMembersCanShare - -Lets administrators set policy on re-sharing behavior in OneDrive for Business. - -The valid values are: - -- 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: SharingState -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -If value is set to 0, the parameter will have no effect. - -If the value is set larger than the Maximum allowed OneDrive for Business quota, it will have no effect. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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 an anonymous links are created or changed. - -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -The valid values are: - -- True - Enable the Permissive browser file handling setting. -- False - Keep the default Strict browser file handling setting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventExternalUsersFromResharing - -Prevents external users from resharing files, folders, and sites that they do not own. - -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCdnAllowedFileTypes - -Sets public CDN allowed file types, if the public CDN is enabled. - -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublicCdnEnabled - -Enables or disables the public CDN. - -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAnonymousLinksExpireInDays - -Specifies all anonymous links that have been created (or will be created) will expire after the set number of days. - -To remove the expiration requirement, set the value to zero (0). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingAllowedDomainList - -Specifies a list of email domains that is 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). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharingBlockedDomainList - -Specifies a list of email domains that is 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). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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. - -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: SharingDomainRestrictionModes -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowPeoplePickerSuggestionsForGuestUsers - -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. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -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. - -The valid values are: - -- 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: SpecialCharactersState -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncPrivacyProfileProperties - -This parameter enables the synchronization of privacy profile properties. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseFindPeopleInPeoplePicker - -This feature enables tenant admins to enable ODB and SPO to respect Exchange supports Address Book Policy (ABP) policies in the people picker. - -> [!NOTE] -> When set to $true, users aren't able to share with security groups or SharePoint groups. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserVoiceForFeedbackEnabled - -Enables or disables the User Voice Feedback button. - -PARAMVALUE: $true | $false - -When set to $true, the "Feedback" link will be shown at the bottom of all modern SharePoint Online pages. The "Feedback" link will allow the end user to fill out a feedback form inside SharePoint Online which will then create an entry in the public SharePoint UserVoice topic. - -When set to $false, feedback link will not be shown anymore. It may take up to an hour for a change of this property to be reflected consistently throughout your tenant. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: $true -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 " - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -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`. - -When the feature is enabled, the Content Type Hub will push content types to OneDrive for Business sites. - -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: String[] -Parameter Sets: ParameterSetContentTypeSyncSiteTemplatesList -Aliases: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeSiteTemplate -Excludes the specified template from Content Type hub content type synchronization. Must be used with `-ContentTypeSyncSiteTemplatesList [String[]]`. - - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetContentTypeSyncSiteTemplatesList -Aliases: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConditionalAccessPolicy - -Please read [Control access from unmanaged devices](https://docs.microsoft.com/sharepoint/control-access-from-unmanaged-devices ) documentation here to understand Conditional Access Policy usage in SharePoint Online. - -PARAMVALUE: AllowFullAccess | AllowLimitedAccess | BlockAccess - -```yaml -Type: SPOConditionalAccessPolicyType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: AllowFullAccess -Accept pipeline input: True -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://. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDownloadingNonWebViewableFiles - -This paramater has been deprecated. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCommentsTextOnEmailEnabled - -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. - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -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 - -```yaml -Type: Boolean -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableAzureADB2BIntegration - -Enables the preview for OneDrive and SharePoint integration with Azure AD B2B. For more information see - -PARAMVALUE: $true | $false - -```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 -``` - -### -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 - -```yaml -Type: SPOLimitedAccessFileType -Parameter Sets: ParamSet1 -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: WebPreviewableFiles -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. - -The valid values are: -True - Enables the Policy. -False (default) - Disables the policy. - -```yaml -Type: Boolean - -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -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. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAttestationRequired - -Sets email attestation to required. - -```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 -``` - -### -EmailAttestationReAuthDays - -Sets the number of days for email attestation re-authentication. Value can be from 1 to 365 days. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockUserInfoVisibility - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -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. - -```yaml -Type: Boolean - -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -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. - -```yaml -Type: Boolean - -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncAadB2BManagementPolicy -Syncs Azure B2B Management Policies. For more information, see [SharePoint and OneDrive integration with Azure AD B2B](https://docs.microsoft.com/sharepoint/sharepoint-azureb2b-integration-preview). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopNew2010Workflows -Prevents creation of new SharePoint 2010 classic workflows. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopNew2013Workflows -Prevents creation of new SharePoint 2013 classic workflows. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockSendLabelMismatchEmail - -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. - -```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 -``` - -### -DisableOutlookPSTVersionTrimming - -As communicated in MC256835 (May ’21), starting August 16th 2021 the service will start retaining 30 days worth of versions for any PST files stored in OneDrive for Business and SharePoint Online team site document libraries. This change will 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. - -If you wish to opt-out of this policy change, you can use the parameter provided below. You will have until August 13th 2021, to opt-out. This is a one time opt-out operation. If you don’t opt-out by the deadline, the new behavior will automatically be enabled. The opt-out option for the cmdlet will have no effect after the deadline. Opt-out only applies to existing document libraries and does not apply to new doclibs created after August 13th 2021. - -PARAMVALUE: $true | $false - -```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 -``` - -### -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 - -```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 -``` - -### 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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Upgrade-SPOSite](Upgrade-SPOSite.md) - -[Set-SPOSite](Set-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md deleted file mode 100644 index ade6f811df..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnEnabled.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spotenantcdnenabled -applicable: SharePoint Online -title: Set-SPOTenantCdnEnabled -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOTenantCdnEnabled - -## SYNOPSIS - -Enables or disables Public content delivery network (CDN) or Private CDN on the tenant level. Requires Tenant administrator permissions. - -## SYNTAX - -```powershell -Set-SPOTenantCdnEnabled [-CdnType ] [-Confirm] [-Enable ] [-NoDefaultOrigins] - [-WhatIf] [] -``` - -## DESCRIPTION - -Enables or disables Public content delivery network (CDN) or Private CDN on the tenant level. - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Set-SPOTenantCdnEnabled -CdnType public -Enable $true -``` - -The example enables a CDN. - -## PARAMETERS - -### -CdnType - -Specifies the CDN type. The valid values are: public or private. - -```yaml -Type: SPOTenantCdnTypeClient -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private, Both -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: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable - -Specifies if the CDN is enabled. - -The valid values are: $True and $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDefaultOrigins - -PARAMVALUE: SwitchParameter - -```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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Set-SPOTenantCdnEnabled](Set-SPOTenantCdnEnabled.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md deleted file mode 100644 index d58e43dc70..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantCdnPolicy.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spotenantcdnpolicy -applicable: SharePoint Online -title: Set-SPOTenantCdnPolicy -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOTenantCdnPolicy - -## SYNOPSIS - -Sets the content delivery network (CDN) policies at the tenant level. - -## SYNTAX - -```powershell -Set-SPOTenantCdnPolicy -CdnType -PolicyType -PolicyValue [] -``` - -## DESCRIPTION - -Use this cmdlet to set the content delivery network (CDN) policies at the tenant level. - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- - -```powershell -Set-SPOTenantCdnPolicy -CdnType Public -PolicyType IncludeFileExtensions -PolicyValue "CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF,BMP" -``` - -This example sets a CDN to a public type with a policy value of listed extensions. - -### --------------------EXAMPLE 2--------------------- - -```powershell -Set-SPOTenantCdnPolicy -CdnType Public -PolicyType ExcludeRestrictedSiteClassifications -PolicyValue "Confidential,Restricted" -``` - -This example sets the ExcludeRestrictedSiteClassifications policy for the selected CdnType to a policy value of listed excluded site classifications. - -## PARAMETERS - -### -CdnType - -The CdnType parameter specifies the CDN type. The valid values are Public or Private. - -```yaml -Type: SPOTenantCdnType -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyType - -The PolicyType specifies the type of policy to set. - -Valid values: - -- IncludeFileExtensions -- ExcludeRestrictedSiteClassifications -- ExcludeIfNoScriptDisabled - -```yaml -Type: SPOTenantCdnPolicyType -Parameter Sets: (All) -Aliases: -Accepted values: IncludeFileExtensions, ExcludeRestrictedSiteClassifications, ExcludeIfNoScriptDisabled -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyValue - -A String representing the value of the policy type defined by the PolicyType parameter. - -```yaml -Type: String -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md deleted file mode 100644 index fcf3e4c721..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantContentTypeReplicationParameters.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spotenantcontenttypereplicationparameters -applicable: SharePoint Online -title: Set-SPOTenantContentTypeReplicationParameters -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOTenantContentTypeReplicationParameters - -## SYNOPSIS - -Select content types for replication - -## SYNTAX - -### ReplicateAllContentTypes - -```powershell -Set-SPOTenantContentTypeReplicationParameters [-ReplicateAllContentTypes] [] -``` - -### ReplicateSelectedContentTypes - -```powershell -Set-SPOTenantContentTypeReplicationParameters -ReplicatedContentTypes [] -``` - -## DESCRIPTION - -Before you run the cmdlets, please use 'Connect-SPOService' to connect to SharePoint Online first. -By default, all published content types in primary location will be replicated to satellite. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Set-SPOTenantContentTypeReplicationParameters -ReplicatedContentTypes "ct1","ct2" -``` - -Tenant admin can use this cmdlet to select only some content types only for replicating to overwrite default settings - -### EXAMPLE 2 - -```powershell -Set-SPOTenantContentTypeReplicationParameters -ReplicateAllContentTypes -``` - -Tenant admin can also reset to replicate all the content types. - -## PARAMETERS - -### -ReplicateAllContentTypes - -The ReplicateAllContentTypes parameter specifies whether all content types should be replicated. - -```yaml -Type: SwitchParameter -Parameter Sets: ReplicateAllContentTypes -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicatedContentTypes - -Specifies a comma separated list of content types that should be replicated. - -```yaml -Type: String[] -Parameter Sets: ReplicateSelectedContentTypes -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 - -[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) - -[Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) - -[Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) - -[Get-SPOTenantContentTypeReplicationParameters](Get-SPOTenantContentTypeReplicationParameters.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md deleted file mode 100644 index 247b6761d3..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantSyncClientRestriction.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spotenantsyncclientrestriction -applicable: SharePoint Online -title: Set-SPOTenantSyncClientRestriction -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOTenantSyncClientRestriction - -## SYNOPSIS - -Controls tenant-wide options and restrictions specific to syncing files. - -## SYNTAX - -### Blocking - -```powershell -Set-SPOTenantSyncClientRestriction [-BlockMacSync] [-DomainGuids ] [-Enable] [] -``` - -### ReportProblemDialogFeature - -```powershell -Set-SPOTenantSyncClientRestriction -DisableReportProblemDialog [] -``` - -### FileExclusion - -```powershell -Set-SPOTenantSyncClientRestriction [-ExcludedFileExtensions ] [] -``` - -### GrooveBlockOptions - -```powershell -Set-SPOTenantSyncClientRestriction [-GrooveBlockOption ] [] -``` - -## 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). - -You must be a SharePoint Online administrator or Global Administrator to run the cmdlet. - -Requires a valid Connect-SPOService context to identify the tenant. For information on how to connect to the tenant, see [Connect-SPOService](Connect-SPOService.md) - -The **Set-SPOTenantSyncClientRestriction** cmdlet is used to control a variety of tenant-wide administrative settings related to syncing files from OneDrive and SharePoint. You may use it to: - -* Set restrictions on whether users can sync items to non-domain joined machines, control the list of allowed domains, and manage whether Mac clients (which do not support domain join) can sync. - -* Prevents files with specific extensions from being synced. - -* Controls whether users can continue to sync OneDrive for Business libraries with the old OneDrive for Business sync client. - -**Restrict non-domain joined machines from syncing** - -The **Set-SPOTenantSyncClientRestriction** cmdlet can be used to enable the feature for tenancy and set the domain GUIDs in the safe recipients list. When this feature is enabled it can take up to 24 hours for the change to take effect. However, any changes to the safe domains list are reflected within five minutes. - -The **Set-SPOTenantSyncClientRestriction** cmdlet applies both to existing Microsoft OneDrive for Business sync client (Groove.exe) and the Microsoft OneDrive for Business Next Generation Sync Client (OneDrive.exe). OneDrive.exe is the new sync client that will sync both consumer and business accounts. - -> [!IMPORTANT] -> The new OneDrive for Business Next Generation Sync Client lets you connect and sync files from your OneDrive for Business. You can add a work or school account to the new OneDrive for Business sync client and sync all your files in OneDrive to your computer. For more information, see [Improve your OneDrive sync experience](https://go.microsoft.com/fwlink/p/?LinkId=717436). - -When the feature is enabled the following will occur: - -* All OneDrive for Business Sync client requests originating from a domain that is not on the safe recipients list will be blocked. -* All Microsoft OneDrive Mac Sync client and Mac Beta client requests will not be blocked by default. -* Microsoft OneDrive mobile apps are not blocked when this feature is enabled. -* Regardless whether a computer is managed by a device management solution, a sync relationship will not be established unless they are joined to a domain in the Safe Recipient List. -* Any files that have been previously been synced down to your computer will not be deleted. -* When this feature is enabled, please be aware the following upload behavior: - - * New or existing files added to the client will still be uploaded to the server and will not be blocked. - * Regardless if the computer is joined to a domain which is set in the Safe Recipient List. - * Regardless if the computer is joined to a domain which is not set in the Safe Recipient List. - * And for all non-domain joined computers. - -* Microsoft OneDrive for Business sync client prior to version 15.0.4693.1000 will stop syncing existing libraries. - -> [!IMPORTANT] -> In order to explicitly block Microsoft OneDrive client for Mac or OneDrive for Business Next Generation Sync Client on Mac OS X, please run the **Set-SPOTenantSyncClientRestriction** cmdlet with the **BlockMacSync** parameter set to true. For more information about the Next Generation Sync Client for Mac OS X, see [Get started with the new OneDrive sync client on Mac OS X](https://go.microsoft.com/fwlink/?LinkID=717727). -> [!IMPORTANT] -> There is a known OneDrive for Business sync client issue where syncing is being blocked even if a computer is joined to a domain which is set in the Safe Recipient List. To resolve this behavior, obtain the 15.0.4719.1000 version or higher of the sync client, see [May 12, 2015, update for OneDrive for Business](https://support.microsoft.com/en-us/kb/2986244/). -> [!NOTE] -> To determine the version of your Sync client, see [What version of the sync client am I using?](https://support.office.com/en-us/article/Which-version-of-OneDrive-am-I-using-19246eae-8a51-490a-8d97-a645c151f2ba). - -* The latest OneDrive for Business sync client can be downloaded from [Download OneDrive for Windows](https://go.microsoft.com/fwlink/?LinkID=404119&clcid=0x409) or [How to install OneDrive for Business for SharePoint and SharePoint Online](https://go.microsoft.com/fwlink/?LinkID=321300&clcid=0x409). - -> [!IMPORTANT] -> This capability doesn't support Microsoft Azure Active Directory (AD) Joined or Workplace Joined devices. - -For additional information about how to troubleshoot the OneDrive for Business sync client, see [How to switch from an MSI installation of OneDrive for Business (formerly SkyDrive Pro) standalone to a Click-To-Run installation of OneDrive for Business (formerly SkyDrive Pro) standalone](https://go.microsoft.com/fwlink/?LinkId=526386&clcid=0x409). - -**Block specific file extensions from syncing** - -The **Set-SPOTenantSyncClientRestriction** cmdlet can be used to configure a list of file extensions that should not be synced by the OneDrive sync client, such as .PST files. - -Any file extension may be blocked using this feature, but note that it may take up to 24 hours for a change to take affect across all user devices. When this feature is enabled, users syncing any file that is in the exclusion list will see an error message informing them of the block. - -> [!IMPORTANT] -> This feature is only supported by the new OneDrive for Business sync client. To determine the version of your Sync client, see [What version of the sync client am I using?](https://support.office.com/en-us/article/Which-version-of-OneDrive-am-I-using-19246eae-8a51-490a-8d97-a645c151f2ba). - -**Control whether users can use the old OneDrive for Business sync client** - -The **Set-SPOTenantSyncClientRestriction** cmdlet can be used to configure your tenant to allow or disallow users from using the old OneDrive for Business sync client to sync OneDrive for Business libraries. - -This feature is controlled on an opt-out model which lets users to continue syncing with the old sync client, you may choose to opt out of the Groove block. - -When this feature is enabled, the old OneDrive for Business sync client will stop syncing the user's OneDrive contents. OneDrive for Business users who are still using the old OneDrive for Business sync client will see an error message and will be prompted to launch and configure the new OneDrive for Business sync client. If they do not yet have the new client installed, they will have the opportunity to download and install it. - -If you opt out, users will be able to resume syncing with the old OneDrive for Business Sync client. -Note that it may take up to an hour for this change to be reflected. - -> [!NOTE] -> This feature only applies to syncing a user's own OneDrive for Business sites. Team Sites and shared content from other people's OneDrive for Business sites will continue to sync with the old OneDrive for Business sync client. - -## EXAMPLES - -### --------------------EXAMPLE 1--------------------- - -```powershell -Set-SPOTenantSyncClientRestriction -Enable -DomainGuids "786548DD-877B-4760-A749-6B1EFBC1190A; 877564FF-877B-4760-A749-6B1EFBC1190A" -``` - -This example enables the feature for the tenancy and adds the domains GUIDs to the safe recipient list. - -### --------------------EXAMPLE 2------------------ - -```powershell -Set-SPOTenantSyncClientRestriction -Enable -DomainGuids "786548DD-877B-4760-A749-6B1EFBC1190A; 877564FF-877B-4760-A749-6B1EFBC1190A" -BlockMacSync:$true -``` - -This example turns on the Block Mac sync functionality. - -### --------------------EXAMPLE 3------------------ - -```powershell -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------------------ - -```powershell -Set-SPOTenantSyncClientRestriction -ExcludedFileExtensions "" -``` - -This example clears the ExcludedFileExtension list and lets all file types synced with the new client (OneDrive.exe). - -### --------------------EXAMPLE 5------------------ - -```powershell -Set-SPOTenantSyncClientRestriction -GrooveBlockOption "OptOut" -``` - -This example allows users in a tenant to continue syncing OneDrive for Business libraries with the old OneDrive for Business sync client. - -### --------------------EXAMPLE 6------------------ - -```powershell -Set-SPOTenantSyncClientRestriction -GrooveBlockOption "HardOptIn" -``` - -This example blocks users in a tenant from syncing OneDrive for Business libraries using the old OneDrive for Business sync client. Users will be prompted to upgrade to the new client. - -## PARAMETERS - -### -BlockMacSync - -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 -Parameter Sets: Blocking -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableReportProblemDialog - -```yaml -Type: Boolean -Parameter Sets: ReportProblemDialogFeature -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainGuids - -Sets the domain GUID to add to the safe recipient list. Requires a minimum of 1 domain GUID. The maximum number of domain GUIDs allowed are 125. - -```yaml -Type: String -Parameter Sets: Blocking -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable - -Enables the feature to block sync originating from domains that are not present in the safe recipients list. - -```yaml -Type: SwitchParameter -Parameter Sets: Blocking -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedFileExtensions - -Blocks certain file types from syncing with the new sync client (OneDrive.exe). - -> [!NOTE] -> It may take up to one hour for changes to take effect. - -```yaml -Type: String -Parameter Sets: FileExclusion -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GrooveBlockOption - -Controls whether or not a tenant's users can sync OneDrive for Business libraries with the old OneDrive for Business sync client. -The valid values are **OptOut, HardOptin, and SoftOptin**. - -> [!NOTE] -> GrooveBlockOptions is planned to be deprecated. Please refrain from using the parameter. - -```yaml -Type: String -Parameter Sets: GrooveBlockOptions -Aliases: -Accepted values: OptOut, HardOptIn, SoftOptIn -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 - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md deleted file mode 100644 index 915ac15f10..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOTenantTaxonomyReplicationParameters.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spotenanttaxonomyreplicationparameters -applicable: SharePoint Online -title: Set-SPOTenantTaxonomyReplicationParameters -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOTenantTaxonomyReplicationParameters - -## SYNOPSIS - -Select groups for replication - -## SYNTAX - -### ReplicateAllGroups - -```powershell -Set-SPOTenantTaxonomyReplicationParameters [-ReplicateAllGroups] [] -``` - -### ReplicateSelectedGroups - -```powershell -Set-SPOTenantTaxonomyReplicationParameters -ReplicatedGroups [] -``` - -## 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. - -By default, all global groups except system/search/people/sitecollection in primary location will be replicated to -satellite. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Set-SPOTenantTaxonomyReplicationParameters -ReplicatedGroups "group1","group2" -``` - -Tenant admin can use this cmdlet to select some groups only for replicating to overwrite default settings. - -### EXAMPLE 2 - -```powershell -Set-SPOTenantTaxonomyReplicationParameters -ReplicateAllGroups -``` - -Tenant admin can also reset to replicate all the groups. - -## PARAMETERS - -### -ReplicateAllGroups - -PARAMVALUE: SwitchParameter - -```yaml -Type: SwitchParameter -Parameter Sets: ReplicateAllGroups -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicatedGroups - -PARAMVALUE: String[] - -```yaml -Type: String[] -Parameter Sets: ReplicateSelectedGroups -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 - -[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) - -[Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) - -[Get-SPOTenantContentTypeReplicationParameters](Get-SPOTenantContentTypeReplicationParameters.md) - -[Set-SPOTenantContentTypeReplicationParameters](Set-SPOTenantContentTypeReplicationParameters.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUnifiedGroup.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUnifiedGroup.md deleted file mode 100644 index 0865471551..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUnifiedGroup.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spounifiedgroup -applicable: SharePoint Online -title: Set-SPOUnifiedGroup -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Set-SPOUnifiedGroup - -## SYNOPSIS - -Sets the Preferred Data Location (PDL) for the specified Office 365 Group. The customer tenant must be multi-geo enabled. - -## SYNTAX - -```powershell -Set-SPOUnifiedGroup [-GroupAlias] [-PreferredDataLocation] [] -``` - -## DESCRIPTION - -Use this cmdlet to set the Preferred Data Location for an Office 365 Group. - -## EXAMPLES - -### Example 1 - -```powershell -Set-SPOUnifiedGroup -GroupAlias EUTeam -PreferredDataLocation EUR -``` - -Sets the PDL for the Office 365 Group named 'EUTeam' to EUR (Europe). - -## PARAMETERS - -### -GroupAlias - -The alias of the Office 365 Group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredDataLocation - -The Preferred Data Location for the Office 365 Group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -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/p/?LinkID=113216). - -## NOTES - -## RELATED LINKS - -[Get-SPOUnifiedGroup](https://docs.microsoft.com/powershell/module/sharepoint-online/get-spounifiedgroup) - -[Move a SharePoint site to a different geo location](https://docs.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md deleted file mode 100644 index 1c8c4e72b5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOUser.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spouser -applicable: SharePoint Online -title: Set-SPOUser -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Set-SPOUser - -## SYNOPSIS - -Configures properties on an existing user. - -## SYNTAX - -```powershell -Set-SPOUser -IsSiteCollectionAdmin -LoginName -Site [] -``` - -## DESCRIPTION - -Use the `Set-SPOUser` cmdlet to configure properties of an existing user. -That is, to add or remove a user as a SharePoint Online site collection administrator. - -You must have the SharePoint Online Administrator or Global Administrator role 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### --------------------EXAMPLE--------------------- - -```powershell -Set-SPOUser -Site https://contoso.sharepoint.com/sites/marketing -LoginName melissa.kerr@contoso.com -IsSiteCollectionAdmin $true -``` - -This example makes melissa.kerr@contoso.com a SharePoint Online site collection administrator on - -## PARAMETERS - -### -IsSiteCollectionAdmin - -Specifies whether the user is a site collection administrator. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoginName - -Specifies the user name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site - -Specifies the full URL of the site collection. It must be in a valid managed path in the company's site. - -```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 -``` - -### -UpdateUserTypeFromAzureAD -If the UserType property of an User is changed in AzureAD from Member to Guest and vice-versa, this parameter can be used to update it in SharePoint Online. -For more information, see [Convert UserType](https://docs.microsoft.com/azure/active-directory/b2b/user-properties#convert-usertype). - -```yaml -Type: 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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOUser](Get-SPOUser.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOWebTheme.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOWebTheme.md deleted file mode 100644 index 71d1458241..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOWebTheme.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/set-spowebtheme -applicable: SharePoint Online -title: Set-SPOWebTheme -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Set-SPOWebTheme - -## SYNOPSIS - -Sets the theme for a SharePoint site. - -## SYNTAX - -```powershell -Set-SPOWebTheme [-Theme] [-Web] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Use this cmdlet to set the custom theme for a Site - -## EXAMPLES - -### Example 1 - -```powershell - Set-SPOWebTheme -Theme "Custom cyan" -Web https://contoso.sharepoint.com/sites/Contoso1 -``` - -This example sets the "Custom Cyan" theme to the https://contoso.sharepoint.com/sites/Contoso1 site. - -## PARAMETERS - -### -Theme - -Name of the theme or SPOTheme object - -```yaml -Type: SpoThemePipeBind -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: True -Position: Named -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Web -Url of the site - -```yaml -Type: SpoSitePipeBind -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 -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 - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md deleted file mode 100644 index ae61bdb739..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteContentMove.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/start-spositecontentmove -applicable: SharePoint Online -title: Start-SPOSiteContentMove -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Start-SPOSiteContentMove - -## SYNOPSIS - -Start a job to move a particular user or group of users to be moved across geo locations relative to the one that executes the command - -## SYNTAX - -### UrlAndDestinationDataLocation - -```powershell -Start-SPOSiteContentMove [-SourceSiteUrl] [-DestinationDataLocation] - [[-PreferredMoveBeginDate] ] [[-PreferredMoveEndDate] ] [[-Reserved] ] - [-ValidationOnly] [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] [-SuppressAllWarnings] - [-SuppressBcsCheck][] -``` - -### UrlAndDestinationUrl - -```powershell -Start-SPOSiteContentMove [-SourceSiteUrl] [-DestinationUrl] [[-PreferredMoveBeginDate] ] - [[-PreferredMoveEndDate] ] [[-Reserved] ] [-ValidationOnly] [-SuppressMarketplaceAppCheck] [-SuppressWorkflow2013Check] - [-SuppressAllWarnings] [-SuppressBcsCheck] [] -``` - -## DESCRIPTION - -UrlAndDestinationDataLocation: These parameters allow a SharePoint administrator to validate a geo move before scheduling it. - -UrlAndDestinationUrl: These parameters allow a SharePoint administrator to move and (optionally) rename a site as part of the geo move operation by specifying a new site name in the destrination URL. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Start-SPOSiteContentMove -SourceSiteUrl https://contosoenergy.sharepoint.com/sites/hr -DestinationDataLocation EUR -``` - -Starts the movement of the content on to the EUR destination. - -### EXAMPLE 2 - -```powershell -Start-SPOSiteContentMove -SourceSiteUrl https://contosoenergy.sharepoint.com/sites/hr -DestinationDataLocation EUR -PreferredMoveBeginDate ((Get-Date).AddHours(1)) -PreferredMoveEndDate ((Get-Date).AddHour(12)) -``` - -Starts a site geo move for to the EUR destination with a preffered start time window of 1 to 12 hours from the move schedule operation. - -### EXAMPLE 3 - -```powershell -Start-SPOSiteContentMove -SourceSiteUrl https://contosoenergy.sharepoint.com/sites/hr -DestinationUrl https://contosoenergyEUR.sharepoint.com/sites/hrEU -``` - -Starts a site geo move for and allows site rename to as part of the geo move operation. - -## PARAMETERS - -### -DestinationDataLocation - -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 -Aliases: -Applicable: SharePoint Online -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationUrl - -Destination URL is optional in cases where the administrator wants to perform a site rename as part of the move. - -```yaml -Type: String -Parameter Sets: UrlAndDestinationUrl -Aliases: -Applicable: SharePoint Online -Required: False -Position: 1 -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. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reserved - -Reserved for Microsoft Internal use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceSiteUrl - -Specifies the source URL of the site collection you want to move. - -```yaml -Type: String -Parameter Sets: UrlAndDestinationDataLocation, UrlAndDestinationUrl -Aliases: -Applicable: SharePoint Online -Required: True -Position: 0 -Default value: None -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 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressBcsCheck -Suppress checking for Business Connectivity Services used with the associated site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressMarketplaceAppCheck -Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressWorkflow2013Check -Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Start-SPOSiteRename](Start-SPOSiteRename.md) - -[Stop-SPOUserAndContentMove](Stop-SPOUserAndContentMove.md) - -[Get-SPOUserAndContentMoveState](Get-SPOUserAndContentMoveState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteRename.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteRename.md deleted file mode 100644 index b62f8758d1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteRename.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/start-spositerename -applicable: SharePoint Online -title: Start-SPOSiteRename -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Start-SPOSiteRename - -## SYNOPSIS - -> [!NOTE] -> This Feature is part of the Admin Center Preview. If your tenant is not part of the Admin Center Preview, you will get an error when trying to run this cmdlet. - -Starts a job to rename a site. You can change the title, the URL or both of a particular site on a SharePoint Online collection - -## SYNTAX - -```Powershell -Start-SPOSiteRename [-Identity] [-NewSiteUrl] [[-NewSiteTitle] ] - [[-SuppressMarketplaceAppCheck]] [[-SuppressWorkflow2013Check]] [[-Reserved] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION - -This command starts a rename of a site on a SharePoint Online site into a new title, name and url. Also allows you to simulate the run using the -WhatIf parameter as well as -SuppressWorkflow2013Check and SuppressMarketplaceAppCheck switch parameters. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -$url="https://.sharepoint.com/site/samplesite" -$NewSiteUrl="https://.sharepoint.com/site/renamed" -Start-SPOSiteRename -Identity $url -NewSiteUrl $NewSiteUrl -``` - -Starts the rename of the SPO site with name "samplesite" to "renamed" without modifying the title. - -### EXAMPLE 2 - -```powershell -$url="https://.sharepoint.com/site/samplesite" -$NewSiteUrl="https://.sharepoint.com/site/renamed" -$newTitle="New Title" -Start-SPOSiteRename -Identity $url -NewSiteUrl $NewSiteUrl -NewSiteTitle $newTitle -``` - -Starts the rename of the SPO site with name "samplesite" to "renamed" modifying the title of the site to "New Title" - -### EXAMPLE 3 - -```powershell -$url="https://.sharepoint.com/site/samplesite" -$NewSiteUrl="https://.sharepoint.com/site/renamed" -$newTitle="New Title" -Start-SPOSiteRename -Identity $url -NewSiteUrl $NewSiteUrl -NewSiteTitle $newTitle -SuppressMarketplaceAppCheck -SuppressWorkflow2013Check -WhatIf -``` - -Starts the **simulation** rename of the SPO site with name "samplesite" to "renamed" modifying the title of the site to "New Title" without MarketPlaceAppCheck and without WorkFlow2013Check - -## PARAMETERS - -### -Identity - -Specifies the original URL of the site collection. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewSiteUrl - -Specifies the new desired URL. - -```yaml -Type: String -Parameter Sets: Default -Applicable: SharePoint Online - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewSiteTitle - -Specifies the new Title of the site. - -```yaml -Type: String -Parameter Sets: Default -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressMarketplaceAppCheck - -Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressWorkflow2013Check - -Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated site. - -```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 -``` - -### -Reserved - -PARAMVALUE: String - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Simulation of what would happen if you run the script without modifying anything. - -```yaml -Type: String -Parameter Sets: UrlAndDestinationDataLocation, UrlAndDestinationUrl -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 executing the command. For more information, type the following command: `get-help about_commonparameters` - -```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 -``` - -### 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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) - -[Stop-SPOUserAndContentMove](Stop-SPOUserAndContentMove.md) - -[Get-SPOUserAndContentMoveState](Get-SPOUserAndContentMoveState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUnifiedGroupMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUnifiedGroupMove.md deleted file mode 100644 index e6bf5e0f6f..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUnifiedGroupMove.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/start-spounifiedgroupmove -applicable: SharePoint Online -title: Start-SPOUnifiedGroupMove -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Start-SPOUnifiedGroupMove - -## SYNOPSIS - -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] [] -``` - -## 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. - -## EXAMPLES - -### Example 1 - -```powershell -Start-SPOUnifiedGroupMove -GroupAlias EUTeam -DestinationDataLocation EUR -``` - -Starts the move of an Office 365 Group site with an alias EUTeam to the Preferred Data Location EUR (Europe). - -## PARAMETERS - -### -DestinationDataLocation - -The destination location for the Office 365 Group site move. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupAlias - -The alias of the Office 365 Group attached to the site you want to move. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredMoveBeginDate - -The move will likely begin at this specified time. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredMoveEndDate - -The move will likely be completed by this specified time, on a best effort basis. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reserved - -This parameter is reserved for internal Microsoft use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressAllWarnings - -Suppress all warning messages. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressBcsCheck - -Suppress checking for Business Connectivity Services used with the associated Office 365 Group site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressMarketplaceAppCheck - -Suppress checking compatibility of marketplace SharePoint Add-ins deployed to the associated Office 365 Group site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuppressWorkflow2013Check - -Suppress checking compatibility of SharePoint 2013 Workflows deployed to the associated Office 365 Group site. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidationOnly - -This parameter will force the cmdlet to execute only validation. - -```yaml -Type: 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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Move a SharePoint site to a different geo location](https://docs.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md deleted file mode 100644 index f7e1e2dbec..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOUserAndContentMove.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/start-spouserandcontentmove -applicable: SharePoint Online -title: Start-SPOUserAndContentMove -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Start-SPOUserAndContentMove - -## SYNOPSIS - -Starts the ability to move a user closer to their sites. - -## SYNTAX - -```powershell -Start-SPOUserAndContentMove [-UserPrincipalName] [-DestinationDataLocation] - [[-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 ran by a SharePoint or Global administrator, who is connected to the SharePoint administration center of the geo location where the user is currently hosted. - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Start-SPOUserAndContentMove -UserPrincipalName username@contoso.onmicrosoft.com -DestinationDataLocation EUR -``` - -This example moves the user username@contoso.onmicrosoft.com from their current location, to the European location (EUR). - -### EXAMPLE 2 - -```powershell -Start-SPOUserAndContentMove -UserPrincipalName username@contoso.onmicrosoft.com -DestinationDataLocation JPN -``` - -This example moves the user username@contoso.onmicrosoft.com from their current location, to the Japanese location (JPN). - -### EXAMPLE 3 - -```powershell -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. - -## 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. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notify - -Provides an SPO notification that the user is being moved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -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 begin the move. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 4 -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -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. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: 8 -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](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Start-SPOSiteRename](Start-SPOSiteRename.md) - -[Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) - -[Stop-SPOUserAndContentMove](Stop-SPOUserAndContentMove.md) - -[Get-SPOUserAndContentMoveState](Get-SPOUserAndContentMoveState.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOSiteContentMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOSiteContentMove.md deleted file mode 100644 index 9794107b78..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOSiteContentMove.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/stop-spositecontentmove -applicable: SharePoint Online -title: Stop-SPOSiteContentMove -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Stop-SPOSiteContentMove - -## SYNOPSIS - -Stops a job to move a particular user or group of users to be moved across geo locations relative to the one that executes the command. - -## SYNTAX - -```powershell -Stop-SPOSiteContentMove [-SourceSiteUrl] [] -``` - -## DESCRIPTION - -Use this cmdlet to stop a job to move a particular user or group of users to be moved across geo locations relative to the one that executes the command. - -## EXAMPLES - -### Example 1 - -```powershell -Stop-SPOSiteContentMove -SourceSiteUrl https://contoso.sharepoint.com/sites/Research -``` - -This example stops the move job for the specified site. - -## PARAMETERS - -### -SourceSiteUrl - -Specifies the source URL of the site collection. - -```yaml -Type: 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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md b/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md deleted file mode 100644 index 1f7b8876e9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOUserAndContentMove.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/stop-spouserandcontentmove -applicable: SharePoint Online -title: Stop-SPOUserAndContentMove -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Stop-SPOUserAndContentMove - -## SYNOPSIS - -In a Multi-Geo company, stops the ability to move a user's content related objects in a SharePoint Online Tenant - -## SYNTAX - -```powershell -Stop-SPOUserAndContentMove [-UserPrincipalName] [] -``` - -## DESCRIPTION - -Stops the ability to move a user's content related objects in a SharePoint Online Tenant - -## EXAMPLES - -### EXAMPLE 1 - -```powershell -Stop-SPOUserAndContentMove -UserPrincipalName "TesIser@contoso.com" -``` - -This example stops the ability to move the "TesIser@contoso.com" user content in the current Tenant. - -### EXAMPLE 2 - -```powershell -Stop-SPOUserAndContentMove "TesIser@contoso.com" -``` - -Equivalent to the one above - -## PARAMETERS - -### -UserPrincipalName - -UserPrincipalName or UPN defined for the specific user on the SPO tenant - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -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). - -## 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) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md b/sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md deleted file mode 100644 index b710d46b61..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Submit-SPOMigrationJob.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/submit-spomigrationjob -applicable: SharePoint Online -title: Submit-SPOMigrationJob -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Submit-SPOMigrationJob - -## SYNOPSIS - -Cmdlet to submit a new migration job referenced to a previously uploaded package in Azure Blob storage into to a site collection. - -## SYNTAX - -### AzureLocationsInline - -```powershell -Submit-SPOMigrationJob [-TargetWebUrl] [-FileContainerUri] [-PackageContainerUri] - [-AzureQueueUri ] -Credentials - [-EncryptionParameters ] [-NoLogFile] [] -``` - -### AzureLocationsPipebind - -```powershell -Submit-SPOMigrationJob [-TargetWebUrl] - [-MigrationPackageAzureLocations] -Credentials - [-EncryptionParameters ] [-NoLogFile] [] -``` - -## 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. - -This cmdlet returns a GUID value which represents the MigrationJobId, or returns an empty GUID if the job was not successfully created. - -## EXAMPLES - -### -----------------------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" -``` - -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----------------------------- - -```powershell -Submit-SPOMigrationJob -TargetUrl https://contoso.sharepoint.com/sites/TargetSite/TargetWeb -MigrationPackageAzureLocations $azurelocations -``` - -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. - -## PARAMETERS - -### -AzureQueueUri - -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 -Parameter Sets: AzureLocationsInline -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credentials - -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 -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionParameters - -An EncryptionParameters object. See [New-SPOMigrationEncryptionParameters](https://docs.microsoft.com/powershell/module/sharepoint-online/new-spomigrationencryptionparameters) for more information. - -```yaml -Type: EncryptionParameters -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileContainerUri - -A fully qualified URL and SAS token representing the Azure Blob Storage container that holds the package content files. - -```yaml -Type: String -Parameter Sets: AzureLocationsInline -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationPackageAzureLocations - -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 -Parameter Sets: AzureLocationsPipebind -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NoLogFile - -Indicates to not create a log file. The default is to create a new CreateMigrationJob log file within the current directory. - -```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 -``` - -### -PackageContainerUri - -A fully qualified URL and SAS token representing the Azure Blob Storage container that holds the package metadata files. - -```yaml -Type: String -Parameter Sets: AzureLocationsInline -Aliases: -Applicable: SharePoint Online - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetWebUrl - -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 -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 - -### Microsoft.Online.SharePoint.Migration.MigrationPackageAzureLocations - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md deleted file mode 100644 index 1ebbe70ab5..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Test-SPOSite.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/test-sposite -applicable: SharePoint Online -title: Test-SPOSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Test-SPOSite - -## SYNOPSIS - -Tests a SharePoint Online site collection. - -## SYNTAX - -```powershell -Test-SPOSite -Identity [-RuleId ] [-RunAlways] [] -``` - -## DESCRIPTION - -The `Test-SPOSite` cmdlet runs one or all site collection health checks on the site collection and its contents. -Tests are intended not to make any changes except in repair mode, which can be initiated by running the `Repair-SPOSite` cmdlet. -This cmdlet reports the rules together with a summary of the results. - -You must be a SharePoint Online administrator or Global Administrator to run the `Test-SPOSite` 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell -Test-SPOSite https://contoso.sharepoint.com/sites/marketing -``` - -This example runs all the site collection health checks on the site collection. - -## PARAMETERS - -### -Identity - -Specifies the SharePoint Online site collection to test. - -```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 -``` - -### -RuleId - -Specifies the health check rule to run. - -```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 -``` - -### -RunAlways - -Displays a message that states the effect of the command instead of executing the command. - -```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 -``` - -### 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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) - -[Get-SPOSite](Get-SPOSite.md) - -[New-SPOSite](New-SPOSite.md) - -[Repair-SPOSite](Repair-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Unlock-SPOSensitivityLabelEncryptedFile.md b/sharepoint/sharepoint-ps/sharepoint-online/Unlock-SPOSensitivityLabelEncryptedFile.md deleted file mode 100644 index d72fb84458..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Unlock-SPOSensitivityLabelEncryptedFile.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/Unlock-SPOSensitivityLabelEncryptedFile -applicable: SharePoint Online -title: Unlock-SensitivityLabelEncryptedFile -schema: 2.0.0 -author: Sanjoyan -ms.author: samust -ms.reviewer: ---- - -# Unlock-SPOSensitivityLabelEncryptedFile - -## SYNOPSIS - -It removes encryption on a Sensitivity label encrypted file in SharePoint Online. No need to download the file. - -## SYNTAX - -```powershell -Unlock-SPOSensitivityLabelEncryptedFile -FileUrl -JustificationText -``` - -## DESCRIPTION - -The `Unlock-SPOSensitivityLabelEncryptedFile` cmdlet runs on a single office online file that is encrypted via sensitivity label. It decrypts the file and removes the label from the file. - -You must be a SharePoint Online administrator or Global Administrator to run the `Unlock-SPOSensitivityLabelEncryptedFile` cmdlet. Note, this cmdlet do not work on files that have labels with custom permission or user defined permission or double key encryption. - -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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps). - -## EXAMPLES - -### -----------------------EXAMPLE 1----------------------------- - -```powershell - Unlock-SPOSensitivityLabelEncryptedFile -FileUrl "https://contoso.com/sites/Marketing/Shared%20Documents/Doc1.docx" -JustificationText "Need to recover this file" -``` - -This example will remove a regular label with admin dedined encryption from the file Doc1.docx and also make an entry in audit logs. - -## PARAMETERS - -### -FileUrl - -Full URL for the file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -``` - -### -JustificationText - -Text that explains the reason to run this cmdlet on the given file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -Required: True -Position: Named -Default value: None -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Getting started with SharePoint Online Management Shell](https://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Get-SPOAppErrors](Get-SPOAppErrors.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md b/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md deleted file mode 100644 index fa8ee8f305..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Unregister-SPOHubSite.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/unregister-spohubsite -applicable: SharePoint Online -title: Unregister-SPOHubSite -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Unregister-SPOHubSite - -## SYNOPSIS - -Disables the hub site feature on a site. - -## SYNTAX - -```powershell -Unregister-SPOHubSite [-Identity] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Disables the hub site feature on a site so that it is no longer a hub site. Associated sites may still appear associated for up to an hour. If you want to speed up the process, use the Remove-SPOHubSiteAssociation cmdlet to remove the associated sites first. - -> [!NOTE] -> If the site doesn't exist, this cmdlet returns a "File not found" error. - -## EXAMPLES - -### Example 1 - -```powershell -Unregister-SPOHubSite -Identity -``` - -This example removes a site from the hub site list based on unique hub identifier (). - -### Example 2 - -```powershell -Unregister-SPOHubSite -Identity https://contoso.sharepoint.com/sites/Marketing -``` - -This example disables the hub feature on the marketing site. - -## PARAMETERS - -### -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 -Parameter Sets: (All) -Aliases: HubSite -Applicable: SharePoint Online - -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 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: SwitchParameter -Parameter Sets: (All) -Aliases: cf -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/p/?LinkID=113216). diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md deleted file mode 100644 index c902ead6fd..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Update-SPODataEncryptionPolicy.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/update-spodataencryptionpolicy -applicable: SharePoint Online -title: Update-SPODataEncryptionPolicy -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# Update-SPODataEncryptionPolicy - -## SYNOPSIS - -Updates customer encryption status for a geo tenant. - -## SYNTAX - -```powershell -Update-SPODataEncryptionPolicy [-KeyVaultName] [-KeyName] [-KeyVersion] [-KeyType] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -Use the Update-DataEncryptionPolicy cmdlet to update customer encryption status for your geo tenant. -For more information, see [Controlling your data in Office 365 using Customer Key](https://docs.microsoft.com/en-us/microsoft-365/compliance/controlling-your-data-using-customer-key) - -## EXAMPLES - -### Example 1 - -```powershell -Update-SPODataEncryptionPolicy -KeyVaultName -KeyName -KeyVersion -KeyType Primary -``` - -This example updates the DEP used with SharePoint Online and OneDrive for Business to start using the new key - -## 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) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyType - -The type of the key, possible values are - -- Primary -- Secondary - -```yaml -Type: CustomerKeyVaultKeyType -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVaultName - -The name of the Azure Key Vault Name - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyVersion - -The version of the key - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -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 - -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](http://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/Update-UserType.md b/sharepoint/sharepoint-ps/sharepoint-online/Update-UserType.md deleted file mode 100644 index 065a523817..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Update-UserType.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/update-usertype -applicable: SharePoint Online -title: Update-UserType -schema: 2.0.0 -author: techwriter40 -ms.author: pamgreen -ms.reviewer: ---- - -# Update-UserType - -## SYNOPSIS - -Updates the specified user's UserType value from Azure AD. - -## SYNTAX - -```powershell -Update-UserType [-LoginName] [] -``` - -## DESCRIPTION - -This cmdlet retrieves the UserType value of the specified user and updates the UserType across all SharePoint Online sites in the Office 365 tenant. This can be used, for example, to convert a Guest user to a standard (Member) user if the user's UserType was previously updated in Azure AD. - -## EXAMPLES - -### Example 1 - -```powershell -Update-UserType -LoginName jdoe@contoso.com -``` - -Updates the jdoe@contoso.com's UserType on all SharePoint Online sites in the tenant based on the UserType value in Azure AD. - -## PARAMETERS - -### -LoginName - -The login name of the target user to update across SharePoint Online. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: SharePoint Online - -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Properties of an Azure Active Directory B2B collaboration user](https://docs.microsoft.com/azure/active-directory/b2b/user-properties) 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 48a3a7400d..0000000000 --- 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://docs.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 a SharePoint Online administrator or Global 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://docs.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://docs.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps) - -[Request-SPOUpgradeEvaluationSite](Request-SPOUpgradeEvaluationSite.md) - -[New-SPOSite](New-SPOSite.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Verify-SPOTenantOrgRelation.md b/sharepoint/sharepoint-ps/sharepoint-online/Verify-SPOTenantOrgRelation.md deleted file mode 100644 index 35d995fa85..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/Verify-SPOTenantOrgRelation.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: sharepointonline.xml -Module Name: Microsoft.Online.SharePoint.PowerShell -online version: https://docs.microsoft.com/powershell/module/sharepoint-online/Verify-SPOTenantOrgRelation -applicable: SharePoint Online -title: Verify-SPOTenantOrgRelation -schema: 2.0.0 -author: trent-green -ms.author: trgreen -ms.reviewer: ---- -# Verify-SPOTenantOrgRelation - -## SYNOPSIS - -Note: Currently this cmdlet is part of pre-release functionality and may not function in your tenant. - -## SYNTAX - -```powershell -Verify-SPOTenantOrgRelation [-Scenario] [-PartnerRole] [-PartnerCompanyId] [-PartnerInstanceId ] [] -``` - -## DESCRIPTION - -{{ Fill in the Description }} - -## EXAMPLES - -### Example 1 - -```powershell -PS C:\> {{ Add example code here }} -``` - -{{ Add example description here }} - -## PARAMETERS - -### -PartnerCompanyId - -{{ Fill PartnerCompanyId Description }} - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -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 -Parameter Sets: (All) -Aliases: -Accepted values: None, Source, Target - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scenario - -{{ Fill Scenario Description }} - -```yaml -Type: OrgRelationScenario -Parameter Sets: (All) -Aliases: -Accepted values: None, MnA - -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](http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md b/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md deleted file mode 100644 index cf1933cd66..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md +++ /dev/null @@ -1,526 +0,0 @@ ---- -Module Name: SharePoint Online PowerShell -Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX -title: sharepoint-online -author: trent-green -ms.author: trgreen -ms.reviewer: ---- - -# SharePoint Online PowerShell - -## Description - -The following cmdlet references are for SharePoint Online. - -## sharepoint-online Cmdlets - -### [Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md) - -{{Manually Enter Add-SPOGeoAdministrator Description Here}} - -### [Add-SPOHubSiteAssociation](Add-SPOHubSiteAssociation.md) - -{{Manually Enter Add-SPOHubSiteAssociation Description Here}} - -### [Add-SPOOrgAssetsLibrary](Add-SPOOrgAssetsLibrary.md) - -{{Manually Enter Add-SPOOrgAssetsLibrary Description Here}} - -### [Add-SPOSiteDesign](Add-SPOSiteDesign.md) - -{{Manually Enter Add-SPOSiteDesign Description Here}} - -### [Add-SPOSiteDesign](Add-SPOSiteDesignTask.md) - -{{Manually Enter Add-SPOSiteDesignTask Description Here}} - -### [Add-SPOSiteScript](Add-SPOSiteScript.md) - -{{Manually Enter Add-SPOSiteScript Description Here}} - -### [Add-SPOTenantCdnOrigin](Add-SPOTenantCdnOrigin.md) - -{{Manually Enter Add-SPOTenantCdnOrigin Description Here}} - -### [Add-SPOTheme](Add-SPOTheme.md) - -{{Manually Enter Add-SPOTheme Description Here}} - -### [Add-SPOUser](Add-SPOUser.md) - -{{Manually Enter Add-SPOUser Description Here}} - -### [Approve-SPOTenantServicePrincipalPermissionRequest](Approve-SPOTenantServicePrincipalPermissionRequest.md) - -{{Manually Enter Approve-SPOTenantServicePrincipalPermissionRequest Description Here}} - -### [Connect-SPOService](Connect-SPOService.md) - -{{Manually Enter Connect-SPOService Description Here}} - -### [Deny-SPOTenantServicePrincipalPermissionRequest](Deny-SPOTenantServicePrincipalPermissionRequest.md) - -{{Manually Enter Deny-SPOTenantServicePrincipalPermissionRequest Description Here}} - -### [Disable-SPOTenantServicePrincipal](Disable-SPOTenantServicePrincipal.md) - -{{Manually Enter Connect-SPOService Description Here}} - -### [Disconnect-SPOService](Disconnect-SPOService.md) - -{{Manually Enter Disconnect-SPOService Description Here}} - -### [Enable-SPOTenantServicePrincipal](Enable-SPOTenantServicePrincipal.md) - -{{Manually Enter Enable-SPOTenantServicePrincipal Description Here}} - -### [Enable-SPOCommSite](Enable-SPOCommSite.md) - -{{Manually Enter Enable-SPOCommSite Description Here}} - -### [Export-SPOUserInfo](Export-SPOUserInfo.md) - -{{Manually Enter Export-SPOUserInfo Description Here}} - -### [Get-SPOAppErrors](Get-SPOAppErrors.md) - -{{Manually Enter Get-SPOAppErrors Description Here}} - -### [Get-SPOAppInfo](Get-SPOAppInfo.md) - -{{Manually Enter Get-SPOAppInfo Description Here}} - -### [Get-SPOCrossGeoMovedUsers](Get-SPOCrossGeoMovedUsers.md) - -{{Manually Enter Get-SPOCrossGeoMovedUsers Description Here}} - -### [Get-SPOCrossGeoUsers](Get-SPOCrossGeoUsers.md) - -{{Manually Enter Get-SPOCrossGeoUsers Description Here}} - -### [Get-SPODeletedSite](Get-SPODeletedSite.md) - -{{Manually Enter Get-SPODeletedSite Description Here}} - -### [Get-SPOExternalUser](Get-SPOExternalUser.md) - -{{Manually Enter Get-SPOExternalUser Description Here}} - -### [Get-SPOGeoAdministrator](Get-SPOGeoAdministrator.md) - -{{Manually Enter Get-SPOGeoAdministrators Description Here}} - -### [Get-SPOGeoMoveCompatibilityStatus](Get-SPOGeoMoveCompatibilityStatus.md) - -{{Manually Enter Get-SPOGeoMoveCompatibilityStatus Description Here}} - -### [Get-SPOGeoStorageQuota](Get-SPOGeoStorageQuota.md) - -{{Manually Enter Get-SPOGeoStorageQuota Description Here}} - -### [Get-SPOHideDefaultThemes](Get-SPOHideDefaultThemes.md) - -{{Manually Enter Get-SPOHideDefaultThemes Description Here}} - -### [Get-SPOHubSite](Get-SPOHubSite.md) - -{{Manually Enter Get-SPOHubSite Description Here}} - -### [Get-SPOMigrationJobProgress](Get-SPOMigrationJobProgress.md) - -{{Manually Enter Get-SPOMigrationJobProgress Description Here}} - -### [Get-SPOMigrationJobStatus](Get-SPOMigrationJobStatus.md) - -{{Manually Enter Get-SPOMigrationJobStatus Description Here}} - -### [Get-SPOOrgAssetsLibrary](Get-SPOOrgAssetsLibrary.md) - -{{Manually Enter Get-SPOOrgAssetsLibrary Description Here}} - -### [Get-SPOPublicCdnOrigins](Get-SPOPublicCdnOrigins.md) - -{{Manually Enter Get-SPOPublicCdnOrigins Description Here}} - -### [Get-SPOSite](Get-SPOSite.md) - -{{Manually Enter Get-SPOSite Description Here}} - -### [Get-SPOSiteContentMoveState](Get-SPOSiteContentMoveState.md) - -{{Manually Enter Get-SPOSiteContentMoveState Description Here}} - -### [Get-SPOSiteDesign](Get-SPOSiteDesign.md) - -{{Manually Enter Get-SPOSiteDesign Description Here}} - -### [Get-SPOSiteDesignRun](Get-SPOSiteDesignRun.md) - -{{Manually Enter Get-SPOSiteDesignRights Description Here}} - -### [Get-SPOSiteDesignRunStatus](Get-SPOSiteDesignRunStatus.md) - -{{Manually Enter Get-SPOSiteDesignRights Description Here}} - -### [Get-SPOSiteDesignRights](Get-SPOSiteDesignRights.md) - -{{Manually Enter Get-SPOSiteDesignRights Description Here}} - -### [Get-SPOSiteDesignTask](Get-SPOSiteDesignTask.md) - -{{Manually Enter Add-SPOSiteDesign Description Here}} - -### [Get-SPOSiteGroup](Get-SPOSiteGroup.md) - -{{Manually Enter Get-SPOSiteGroup Description Here}} - -### [Get-SPOSiteScript](Get-SPOSiteScript.md) - -{{Manually Enter Get-SPOSiteScript Description Here}} - -### [Get-SPOSiteScriptFromList](Get-SPOSiteScriptFromList.md) - -{{Manually Enter Get-SPOSiteScript Description Here}} - -### [Get-SPOStructuralNavigationCacheSiteState](Get-SPOStructuralNavigationCacheSiteState.md) - -{{Manually Enter Get-SPOStructuralNavigationCacheSiteState Description Here}} - -### [Get-SPOStructuralNavigationCacheWebState](Get-SPOStructuralNavigationCacheWebState.md) - -{{Manually Enter Get-SPOStructuralNavigationCacheWebState Description Here}} - -### [Get-SPOTenant](Get-SPOTenant.md) - -{{Manually Enter Get-SPOTenant Description Here}} - -### [Get-SPOTenantCdnEnabled](Get-SPOTenantCdnEnabled.md) - -{{Manually Enter Get-SPOTenantCdnEnabled Description Here}} - -### [Get-SPOTenantCdnOrigins](Get-SPOTenantCdnOrigins.md) - -{{Manually Enter Get-SPOTenantCdnOrigins Description Here}} - -### [Get-SPOTenantCdnPolicies](Get-SPOTenantCdnPolicies.md) - -{{Manually Enter Get-SPOTenantCdnPolicies Description Here}} - -### [Get-SPOTenantContentTypeReplicationParameters](Get-SPOTenantContentTypeReplicationParameters.md) - -{{Manually Enter Get-SPOTenantContentTypeReplicationParameters Description Here}} - -### [Get-SPOTenantLogEntry](Get-SPOTenantLogEntry.md) - -{{Manually Enter Get-SPOTenantLogEntry Description Here}} - -### [Get-SPOTenantLogLastAvailableTimeInUtc](Get-SPOTenantLogLastAvailableTimeInUtc.md) - -{{Manually Enter Get-SPOTenantLogLastAvailableTimeInUtc Description Here}} - -### [Get-SPOTenantServicePrincipalPermissionGrants](Get-SPOTenantServicePrincipalPermissionGrants.md) - -{{Manually Enter Get-SPOTenantServicePrincipalPermissionGrants Description Here}} - -### [Get-SPOTenantServicePrincipalPermissionRequests](Get-SPOTenantServicePrincipalPermissionRequests.md) - -{{Manually Enter Get-SPOTenantServicePrincipalPermissionRequests Description Here}} - -### [Get-SPOTenantSyncClientRestriction](Get-SPOTenantSyncClientRestriction.md) - -{{Manually Enter Get-SPOTenantSyncClientRestriction Description Here}} - -### [Get-SPOTenantTaxonomyReplicationParameters](Get-SPOTenantTaxonomyReplicationParameters.md) - -{{Manually Enter Get-SPOTenantTaxonomyReplicationParameters Description Here}} - -### [Get-SPOTheme](Get-SPOTheme.md) - -{{Manually Enter Get-SPOTheme Description Here}} - -### [Get-SPOUser](Get-SPOUser.md) - -{{Manually Enter Get-SPOUser Description Here}} - -### [Get-SPOUserAndContentMoveState](Get-SPOUserAndContentMoveState.md) - -{{Manually Enter Get-SPOUserAndContentMoveState Description Here}} - -### [Get-SPOUserOneDriveLocation](Get-SPOUserOneDriveLocation.md) - -{{Manually Enter Get-SPOUserOneDriveLocation Description Here}} - -### [Get-SPOWebTemplate](Get-SPOWebTemplate.md) - -{{Manually Enter Get-SPOWebTemplate Description Here}} - -### [Grant-SPOHubSiteRights](Grant-SPOHubSiteRights.md) - -{{Manually Enter Grant-SPOHubSiteRights Description Here}} - -### [Grant-SPOSiteDesignRights](Grant-SPOSiteDesignRights.md) - -{{Manually Enter Grant-SPOSiteDesignRights Description Here}} - -### [Invoke-SPOMigrationEncryptUploadSubmit](Invoke-SPOMigrationEncryptUploadSubmit.md) - -{{Manually Enter Invoke-SPOMigrationEncryptUploadSubmit Description Here}} - -### [Invoke-SPOSiteDesign](Invoke-SPOSiteDesign.md) - -{{Manually Enter Invoke-SPOSiteDesign Description Here}} - -### [Invoke-SPOSiteSwap](Invoke-SPOSiteSwap.md) - -{{Manually Enter Invoke-SPOSiteSwap Description Here}} - -### [New-SPODataConnectionSetting](New-SPODataConnectionSetting.md) - -{{Manually Enter New-SPODataConnectionSetting Description Here}} - -### [New-SPOMigrationEncryptionParameters](New-SPOMigrationEncryptionParameters.md) - -{{Manually Enter New-SPOMigrationEncryptionParameters Description Here}} - -### [New-SPOMigrationPackage](New-SPOMigrationPackage.md) - -{{Manually Enter New-SPOMigrationPackage Description Here}} - -### [New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy](New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy.md) - -{{Manually Enter New-SPOnlineApplicationPrincipalManagementServiceApplicationProxy Description Here}} - -### [New-SPOPublicCdnOrigin](New-SPOPublicCdnOrigin.md) - -{{Manually Enter New-SPOPublicCdnOrigin Description Here}} - -### [New-SPOSdnProvider](New-SPOSdnProvider.md) - -{{Manually Enter New-SPOSdnProvider Description Here}} - -### [New-SPOSite](New-SPOSite.md) - -{{Manually Enter New-SPOSite Description Here}} - -### [New-SPOSiteGroup](New-SPOSiteGroup.md) - -{{Manually Enter New-SPOSiteGroup Description Here}} - -### [Register-SPOHubSite](Register-SPOHubSite.md) - -{{Manually Enter Register-SPOHubSite Description Here}} - -### [Remove-SPODataConnectionSetting](Remove-SPODataConnectionSetting.md) - -{{Manually Enter Remove-SPODataConnectionSetting Description Here}} - -### [Remove-SPODeletedSite](Remove-SPODeletedSite.md) - -{{Manually Enter Remove-SPODeletedSite Description Here}} - -### [Remove-SPOExternalUser](Remove-SPOExternalUser.md) - -{{Manually Enter Remove-SPOExternalUser Description Here}} - -### [Remove-SPOGeoAdministrator](Remove-SPOGeoAdministrator.md) - -{{Manually Enter Remove-SPOGeoAdministrator Description Here}} - -### [Remove-SPOHubSiteAssociation](Remove-SPOHubSiteAssociation.md) - -{{Manually Enter Remove-SPOHubSiteAssociation Description Here}} - -### [Remove-SPOMigrationJob](Remove-SPOMigrationJob.md) - -{{Manually Enter Remove-SPOMigrationJob Description Here}} - -### [Remove-SPOOrgAssetsLibrary](Remove-SPOOrgAssetsLibrary.md) - -{{Manually Enter Remove-SPOOrgAssetsLibrary Description Here}} - -### [Remove-SPOPublicCdnOrigin](Remove-SPOPublicCdnOrigin.md) - -{{Manually Enter Remove-SPOPublicCdnOrigin Description Here}} - -### [Remove-SPOSdnProvider](Remove-SPOSdnProvider.md) - -{{Manually Enter Remove-SPOSdnProvider Description Here}} - -### [Remove-SPOSite](Remove-SPOSite.md) - -{{Manually Enter Remove-SPOSite Description Here}} - -### [Remove-SPOSiteDesign](Remove-SPOSiteDesign.md) - -{{Manually Enter Remove-SPOSiteDesign Description Here}} - -### [Remove-SPOSiteDesignTask](Remove-SPOSiteDesignTask.md) - -{{Manually Enter Remove-SPOSiteDesign Description Here}} - -### [Remove-SPOSiteGroup](Remove-SPOSiteGroup.md) - -{{Manually Enter Remove-SPOSiteGroup Description Here}} - -### [Remove-SPOSiteScript](Remove-SPOSiteScript.md) - -{{Manually Enter Remove-SPOSiteScript Description Here}} - -### [Remove-SPOTenantCdnOrigin](Remove-SPOTenantCdnOrigin.md) - -{{Manually Enter Remove-SPOTenantCdnOrigin Description Here}} - -### [Remove-SPOTenantSyncClientRestriction](Remove-SPOTenantSyncClientRestriction.md) - -{{Manually Enter Remove-SPOTenantSyncClientRestriction Description Here}} - -### [Remove-SPOTheme](Remove-SPOTheme.md) - -{{Manually Enter Remove-SPOTheme Description Here}} - -### [Remove-SPOUser](Remove-SPOUser.md) - -{{Manually Enter Remove-SPOUser Description Here}} - -### [Repair-SPOSite](Repair-SPOSite.md) - -{{Manually Enter Repair-SPOSite Description Here}} - -### [Request-SPOPersonalSite](Request-SPOPersonalSite.md) - -{{Manually Enter Request-SPOPersonalSite Description Here}} - -### [Request-SPOUpgradeEvaluationSite](Request-SPOUpgradeEvaluationSite.md) - -{{Manually Enter Request-SPOUpgradeEvaluationSite Description Here}} - -### [Restore-SPODeletedSite](Restore-SPODeletedSite.md) - -{{Manually Enter Restore-SPODeletedSite Description Here}} - -### [Revoke-SPOHubSiteRights](Revoke-SPOHubSiteRights.md) - -{{Manually Enter Revoke-SPOHubSiteRights Description Here}} - -### [Revoke-SPOSiteDesignRights](Revoke-SPOSiteDesignRights.md) - -{{Manually Enter Revoke-SPOSiteDesignRights Description Here}} - -### [Revoke-SPOTenantServicePrincipalPermission](Revoke-SPOTenantServicePrincipalPermission.md) - -{{Manually Enter Revoke-SPOTenantServicePrincipalPermission Description Here}} - -### [Revoke-SPOUserSession](Revoke-SPOUserSession.md) - -{{Manually Enter Revoke-SPOUserSession Description Here}} - -### [Set-SPODataConnectionSetting](Set-SPODataConnectionSetting.md) - -{{Manually Enter Set-SPODataConnectionSetting Description Here}} - -### [Set-SPODataConnectionSettingMetadata](Set-SPODataConnectionSettingMetadata.md) - -{{Manually Enter Set-SPODataConnectionSettingMetadata Description Here}} - -### [Set-SPOGeoStorageQuota](Set-SPOGeoStorageQuota.md) - -{{Manually Enter Set-SPOGeoStorageQuota Description Here}} - -### [Set-SPOHideDefaultThemes](Set-SPOHideDefaultThemes.md) - -{{Manually Enter Set-SPOHideDefaultThemes Description Here}} - -### [Set-SPOHubSite](Set-SPOHubSite.md) - -{{Manually Enter Set-SPOHubSite Description Here}} - -### [Set-SPOMigrationPackageAzureSource](Set-SPOMigrationPackageAzureSource.md) - -{{Manually Enter Set-SPOMigrationPackageAzureSource Description Here}} - -### [Set-SPOOrgAssetsLibrary](Set-SPOOrgAssetsLibrary.md) - -{{Manually Enter Set-SPOOrgAssetsLibrary Description Here}} - -### [Set-SPOSite](Set-SPOSite.md) - -{{Manually Enter Set-SPOSite Description Here}} - -### [Set-SPOSiteDesign](Set-SPOSiteDesign.md) - -{{Manually Enter Set-SPOSiteDesign Description Here}} - -### [Set-SPOSiteGroup](Set-SPOSiteGroup.md) - -{{Manually Enter Set-SPOSiteGroup Description Here}} - -### [Set-SPOSiteScript](Set-SPOSiteScript.md) - -{{Manually Enter Set-SPOSiteScript Description Here}} - -### [Set-SPOStructuralNavigationCacheSiteState](Set-SPOStructuralNavigationCacheSiteState.md) - -{{Manually Enter Set-SPOStructuralNavigationCacheSiteState Description Here}} - -### [Set-SPOStructuralNavigationCacheWebState](Set-SPOStructuralNavigationCacheWebState.md) - -{{Manually Enter Set-SPOStructuralNavigationCacheWebState Description Here}} - -### [Set-SPOTenant](Set-SPOTenant.md) - -{{Manually Enter Set-SPOTenant Description Here}} - -### [Set-SPOTenantCdnEnabled](Set-SPOTenantCdnEnabled.md) - -{{Manually Enter Set-SPOTenantCdnEnabled Description Here}} - -### [Set-SPOTenantCdnPolicy](Set-SPOTenantCdnPolicy.md) - -{{Manually Enter Set-SPOTenantCdnPolicy Description Here}} - -### [Set-SPOTenantContentTypeReplicationParameters](Set-SPOTenantContentTypeReplicationParameters.md) - -{{Manually Enter Set-SPOTenantContentTypeReplicationParameters Description Here}} - -### [Set-SPOTenantSyncClientRestriction](Set-SPOTenantSyncClientRestriction.md) - -{{Manually Enter Set-SPOTenantSyncClientRestriction Description Here}} - -### [Set-SPOTenantTaxonomyReplicationParameters](Set-SPOTenantTaxonomyReplicationParameters.md) - -{{Manually Enter Set-SPOTenantTaxonomyReplicationParameters Description Here}} - -### [Set-SPOUser](Set-SPOUser.md) - -{{Manually Enter Set-SPOUser Description Here}} - -### [Start-SPOSiteContentMove](Start-SPOSiteContentMove.md) - -{{Manually Enter Start-SPOSiteContentMove Description Here}} - -### [Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) - -{{Manually Enter Start-SPOUserAndContentMove Description Here}} - -### [Stop-SPOUserAndContentMove](Stop-SPOUserAndContentMove.md) - -{{Manually Enter Stop-SPOUserAndContentMove Description Here}} - -### [Submit-SPOMigrationJob](Submit-SPOMigrationJob.md) - -{{Manually Enter Submit-SPOMigrationJob Description Here}} - -### [Test-SPOSite](Test-SPOSite.md) - -{{Manually Enter Test-SPOSite Description Here}} - -### [Unregister-SPOHubSite](Unregister-SPOHubSite.md) - -{{Manually Enter Unregister-SPOHubSite Description Here}} - -### [Upgrade-SPOSite](Upgrade-SPOSite.md) - -{{Manually Enter Upgrade-SPOSite Description Here}} - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md deleted file mode 100644 index 857e83caa6..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAlert.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPAlert.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPAlert ---- - -# Add-PnPAlert - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPAlert.md to change this file. - -Adds an alert for a user to a list - -## SYNTAX - -```powershell -Add-PnPAlert [-List] [-Title ] [-User ] - [-DeliveryMethod ] [-ChangeType ] [-Frequency ] - [-Filter ] [-Time ] [-Connection ] - [] -``` - -## DESCRIPTION -This cmdlets allows to add an alert for a user to a list. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-PnPAlert -List "Demo List" -``` - -Adds a new alert to the "Demo List" for the current user. - -### EXAMPLE 2 -```powershell -Add-PnPAlert -Title "Daily summary" -List "Demo List" -Frequency Daily -ChangeType All -Time (Get-Date -Hour 11 -Minute 00 -Second 00) -``` - -Adds a daily alert for the current user at the given time to the "Demo List". Note: a timezone offset might be applied so please verify on your tenant that the alert indeed got the right time. - -### EXAMPLE 3 -```powershell -Add-PnPAlert -Title "Alert for user" -List "Demo List" -User "i:0#.f|membership|Alice@contoso.onmicrosoft.com" -``` - -Adds a new alert for user "Alice" to the "Demo List". Note: Only site owners and admins are permitted to set alerts for other users. - -## PARAMETERS - -### -ChangeType -Alert change type - -```yaml -Type: AlertEventType -Parameter Sets: (All) -Accepted values: AddObject, ModifyObject, DeleteObject, Discussion, All - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: PnPConnection -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeliveryMethod -Alert delivery method - -```yaml -Type: AlertDeliveryChannel -Parameter Sets: (All) -Accepted values: Email, Sms - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Alert filter - -```yaml -Type: AlertFilter -Parameter Sets: (All) -Accepted values: AnythingChanges, SomeoneElseChangesAnItem, SomeoneElseChangesItemCreatedByMe, SomeoneElseChangesItemLastModifiedByMe - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Frequency -Alert frequency - -```yaml -Type: AlertFrequency -Parameter Sets: (All) -Accepted values: Immediate, Daily, Weekly - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -List -The ID, Title or Url of the list. - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Time -Alert time (if frequency is not immediate) - -```yaml -Type: DateTime -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -Alert title - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -User to create the alert for (User ID, login name or actual User object). Skip this parameter to create an alert for the current user. Note: Only site owners can create alerts for other users. - -```yaml -Type: UserPipeBind -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - - -## RELATED LINKS - -[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md deleted file mode 100644 index 1460566e8c..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApp.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPApp.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPApp ---- - -# Add-PnPApp - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPApp.md to change this file. - -Add/uploads an available app to the app catalog - -## SYNTAX - -```powershell -Add-PnPApp [-Path] [-Scope ] [-Overwrite] [-Timeout ] [-Publish [-SkipFeatureDeployment]] - [-Connection ] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-PnPApp -Path ./myapp.sppkg -``` - -This will upload the specified app package to the app catalog - -### EXAMPLE 2 -```powershell -Add-PnPApp -Path ./myapp.sppkg -Publish -``` - -This will upload the specified app package to the app catalog and deploy/trust it at the same time. - -### EXAMPLE 3 -```powershell -Add-PnPApp -Path ./myapp.sppkg -Scope Site -Publish -``` - -This will upload the specified app package to the site collection app catalog and deploy/trust it at the same time. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: PnPConnection -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Overwrite -Overwrites the existing app package if it already exists - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the Id or an actual app metadata instance - -```yaml -Type: String -Parameter Sets: (All) -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Publish -This will deploy/trust an app into the app catalog - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Defines which app catalog to use. Defaults to Tenant - -```yaml -Type: AppCatalogScope -Parameter Sets: (All) -Accepted values: Tenant, Site -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipFeatureDeployment - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the timeout in seconds. Defaults to 200. - -```yaml -Type: Int32 -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## RELATED LINKS - -[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApplicationCustomizer.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApplicationCustomizer.md deleted file mode 100644 index 38064977a9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPApplicationCustomizer.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPApplicationCustomizer.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPApplicationCustomizer ---- - -# Add-PnPApplicationCustomizer - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPApplicationCustomizer.md to change this file. - -Adds a SharePoint Framework client side extension application customizer - -## SYNTAX - -```powershell -Add-PnPApplicationCustomizer [-Title ] [-Description ] [-Sequence ] - [-Scope ] -ClientSideComponentId [-ClientSideComponentProperties ] - [-ClientSideHostProperties ] [-Connection ] [] -``` - -## DESCRIPTION -Adds a SharePoint Framework client side extension application customizer by registering a user custom action to a web or sitecollection - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-PnPApplicationCustomizer -Title "CollabFooter" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"} -``` - -Adds a new application customizer to the current web. This requires that a SharePoint Framework solution has been deployed containing the application customizer specified in its manifest. Be sure to run Install-PnPApp before trying this cmdlet on a site. - -## PARAMETERS - -### -ClientSideComponentId -The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest - -```yaml -Type: Guid -Parameter Sets: (All) -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientSideComponentProperties -The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}" - -```yaml -Type: String -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientSideHostProperties -The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}" - -```yaml -Type: String -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: PnPConnection -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -The description of the application customizer - -```yaml -Type: String -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command. - -```yaml -Type: CustomActionScope -Parameter Sets: (All) -Accepted values: Web, Site, All -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sequence -Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page. - -```yaml -Type: Int32 -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -The title of the application customizer - -```yaml -Type: String -Parameter Sets: (All) -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## RELATED LINKS - -[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAzureADGroupMember.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAzureADGroupMember.md deleted file mode 100644 index 0025607839..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAzureADGroupMember.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPAzureADGroupMember.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPAzureADGroupMember ---- - -# Add-PnPAzureADGroupMember - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPAzureADGroupMember.md to change this file. - - -**Required Permissions** - - * Microsoft Graph API: All of Group.ReadWrite.All, User.ReadWrite.All - -Adds members to a particular Azure Active Directory Group. This can be a security, distribution or Microsoft 365 group. - -## SYNTAX - -```powershell -Add-PnPAzureADGroupMember -Identity -Users [-RemoveExisting] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-PnPAzureADGroupMember -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" -``` - -Adds the provided two users as additional members to the Azure Active Directory Group named "Project Team" - -### EXAMPLE 2 -```powershell -Add-PnPAzureADGroupMember -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" -RemoveExisting -``` - -Sets the provided two users as the only members of the Azure Active Directory group named "Project Team" by removing any current existing members first - -## PARAMETERS - -### -Identity -The Identity of the Azure Active Directory group to add members to - -```yaml -Type: AzureADGroupPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RemoveExisting -If provided, all existing members will be removed and only those provided through Users will become members - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Users -The UPN(s) of the user(s) to add to the Azure Active Directory group as a member - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## RELATED LINKS - -[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)[Documentation](https://docs.microsoft.com/graph/api/group-post-members) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAzureADGroupOwner.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAzureADGroupOwner.md deleted file mode 100644 index 403c027cd1..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPAzureADGroupOwner.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPAzureADGroupOwner.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPAzureADGroupOwner ---- - -# Add-PnPAzureADGroupOwner - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPAzureADGroupOwner.md to change this file. - - -**Required Permissions** - - * Microsoft Graph API: All of Group.ReadWrite.All, User.ReadWrite.All - -Adds users to the owners of an Azure Active Directory group. This can be a security, distribution or Microsoft 365 group. - -## SYNTAX - -```powershell -Add-PnPAzureADGroupOwner -Identity -Users [-RemoveExisting] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-PnPAzureADGroupOwner -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" -``` - -Adds the provided two users as additional owners to the Azure Active Directory group named "Project Team" - -### EXAMPLE 2 -```powershell -Add-PnPAzureADGroupOwner -Identity "Project Team" -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com" -RemoveExisting -``` - -Sets the provided two users as the only owners of the Azure Active Directory group named "Project Team" by removing any current existing members first - -## PARAMETERS - -### -Identity -The Identity of the Azure Active Directory group to add owners to - -```yaml -Type: AzureADGroupPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RemoveExisting -If provided, all existing members will be removed and only those provided through Users will become members - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Users -The UPN(s) of the user(s) to add to the Azure Active Directory group as a member - -```yaml -Type: String[] -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## RELATED LINKS - -[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) -[Documentation](https://docs.microsoft.com/graph/api/group-post-members) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md deleted file mode 100644 index 1157536c41..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentType.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPContentType.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPContentType ---- - -# Add-PnPContentType - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPContentType.md to change this file. - -Adds a new content type - -## SYNTAX - -```powershell -Add-PnPContentType -Name [-ContentTypeId ] [-Description ] [-Group ] - [-ParentContentType ] [-Connection ] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-PnPContentType -Name "Project Document" -Description "Use for Contoso projects" -Group "Contoso Content Types" -ParentContentType $ct -``` - -This will add a new content type based on the parent content type stored in the $ct variable. - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: PnPConnection -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentTypeId -If specified, in the format of 0x0100233af432334r434343f32f3, will create a content type with the specific ID - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the new content type - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the group of the new content type - -```yaml -Type: String -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specify the name of the new content type - -```yaml -Type: String -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentContentType -Specifies the parent of the new content type - -```yaml -Type: ContentType -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - - -## RELATED LINKS - -[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md deleted file mode 100644 index d779c23a64..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToDocumentSet.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPContentTypeToDocumentSet.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPContentTypeToDocumentSet ---- - -# Add-PnPContentTypeToDocumentSet - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPContentTypeToDocumentSet.md to change this file. - -Adds a content type to a document set - -## SYNTAX - -```powershell -Add-PnPContentTypeToDocumentSet -ContentType -DocumentSet - [-Connection ] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-PnPContentTypeToDocumentSet -ContentType "Test CT" -DocumentSet "Test Document Set" -``` - -This will add the content type called 'Test CT' to the document set called ''Test Document Set' - -### EXAMPLE 2 -```powershell -$docset = Get-PnPDocumentSetTemplate -Identity "Test Document Set" -$ct = Get-PnPContentType -Identity "Test CT" -Add-PnPContentTypeToDocumentSet -ContentType $ct -DocumentSet $docset -``` - -This will add the content type called 'Test CT' to the document set called ''Test Document Set' - -### EXAMPLE 3 -```powershell -Add-PnPContentTypeToDocumentSet -ContentType 0x0101001F1CEFF1D4126E4CAD10F00B6137E969 -DocumentSet 0x0120D520005DB65D094035A241BAC9AF083F825F3B -``` - -This will add the content type called 'Test CT' to the document set called ''Test Document Set' - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: PnPConnection -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentType -The content type object, name or id to add. Either specify name, an id, or a content type object. - -```yaml -Type: ContentTypePipeBind[] -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DocumentSet -The document set object or id to add the content type to. Either specify a name, a document set template object, an id, or a content type object - -```yaml -Type: DocumentSetPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - - -## RELATED LINKS - -[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md deleted file mode 100644 index 6b02067bb9..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPContentTypeToList.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPContentTypeToList.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPContentTypeToList ---- - -# Add-PnPContentTypeToList - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPContentTypeToList.md to change this file. - -Adds a new content type to a list - -## SYNTAX - -```powershell -Add-PnPContentTypeToList -List -ContentType [-DefaultContentType] - [-Connection ] [] -``` - -## DESCRIPTION - -## EXAMPLES - -### EXAMPLE 1 -```powershell -Add-PnPContentTypeToList -List "Documents" -ContentType "Project Document" -DefaultContentType -``` - -This will add an existing content type to a list and sets it as the default content type - -## PARAMETERS - -### -Connection -Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection. - -```yaml -Type: PnPConnection -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentType -Specifies the content type that needs to be added to the list - -```yaml -Type: ContentTypePipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultContentType -Specify if the content type needs to be the default content type or not - -```yaml -Type: SwitchParameter -Parameter Sets: (All) - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -List -Specifies the list to which the content type needs to be added - -```yaml -Type: ListPipeBind -Parameter Sets: (All) - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - - - -## RELATED LINKS - -[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - - diff --git a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md b/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md deleted file mode 100644 index 0939d590ed..0000000000 --- a/sharepoint/sharepoint-ps/sharepoint-pnp/Add-PnPCustomAction.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -Module Name: PnP.PowerShell -schema: 2.0.0 -applicable: SharePoint Online -online version: https://pnp.github.io/powershell/cmdlets/Add-PnPCustomAction.html -external help file: PnP.PowerShell.dll-Help.xml -title: Add-PnPCustomAction ---- - -# Add-PnPCustomAction - -## SYNOPSIS - -> [!TIP] -> We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPCustomAction.md to change this file. - -Adds a custom action - -## SYNTAX - -### Default -```powershell -Add-PnPCustomAction -Name -Title -Description -Group -Location - [-Sequence ] [-Url ] [-ImageUrl ] [-CommandUIExtension ] - [-RegistrationId ] [-Rights ] [-RegistrationType ] - [-Scope ] [-Connection ] [] -``` - -### Client Side Component Id -```powershell -Add-PnPCustomAction -Name -Title -Location [-Sequence ] - [-RegistrationId ] [-RegistrationType ] [-Scope ] - -ClientSideComponentId [-ClientSideComponentProperties ] - [-ClientSideHostProperties ] [-Connection ] [] -``` - -## DESCRIPTION -Adds a user custom action to a web or sitecollection. - -## EXAMPLES - -### EXAMPLE 1 -```powershell -$cUIExtn = "